org.eclipse.team.core.mapping
Interface ISynchronizationScope

All Superinterfaces:

IResourceMappingScope

public interface ISynchronizationScope

extends IResourceMappingScope

Interface which defines the protocol for translating a set of ResourceMapping objects representing a view selection into the complete set of resources to be operated on.

This interface is not intended to be implemented by clients. Instead, clients should use a SynchronizationScopeManager to generate a resource mapping scope from a set of input resource mappings.

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, SynchronizationScopeManager

Method Summary

void	addScopeChangeListener(ISynchronizationScopeChangeListener listener) Add a scope change listener that will get invoked when a property of the receiver changes.
ISynchronizationScope	asInputScope() Return a scope that only contains the input mappings of this scope.
boolean	contains(IResource resource) Return whether the given resource is contained in this scope.
org.eclipse.core.resources.mapping.ResourceMapping[]	getInputMappings() Return the array of mappings that acted as the input to the scope builder that was used to build this scope.
org.eclipse.core.resources.mapping.ResourceMapping	getMapping(Object modelObject) Return the resource mapping in the scope associated with the given model object or null if there isn't one.
org.eclipse.core.resources.mapping.ResourceMapping[]	getMappings() Return an array of all of the mappings to be operated on.
org.eclipse.core.resources.mapping.ResourceMapping[]	getMappings(String modelProviderId) Return all the mappings to be operated on for the given model provider id.
org.eclipse.core.resources.mapping.ModelProvider[]	getModelProviders() Return all the model providers that have mappings in this scope.
IResource[]	getRoots() Return the resources that are the roots of this scope.
org.eclipse.core.resources.mapping.ResourceTraversal[]	getTraversals() Return an array of traversals that cover the resource mappings to be operated on as returned by the getMappings() method.
org.eclipse.core.resources.mapping.ResourceTraversal[]	getTraversals(org.eclipse.core.resources.mapping.ResourceMapping mapping) Return an array of traversals that cover the given resource mapping to be operated on.
boolean	hasAdditionalMappings() Return whether the scope has additional mappings added to the input mappings during the scope building process.
boolean	hasAdditonalResources() Return whether the scope has additional resources added due to additional resource mappings.
void	removeScopeChangeListener(ISynchronizationScopeChangeListener listener) Remove a scope change listener.

Method Detail

getInputMappings

public org.eclipse.core.resources.mapping.ResourceMapping[] getInputMappings()

Return the array of mappings that acted as the input to the scope builder that was used to build this scope. This set usually come from a view selection but could come from another source. In most cases, clients will want to call the getMappings() method instead of this one as it returns the complete set of mappings to be operated on.

Returns:

the set of mappings that acted as the input to the scope builder that was used to build this scope

asInputScope

public ISynchronizationScope asInputScope()

Return a scope that only contains the input mappings of this scope.

Returns:

a scope that only contains the input mappings of this scope

getMappings

public org.eclipse.core.resources.mapping.ResourceMapping[] getMappings()

Return an array of all of the mappings to be operated on. The returned mappings were included in the operation during the scope building process. The returned mappings may be the same as the input mappings but may also be a super set. Clients can call the hasAdditionalMappings() method to determine if the two sets are the same or not.

Returns:

an array of all of the mappings to be operated on.

getTraversals

public org.eclipse.core.resources.mapping.ResourceTraversal[] getTraversals()

Return an array of traversals that cover the resource mappings to be operated on as returned by the getMappings() method. The traversals were calculated during the scope building process and cached with the scope.

Returns:

the complete set of mappings to be operated on

getRoots

public IResource[] getRoots()

Return the resources that are the roots of this scope. The roots are determined by collecting the roots of the traversals that define this scope.

Specified by:

getRoots in interface IResourceMappingScope

Returns:

the resources that are the roots of this scope

contains

public boolean contains(IResource resource)

Return whether the given resource is contained in this scope. A resource is contained by the scope if it is contained in at least one of the traversals that define this scope.

Specified by:

contains in interface IResourceMappingScope

Parameters:

resource - the resource to be tested

Returns:

whether the given resource is contained in this scope

addScopeChangeListener

public void addScopeChangeListener(ISynchronizationScopeChangeListener listener)

Add a scope change listener that will get invoked when a property of the receiver changes. Adding a listener that is already added has no effect.

Parameters:

listener - the listener to be added

removeScopeChangeListener

public void removeScopeChangeListener(ISynchronizationScopeChangeListener listener)

Remove a scope change listener. Removing an unregistered listener has no effect.

Parameters:

listener - the listener to be removed

getTraversals

public org.eclipse.core.resources.mapping.ResourceTraversal[] getTraversals(org.eclipse.core.resources.mapping.ResourceMapping mapping)

Return an array of traversals that cover the given resource mapping to be operated on. The traversals were calculated during the scope building process and cached with the scope.

Parameters:

mapping - a resource mapping being operated on

Returns:

the traversals that cover the given resource mapping (or null if the mapping is not contained in the input)

hasAdditionalMappings

public boolean hasAdditionalMappings()

Return whether the scope has additional mappings added to the input mappings during the scope building process.

Returns:

whether the input has additional mappings added to the seed mappings

hasAdditonalResources

public boolean hasAdditonalResources()

Return whether the scope has additional resources added due to additional resource mappings.

Returns:

whether the input has additional resources added due to additional resource mappings

getModelProviders

public org.eclipse.core.resources.mapping.ModelProvider[] getModelProviders()

Return all the model providers that have mappings in this scope.

Returns:

all the model providers that have mappings in this scope

getMappings

public org.eclipse.core.resources.mapping.ResourceMapping[] getMappings(String modelProviderId)

Return all the mappings to be operated on for the given model provider id.

Parameters:

modelProviderId - the id of the model provider

Returns:

all the mappings for the given model provider id

getMapping

public org.eclipse.core.resources.mapping.ResourceMapping getMapping(Object modelObject)

Return the resource mapping in the scope associated with the given model object or null if there isn't one. This method has no knowledge of hierarchical models so it only matches directly against the mappings that are contained in the scope.

Parameters:

modelObject - the model object

Returns:

the mapping for the model object that is contained in this scope