org.eclipse.core.resources.team
Class TeamHook

java.lang.Object
  org.eclipse.core.internal.resources.InternalTeamHook
      org.eclipse.core.resources.team.TeamHook

public abstract class TeamHook
extends InternalTeamHook

A general hook class for operations that team providers may be interested in participating in. Implementors of the hook should provide a concrete subclass, and override any methods they are interested in.

This class is intended to be subclassed by the team component in conjunction with the org.eclipse.core.resources.teamHook standard extension point. Individual team providers may also subclass this class. It is not intended to be subclassed by other clients. The methods defined on this class are called from within the implementations of workspace API methods and must not be invoked directly by clients.

Since:

2.1

Method Summary

IResourceRuleFactory	getRuleFactory(IProject project) Returns the resource scheduling rule factory that should be used when workspace operations are invoked on resources in that project.
org.eclipse.core.runtime.IStatus	validateCreateLink(IFile file, int updateFlags, org.eclipse.core.runtime.IPath location) Validates whether a particular attempt at link creation is allowed.
org.eclipse.core.runtime.IStatus	validateCreateLink(IFile file, int updateFlags, java.net.URI location) Validates whether a particular attempt at link creation is allowed.
org.eclipse.core.runtime.IStatus	validateCreateLink(IFolder folder, int updateFlags, org.eclipse.core.runtime.IPath location) Validates whether a particular attempt at link creation is allowed.
org.eclipse.core.runtime.IStatus	validateCreateLink(IFolder folder, int updateFlags, java.net.URI location) Validates whether a particular attempt at link creation is allowed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRuleFactory

public IResourceRuleFactory getRuleFactory(IProject project)

Returns the resource scheduling rule factory that should be used when workspace operations are invoked on resources in that project. The workspace will ask the team hook this question only once per project, per session. The workspace will assume the returned result is valid for the rest of that session, unless the rule is changed by calling setRuleFactory.

This method must not return null. If no special rules are required by the team hook for the given project, the value of the defaultFactory field should be returned.

This default implementation always returns the value of the defaultFactory field. Subclasses may override and provide a subclass of ResourceRuleFactory.

Parameters:

project - the project to return scheduling rules for

Returns:

the resource scheduling rules for a project

Since:

3.0

See Also:

setRuleFactory(IProject, IResourceRuleFactory), ResourceRuleFactory

validateCreateLink

public org.eclipse.core.runtime.IStatus validateCreateLink(IFile file,
                                                           int updateFlags,
                                                           org.eclipse.core.runtime.IPath location)

Validates whether a particular attempt at link creation is allowed. This gives team providers an opportunity to hook into the beginning of the implementation of IFile.createLink.

The implementation of this method runs "below" the resources API and is therefore very restricted in what resource API method it can call. The list of useable methods includes most resource operations that read but do not update the resource tree; resource operations that modify resources and trigger deltas must not be called from within the dynamic scope of the invocation of this method.

This method should be overridden by subclasses that want to control what links are created. The default implementation of this method allows all links to be created.

Parameters:

file - the file to be linked

updateFlags - bit-wise or of update flag constants (only ALLOW_MISSING_LOCAL is relevant here)

location - a file system path where the file should be linked

Returns:

a status object with code IStatus.OK if linking is allowed, otherwise a status object with severity IStatus.ERROR indicating why the creation is not allowed.

See Also:

IResource.ALLOW_MISSING_LOCAL

validateCreateLink

public org.eclipse.core.runtime.IStatus validateCreateLink(IFile file,
                                                           int updateFlags,
                                                           java.net.URI location)

Validates whether a particular attempt at link creation is allowed. This gives team providers an opportunity to hook into the beginning of the implementation of IFile.createLink(URI, int, IProgressMonitor)

The implementation of this method runs "below" the resources API and is therefore very restricted in what resource API method it can call. The list of useable methods includes most resource operations that read but do not update the resource tree; resource operations that modify resources and trigger deltas must not be called from within the dynamic scope of the invocation of this method.

This method should be overridden by subclasses that want to control what links are created. The default implementation of this method allows all links to be created.

Parameters:

file - the file to be linked

updateFlags - bit-wise or of update flag constants (only ALLOW_MISSING_LOCAL is relevant here)

location - a file system URI where the file should be linked

Returns:

a status object with code IStatus.OK if linking is allowed, otherwise a status object with severity IStatus.ERROR indicating why the creation is not allowed.

Since:

3.2

See Also:

IResource.ALLOW_MISSING_LOCAL

validateCreateLink

public org.eclipse.core.runtime.IStatus validateCreateLink(IFolder folder,
                                                           int updateFlags,
                                                           org.eclipse.core.runtime.IPath location)

Validates whether a particular attempt at link creation is allowed. This gives team providers an opportunity to hook into the beginning of the implementation of IFolder.createLink.

The implementation of this method runs "below" the resources API and is therefore very restricted in what resource API method it can call. The list of useable methods includes most resource operations that read but do not update the resource tree; resource operations that modify resources and trigger deltas must not be called from within the dynamic scope of the invocation of this method.

This method should be overridden by subclasses that want to control what links are created. The default implementation of this method allows all links to be created.

Parameters:

folder - the file to be linked

updateFlags - bit-wise or of update flag constants (only ALLOW_MISSING_LOCAL is relevant here)

location - a file system path where the folder should be linked

Returns:

a status object with code IStatus.OK if linking is allowed, otherwise a status object with severity IStatus.ERROR indicating why the creation is not allowed.

See Also:

IResource.ALLOW_MISSING_LOCAL

validateCreateLink

public org.eclipse.core.runtime.IStatus validateCreateLink(IFolder folder,
                                                           int updateFlags,
                                                           java.net.URI location)

Validates whether a particular attempt at link creation is allowed. This gives team providers an opportunity to hook into the beginning of the implementation of IFolder.createLink(URI, int, IProgressMonitor)

The implementation of this method runs "below" the resources API and is therefore very restricted in what resource API method it can call. The list of useable methods includes most resource operations that read but do not update the resource tree; resource operations that modify resources and trigger deltas must not be called from within the dynamic scope of the invocation of this method.

This method should be overridden by subclasses that want to control what links are created. The default implementation of this method allows all links to be created.

Parameters:

folder - the file to be linked

updateFlags - bit-wise or of update flag constants (only ALLOW_MISSING_LOCAL is relevant here)

location - a file system path where the folder should be linked

Returns:

a status object with code IStatus.OK if linking is allowed, otherwise a status object with severity IStatus.ERROR indicating why the creation is not allowed.

Since:

3.2

See Also:

IResource.ALLOW_MISSING_LOCAL