|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.resources.team.ResourceRuleFactory
public class ResourceRuleFactory
Default implementation of IResourceRuleFactory. The teamHook extension may subclass to provide more specialized scheduling rules for workspace operations that they participate in.
IResourceRuleFactory| Constructor Summary | |
|---|---|
protected |
ResourceRuleFactory()
Creates a new default resource rule factory. |
| Method Summary | |
|---|---|
ISchedulingRule |
buildRule()
Default implementation of IResourceRuleFactory#buildRule. |
ISchedulingRule |
charsetRule(IResource resource)
Default implementation of IResourceRuleFactory#charsetRule. |
ISchedulingRule |
copyRule(IResource source,
IResource destination)
Default implementation of IResourceRuleFactory#copyRule. |
ISchedulingRule |
createRule(IResource resource)
Default implementation of IResourceRuleFactory#createRule. |
ISchedulingRule |
deleteRule(IResource resource)
Default implementation of IResourceRuleFactory#deleteRule. |
ISchedulingRule |
derivedRule(IResource resource)
Default implementation of IResourceRuleFactory#derivedRule. |
ISchedulingRule |
markerRule(IResource resource)
Default implementation of IResourceRuleFactory#markerRule. |
ISchedulingRule |
modifyRule(IResource resource)
Default implementation of IResourceRuleFactory#modifyRule. |
ISchedulingRule |
moveRule(IResource source,
IResource destination)
Default implementation of IResourceRuleFactory#moveRule. |
protected ISchedulingRule |
parent(IResource resource)
Convenience method to return the parent of the given resource, or the resource itself for projects and the workspace root. |
ISchedulingRule |
refreshRule(IResource resource)
Default implementation of IResourceRuleFactory#refreshRule. |
ISchedulingRule |
validateEditRule(IResource[] resources)
Default implementation of IResourceRuleFactory#validateEditRule. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected ResourceRuleFactory()
| Method Detail |
|---|
public final ISchedulingRule buildRule()
IResourceRuleFactory#buildRule.
This default implementation always returns the workspace root.
Subclasses may not currently override this method.
buildRule in interface IResourceRuleFactorynullIResourceRuleFactory.buildRule()public ISchedulingRule charsetRule(IResource resource)
IResourceRuleFactory#charsetRule.
This default implementation always returns the project of the resource
whose charset setting is being changed, or null if the
resource is the workspace root.
Subclasses may override this method. The rule provided by an overriding method must at least contain the rule from this default implementation.
charsetRule in interface IResourceRuleFactoryresource - the resource for which the charset will be changed
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.charsetRule(IResource)public final ISchedulingRule derivedRule(IResource resource)
IResourceRuleFactory#derivedRule.
This default implementation always returns null.
Subclasses may not currently override this method.
derivedRule in interface IResourceRuleFactoryresource - the resource for which the derived flag will be changed
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.derivedRule(IResource)
public ISchedulingRule copyRule(IResource source,
IResource destination)
IResourceRuleFactory#copyRule.
This default implementation always returns the parent of the destination
resource.
Subclasses may override this method. The rule provided by an overriding method must at least contain the rule from this default implementation.
copyRule in interface IResourceRuleFactorysource - the source of the copydestination - the destination of the copy
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.copyRule(IResource, IResource)public ISchedulingRule createRule(IResource resource)
IResourceRuleFactory#createRule.
This default implementation always returns the parent of the resource
being created.
Subclasses may override this method. The rule provided by an overriding method must at least contain the rule from this default implementation.
createRule in interface IResourceRuleFactoryresource - the resource being created
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.createRule(IResource)public ISchedulingRule deleteRule(IResource resource)
IResourceRuleFactory#deleteRule.
This default implementation always returns the parent of the resource
being deleted.
Subclasses may override this method. The rule provided by an overriding method must at least contain the rule from this default implementation.
deleteRule in interface IResourceRuleFactoryresource - the resource to be deleted
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.deleteRule(IResource)public final ISchedulingRule markerRule(IResource resource)
IResourceRuleFactory#markerRule.
This default implementation always returns null.
Subclasses may not currently override this method.
markerRule in interface IResourceRuleFactoryresource - the resource owning the marker to be modified
nullIResourceRuleFactory.markerRule(IResource)public ISchedulingRule modifyRule(IResource resource)
IResourceRuleFactory#modifyRule.
This default implementation returns the resource being modified, or the
parent resource if modifying a project description file.
Note that this must encompass any rule required by the validateSave hook.
Subclasses may override this method. The rule provided by an overriding method must at least contain the rule from this default implementation.
modifyRule in interface IResourceRuleFactoryresource - the resource being modified
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.modifyRule(IResource),
FileModificationValidator.validateSave(IFile),
IProjectDescription.DESCRIPTION_FILE_NAME
public ISchedulingRule moveRule(IResource source,
IResource destination)
IResourceRuleFactory#moveRule.
This default implementation returns a rule that combines the parent
of the source resource and the parent of the destination resource.
Subclasses may override this method. The rule provided by an overriding method must at least contain the rule from this default implementation.
moveRule in interface IResourceRuleFactorysource - the source of the movedestination - the destination of the move
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.moveRule(IResource, IResource)protected final ISchedulingRule parent(IResource resource)
resource - the resource to compute the parent of
public ISchedulingRule refreshRule(IResource resource)
IResourceRuleFactory#refreshRule.
This default implementation always returns the parent of the resource
being refreshed.
Subclasses may override this method. The rule provided by an overriding method must at least contain the rule from this default implementation.
refreshRule in interface IResourceRuleFactoryresource - the resource to refresh
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.refreshRule(IResource)public ISchedulingRule validateEditRule(IResource[] resources)
IResourceRuleFactory#validateEditRule.
This default implementation returns a rule that combines the parents of
all read-only resources, or null if there are no read-only
resources.
Subclasses may override this method. The rule provided by an overriding method must at least contain the rule from this default implementation.
validateEditRule in interface IResourceRuleFactoryresources - the resources to be validated
nullISchedulingRule.contains(org.eclipse.core.runtime.jobs.ISchedulingRule),
IResourceRuleFactory.validateEditRule(IResource[])
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.