org.eclipse.team.core.mapping
Interface ISynchronizationScopeParticipant

public interface ISynchronizationScopeParticipant

A scope participant is responsible for ensuring that the resources contained within an ISynchronizationScope that overlap with the participant's model provider stay up-to-date with the model elements (represented as ResourceMapping instances) contained in the scope.

Clients may implement this interface

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is a guarantee neither that this API will work nor that it will remain the same. Please do not use this API without consulting with the Platform/Team team.

Since:

3.2

See Also:

ResourceMapping, ISynchronizationScopeManager

Method Summary

void	dispose() Callback from the scope manager when the scope is no longer needed.
org.eclipse.core.resources.mapping.ResourceMapping[]	handleContextChange(ISynchronizationScopeManager manager, IResource[] resources, IProject[] projects) Callback that the manager makes to participants when the state of resources that are contained in the resource mapping context of the manager change.

Method Detail

handleContextChange

public org.eclipse.core.resources.mapping.ResourceMapping[] handleContextChange(ISynchronizationScopeManager manager,
                                                                                IResource[] resources,
                                                                                IProject[] projects)

Callback that the manager makes to participants when the state of resources that are contained in the resource mapping context of the manager change. This method will only be invoked when the context of the manager is a RemoteResourceMappingContext and the state of one or more resources changes w.r.t. the context. It is the responsibility of the participant to react to local changes that affect the resources in the scope by calling ISynchronizationScopeManager.refresh(ResourceMapping[]).

Parameters:

manager - the scope manager

resources - the changed resources

projects - projects that were either added or removed

Returns:

the resource mappings that need to be refreshed.

dispose

public void dispose()

Callback from the scope manager when the scope is no longer needed. This si done to give participants a chance to remove a registered IResourceChangeListener or any other listeners.