|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.jobs.MultiRule
A MultiRule is a compound scheduling rule that represents a fixed group of child
scheduling rules. A MultiRule conflicts with another rule if any of its children conflict
with that rule. More formally, a compound rule represents a logical intersection
of its child rules with respect to the isConflicting
equivalence
relation.
A MultiRule will never contain other MultiRules as children. If a MultiRule is provided as a child, its children will be added instead.
This class is not intended to be subclassed by clients.
Constructor Summary | |
---|---|
MultiRule(ISchedulingRule[] nestedRules)
Creates a new scheduling rule that composes a set of nested rules. |
Method Summary | |
---|---|
static ISchedulingRule |
combine(ISchedulingRule[] ruleArray)
Returns a scheduling rule that encompasses all provided rules. |
static ISchedulingRule |
combine(ISchedulingRule rule1,
ISchedulingRule rule2)
Returns a scheduling rule that encompasses both provided rules. |
boolean |
contains(ISchedulingRule rule)
Returns whether this scheduling rule completely contains another scheduling rule. |
ISchedulingRule[] |
getChildren()
Returns the child rules within this rule. |
boolean |
isConflicting(ISchedulingRule rule)
Returns whether this scheduling rule is compatible with another scheduling rule. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public MultiRule(ISchedulingRule[] nestedRules)
nestedRules
- the nested rules for this compound rule.Method Detail |
public static ISchedulingRule combine(ISchedulingRule[] ruleArray)
MultiRule
. If all
provided rules are null
then the result will be
null
.
ruleArray
- An array of scheduling rules, some of which may be null
null
public static ISchedulingRule combine(ISchedulingRule rule1, ISchedulingRule rule2)
MultiRule
. If both
provided rules are null
then the result will be
null
.
rule1
- a scheduling rule, or null
rule2
- another scheduling rule, or null
null
public ISchedulingRule[] getChildren()
public boolean contains(ISchedulingRule rule)
ISchedulingRule
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 false
when compared to a rule they
know nothing about.
contains
in interface ISchedulingRule
rule
- the rule to check for containment
true
if this rule contains the given rule, and
false
otherwise.public boolean isConflicting(ISchedulingRule rule)
ISchedulingRule
true
is returned, then no job with this rule will be run at the
same time as a job with the conflicting rule. If false
is 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 false
when compared to a rule they know
nothing about.
isConflicting
in interface ISchedulingRule
rule
- the rule to check for conflicts
true
if the rule is conflicting, and false
otherwise.public String toString()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.