Package org.eclipse.core.runtime.jobs

Interface ISchedulableOperation

public interface ISchedulableOperation

An interface to mark an operation that needs an ISchedulingRule.

Since:

3.13

Method Summary

Modifier and Type	Method	Description
ISchedulingRule	getSchedulingRule()	Gives the caller a hint whether this operation will acquire a rule to proceed in the current thread.

Method Details

getSchedulingRule

ISchedulingRule getSchedulingRule()

Gives the caller a hint whether this operation will acquire a rule to proceed in the current thread. If a ISchedulingRule is returned the caller should call IJobManager.beginRule(ISchedulingRule, IProgressMonitor) before and IJobManager.endRule(ISchedulingRule) after the operation.

Returns:

an ISchedulingRule that the operation will acquire in the current thread - if any. Returns null if no rule needed - in that case the caller should not call beginRule or endRule. As this method returns only a hint the operation can not assume that the caller already acquired the rule. The operation still has to acquire it - which will lead to a nested rule.

Since:

3.13