|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A resource rule factory returns scheduling rules for API methods that modify the workspace. These rules can be used when creating jobs or other operations that perform a series of modifications on the workspace. This allows clients to implement two phase commit semantics, where all necessary rules are obtained prior to executing a long running operation.
Note that simple use of the workspace APIs does not require use of scheduling
rules. All workspace API methods that modify the workspace will automatically
obtain any scheduling rules needed to perform the modification. However, if you
are aggregating a set of changes to the workspace using WorkspaceJob
or IWorkspaceRunnable
you can use scheduling rules to lock a
portion of the workspace for the duration of the job or runnable. If you do so,
a runtime exception will occur if you try to modify a portion of the workspace
that is not covered by the rule for the runnable or job.
If more than one rule is needed, they can be aggregated using the
MultiRule.combine
method. Simplifying a group of rules does not change
the set of resources that are covered, but can improve job scheduling performance.
Note that null
is a valid scheduling rule (indicating that no
resources need to be locked), and thus all methods in this class may
return null
.
WorkspaceJob
,
IWorkspace.run(IWorkspaceRunnable, ISchedulingRule, int, org.eclipse.core.runtime.IProgressMonitor)
,
MultiRule.combine(ISchedulingRule, ISchedulingRule)
Method Summary | |
ISchedulingRule |
buildRule()
Returns the scheduling rule that is required for building a project or the entire workspace. |
ISchedulingRule |
copyRule(IResource source,
IResource destination)
Returns the scheduling rule that is required for copying a resource. |
ISchedulingRule |
createRule(IResource resource)
Returns the scheduling rule that is required for creating a project, folder, or file. |
ISchedulingRule |
deleteRule(IResource resource)
Returns the scheduling rule that is required for deleting a resource. |
ISchedulingRule |
markerRule(IResource resource)
Returns the scheduling rule that is required for creating, modifying, or deleting markers on a resource. |
ISchedulingRule |
modifyRule(IResource resource)
Returns the scheduling rule that is required for modifying a resource. |
ISchedulingRule |
moveRule(IResource source,
IResource destination)
Returns the scheduling rule that is required for moving a resource. |
ISchedulingRule |
refreshRule(IResource resource)
Returns the scheduling rule that is required for performing refreshLocal on a resource. |
ISchedulingRule |
validateEditRule(IResource[] resources)
Returns the scheduling rule that is required for a validateEdit |
Method Detail |
public ISchedulingRule createRule(IResource resource)
resource
- the resource being created
null
public ISchedulingRule buildRule()
null
public ISchedulingRule copyRule(IResource source, IResource destination)
source
- the source of the copydestination
- the destination of the copy
null
public ISchedulingRule deleteRule(IResource resource)
resource
- the resource to be deleted
null
public ISchedulingRule markerRule(IResource resource)
resource
- the resource owning the marker to be modified
null
public ISchedulingRule modifyRule(IResource resource)
touch
is considered to be a modification.
resource
- the resource being modified
null
public ISchedulingRule moveRule(IResource source, IResource destination)
source
- the source of the movedestination
- the destination of the move
null
public ISchedulingRule refreshRule(IResource resource)
refreshLocal
on a resource.
resource
- the resource to refresh
null
public ISchedulingRule validateEditRule(IResource[] resources)
validateEdit
resources
- the resources to be validated
null
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.