public abstract class AbstractRefactoringDescriptorResourceMapping extends ResourceMapping
Note: this class is intended to be implemented by clients which need to enhance a model provider with a refactoring model.
ResourceMapping
,
ModelProvider
Modifier | Constructor and Description |
---|---|
protected |
AbstractRefactoringDescriptorResourceMapping(RefactoringDescriptorProxy descriptor)
Creates a new abstract refactoring descriptor resource mapping.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object object)
Override equals to compare the model objects of the
mapping in order to determine equality.
|
Object |
getModelObject()
Returns the application model element associated with this
resource mapping.
|
IProject[] |
getProjects()
Returns the projects that contain the resources that constitute this
application model.
|
IResource |
getResource()
Returns the associated resource.
|
ResourceTraversal[] |
getTraversals(ResourceMappingContext context,
IProgressMonitor monitor)
Returns one or more traversals that can be used to access all the
physical resources that constitute the logical resource.
|
int |
hashCode()
Override hashCode to use the model object.
|
accept, contains, findMarkers, getModelProvider, getModelProviderId
getAdapter
protected AbstractRefactoringDescriptorResourceMapping(RefactoringDescriptorProxy descriptor)
descriptor
- the refactoring descriptorpublic boolean equals(Object object)
equals
in class ResourceMapping
object
- the object to comparetrue
if the receiver is equal to the
given object, and false
otherwise.public final Object getModelObject()
getModelObject
in class ResourceMapping
public final IProject[] getProjects()
getProjects
in class ResourceMapping
public final IResource getResource()
null
if the descriptor
contains no timestamp or project informationpublic final ResourceTraversal[] getTraversals(ResourceMappingContext context, IProgressMonitor monitor) throws CoreException
Subclasses should, when possible, include all resources that are or may be members of the model element. For instance, a model element should return the same list of resources regardless of the existence of the files on the file system. For example, if a logical resource called "form" maps to "/p1/form.xml" and "/p1/form.java" then whether form.xml or form.java existed, they should be returned by this method.
In some cases, it may not be possible for a model element to know all the resources that may constitute the element without accessing the state of the model element in another location (e.g. a repository). This method is provided with a context which, when provided, gives access to the members of corresponding remote containers and the contents of corresponding remote files. This gives the model element the opportunity to deduce what additional resources should be included in the traversal.
getTraversals
in class ResourceMapping
context
- gives access to the state of
remote resources that correspond to local resources for the
purpose of determining traversals that adequately cover the
model element resources given the state of the model element
in another location. This parameter may be null
, in
which case the implementor can assume that only the local
resources are of interest to the client.monitor
- a progress monitor, or null
if progress
reporting is not desiredCoreException
- if the traversals could not be obtained.public int hashCode()
hashCode
in class ResourceMapping
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.