Interface ISystemIdleService


  • public interface ISystemIdleService
    System idle service allows clients to manage system idle status. System idle status can help some DT IDE core services to manage their work, based on the current idle status (if needed).
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean isSyncActive()
      Checks if there are any model sync activities are being performed at the moment for any available BM.
      boolean isSystemIdle()
      Checks if the user and/or system is idle at the moment.
      void removeProject​(org.eclipse.core.resources.IProject project)
      Remove a project from activity tracker.
      void reportUserActivity​(long activityTime)
      Reports that user activity has taken place in the given time.
      void setForceSystemBusy​(boolean systemBusy)
      Sets the indicator that the system is busy at the moment, and it shouldn't start secondary async calculations.
      void setForceUserIdle​(boolean forceUserIdle)
      Sets user idle indicator to be forced at value.
      void setSyncActivitity​(org.eclipse.core.resources.IProject project, Boolean activity)
      Sets sync activity for the given project.
    • Method Detail

      • isSyncActive

        boolean isSyncActive()
        Checks if there are any model sync activities are being performed at the moment for any available BM.
        Returns:
        True if sync activities are performed; false otherwise.
      • isSystemIdle

        boolean isSystemIdle()
        Checks if the user and/or system is idle at the moment.
        Returns:
        True if the user and/or system is idle at the moment.
      • setSyncActivitity

        void setSyncActivitity​(org.eclipse.core.resources.IProject project,
                               Boolean activity)
        Sets sync activity for the given project.
        Parameters:
        project - The project to set activity for.
        activity - True if sync is being performed at the moment; false in case if sync is finished.
      • removeProject

        void removeProject​(org.eclipse.core.resources.IProject project)
        Remove a project from activity tracker.
        Parameters:
        project - the project to remove, cannot be null
      • setForceUserIdle

        void setForceUserIdle​(boolean forceUserIdle)
        Sets user idle indicator to be forced at value. Useful for testing.
        Parameters:
        forceUserIdle -
      • setForceSystemBusy

        void setForceSystemBusy​(boolean systemBusy)
        Sets the indicator that the system is busy at the moment, and it shouldn't start secondary async calculations.
        Parameters:
        systemBusy - True means that the system is busy at the moment; false otherwise.
      • reportUserActivity

        void reportUserActivity​(long activityTime)
        Reports that user activity has taken place in the given time.
        Parameters:
        activityTime - The moment of time the activity has been performed.