Interface ISchedulingRule
- All Known Subinterfaces:
IContainer,IFile,IFolder,IProject,IResource,IWorkspaceRoot
- All Known Implementing Classes:
MultiRule
IJobManager.beginRule(ISchedulingRule) and
IJobManager.endRule(ISchedulingRule). The job manager guarantees that
no two jobs with conflicting scheduling rules will run concurrently.
Multiple rules can be applied to a given thread only if the outer rule explicitly
allows the nesting as specified by the contains method.
Clients may implement this interface.
- Since:
- 3.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontains(ISchedulingRule rule) Returns whether this scheduling rule completely contains another scheduling rule.booleanisConflicting(ISchedulingRule rule) Returns whether this scheduling rule is compatible with another scheduling rule.
-
Method Details
-
contains
Returns whether this scheduling rule completely contains another scheduling rule. Rules can only be nested within a thread if the inner rule is completely contained within the outer rule.Implementations of this method must obey the rules of a partial order relation on the set of all scheduling rules. In particular, implementations must be reflexive (a.contains(a) is always true), antisymmetric (a.contains(b) and b.contains(a) iff a.equals(b), and transitive (if a.contains(b) and b.contains(c), then a.contains(c)). Implementations of this method must return
falsewhen compared to a rule they know nothing about.- Parameters:
rule- the rule to check for containment- Returns:
trueif this rule contains the given rule, andfalseotherwise.
-
isConflicting
Returns whether this scheduling rule is compatible with another scheduling rule. Iftrueis returned, then no job with this rule will be run at the same time as a job with the conflicting rule. Iffalseis returned, then the job manager is free to run jobs with these rules at the same time.Implementations of this method must be reflexive, symmetric, and consistent, and must return
falsewhen compared to a rule they know nothing about.This method must return true if calling
contains(ISchedulingRule)on the same rule also returns true. This is required because it would otherwise allow two threads to be running concurrently with the same rule.- Parameters:
rule- the rule to check for conflicts- Returns:
trueif the rule is conflicting, andfalseotherwise.
-