public interface ISynchronizationScope
ResourceMapping
objects representing a view selection into the
complete set of resources to be operated on.ResourceMapping
,
ISynchronizationScopeManager
ISynchronizationScopeManager
to generate a resource
mapping scope from a set of input resource mappings.Modifier and Type | Method and Description |
---|---|
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.
|
ResourceMappingContext |
getContext()
Return the resource mapping context that the scope
uses to obtain traversals from resource mappings
in order to determine what resources are in the scope.
|
ResourceMapping[] |
getInputMappings()
Return the array of mappings that acted as the input to the scope builder
that was used to build this scope.
|
ResourceMapping |
getMapping(Object modelObject)
Return the resource mapping in the scope associated with the given model
object or
null if there isn't one. |
ResourceMapping[] |
getMappings()
Return an array of all of the mappings to be operated on.
|
ResourceMapping[] |
getMappings(String modelProviderId)
Return all the mappings to be operated on for the given model provider
id.
|
ModelProvider[] |
getModelProviders()
Return all the model providers that have mappings in this scope.
|
IProject[] |
getProjects()
Return the projects that bound this scope.
|
IResource[] |
getRoots()
Return the resources that are the roots of this scope.
|
ResourceTraversal[] |
getTraversals()
Return an array of traversals that cover the resource mappings to be
operated on as returned by the
getMappings() method. |
ResourceTraversal[] |
getTraversals(ResourceMapping mapping)
Return an array of traversals that cover the given resource mapping to be
operated on.
|
ResourceTraversal[] |
getTraversals(String modelProviderId)
Return the set of traversals that cover the mappings for
the given model provider.
|
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 |
refresh(ResourceMapping[] mappings)
Refresh the given mapping asynchronously.
|
void |
removeScopeChangeListener(ISynchronizationScopeChangeListener listener)
Remove a scope change listener.
|
IProject[] getProjects()
RemoteResourceMappingContext.getProjects()
ResourceMappingContext getContext()
ResourceMapping.getTraversals(ResourceMappingContext, org.eclipse.core.runtime.IProgressMonitor)
ResourceMapping[] getInputMappings()
getMappings()
method instead of this one as it
returns the complete set of mappings to be operated on.ISynchronizationScope asInputScope()
ResourceMapping[] getMappings()
hasAdditionalMappings()
method to determine if the two sets are
the same or not.ResourceTraversal[] getTraversals()
getMappings()
method. The
traversals were calculated during the scope building process and cached
with the scope.IResource[] getRoots()
boolean contains(IResource resource)
resource
- the resource to be testedvoid addScopeChangeListener(ISynchronizationScopeChangeListener listener)
listener
- the listener to be addedvoid removeScopeChangeListener(ISynchronizationScopeChangeListener listener)
listener
- the listener to be removedResourceTraversal[] getTraversals(ResourceMapping mapping)
mapping
- a resource mapping being operated onnull
if the mapping is not contained in the input)boolean hasAdditionalMappings()
boolean hasAdditonalResources()
ModelProvider[] getModelProviders()
ResourceMapping[] getMappings(String modelProviderId)
modelProviderId
- the id of the model providerResourceTraversal[] getTraversals(String modelProviderId)
modelProviderId
- the model provider idResourceMapping getMapping(Object modelObject)
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.modelObject
- the model objectvoid refresh(ResourceMapping[] mappings)
ISynchronizationScopeParticipant
instances when they detect changes that require the scope
to be adjusted.mappings
- the mappings to be refreshed.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.