public final class MoveResourcesDescriptor extends RefactoringDescriptor
An instance of this refactoring descriptor may be obtained by calling
RefactoringContribution.createDescriptor()
on a refactoring
contribution requested by invoking
RefactoringCore.getRefactoringContribution(String)
with the
refactoring id (ID
).
Note: this class is not intended to be subclassed or instantiated by clients.
Modifier and Type | Field and Description |
---|---|
static String |
ID
Refactoring id of the 'Move Resources Resource' refactoring (value:
org.eclipse.ltk.core.refactoring.move.resources ). |
BREAKING_CHANGE, ID_UNKNOWN, MULTI_CHANGE, NONE, STRUCTURAL_CHANGE, USER_CHANGE
Constructor and Description |
---|
MoveResourcesDescriptor()
Creates a new refactoring descriptor.
|
Modifier and Type | Method and Description |
---|---|
Refactoring |
createRefactoring(RefactoringStatus status)
Creates the a new refactoring instance for this refactoring descriptor.
|
IPath |
getDestinationPath()
Returns the destination container to move the resources in.
|
IPath[] |
getResourcePathsToMove()
Returns the resource to move.
|
boolean |
isUpdateReferences()
Returns if move will also update references
|
void |
setDestination(IContainer container)
Sets the destination container to move the resources in.
|
void |
setDestinationPath(IPath path)
Sets the path of the destination container to move the resources in.
|
void |
setResourcePathsToMove(IPath[] resourcePaths)
Sets the paths of the resources to move.
|
void |
setResourcesToMove(IResource[] resources)
Sets the resources to move.
|
void |
setUpdateReferences(boolean updateReferences)
If set to
true , move will also update references. |
compareTo, createRefactoringContext, equals, getComment, getDescription, getFlags, getID, getProject, getTimeStamp, hashCode, setComment, setDescription, setFlags, setProject, setTimeStamp, toString
public static final String ID
org.eclipse.ltk.core.refactoring.move.resources
).
Clients may safely cast the obtained refactoring descriptor to
MoveResourcesDescriptor
.
public MoveResourcesDescriptor()
Clients should not instantiated this class but use RefactoringCore.getRefactoringContribution(String)
with ID
to get the contribution that can create the descriptor.
public void setDestination(IContainer container)
container
- the destinationpublic void setDestinationPath(IPath path)
path
- the destination pathpublic IPath getDestinationPath()
public void setResourcePathsToMove(IPath[] resourcePaths)
resourcePaths
- the paths of the resource to movepublic void setResourcesToMove(IResource[] resources)
resources
- the resource to movepublic IPath[] getResourcePathsToMove()
public void setUpdateReferences(boolean updateReferences)
true
, move will also update references. The default is to update references.updateReferences
- true
if this move will update referencespublic boolean isUpdateReferences()
true
if this move will update referencespublic Refactoring createRefactoring(RefactoringStatus status) throws CoreException
RefactoringDescriptor
The returned refactoring must be in an initialized state, i.e. ready to
be executed via PerformRefactoringOperation
.
This method is not intended to be called directly from code that does not belong to this
class and its subclasses. External code should call
RefactoringDescriptor.createRefactoringContext(RefactoringStatus)
and obtain the refactoring object from
the refactoring context.
createRefactoring
in class RefactoringDescriptor
status
- a refactoring status used to describe the outcome of the initializationnull
if this refactoring
descriptor represents the unknown refactoring, or if no
refactoring contribution is available for this refactoring
descriptor which is capable to create a refactoringCoreException
- if an error occurs while creating the refactoring instance
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.