|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 ISynchronizationScopeManager
to generate a resource mapping scope from
a set of input resource mappings.
ResourceMapping
,
ISynchronizationScopeManager
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. |
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. |
Method Detail |
public IProject[] getProjects()
RemoteResourceMappingContext.getProjects()
public ResourceMappingContext getContext()
ResourceMapping.getTraversals(ResourceMappingContext, org.eclipse.core.runtime.IProgressMonitor)
public ResourceMapping[] getInputMappings()
getMappings()
method instead of this one as it
returns the complete set of mappings to be operated on.
public ISynchronizationScope asInputScope()
public ResourceMapping[] getMappings()
hasAdditionalMappings()
method to determine if the two sets are
the same or not.
public ResourceTraversal[] getTraversals()
getMappings()
method. The
traversals were calculated during the scope building process and cached
with the scope.
public IResource[] getRoots()
public boolean contains(IResource resource)
resource
- the resource to be tested
public void addScopeChangeListener(ISynchronizationScopeChangeListener listener)
listener
- the listener to be addedpublic void removeScopeChangeListener(ISynchronizationScopeChangeListener listener)
listener
- the listener to be removedpublic ResourceTraversal[] getTraversals(ResourceMapping mapping)
mapping
- a resource mapping being operated on
null
if the mapping is not contained in the input)public boolean hasAdditionalMappings()
public boolean hasAdditonalResources()
public ModelProvider[] getModelProviders()
public ResourceMapping[] getMappings(String modelProviderId)
modelProviderId
- the id of the model provider
public ResourceTraversal[] getTraversals(String modelProviderId)
modelProviderId
- the model provider id
public ResourceMapping 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 object
public void refresh(ResourceMapping[] mappings)
ISynchronizationScopeParticipant
instances when they detect changes that require the scope
to be adjusted.
mappings
- the mappings to be refreshed.
|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.