Class MoveResourcesDescriptor
- All Implemented Interfaces:
Comparable<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.
- Since:
- 3.4
- Restriction:
- This class is not intended to be instantiated by clients.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringRefactoring id of the 'Move Resources Resource' refactoring (value:org.eclipse.ltk.core.refactoring.move.resources).Fields inherited from class org.eclipse.ltk.core.refactoring.RefactoringDescriptor
BREAKING_CHANGE, ID_UNKNOWN, MULTI_CHANGE, NONE, STRUCTURAL_CHANGE, USER_CHANGE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateRefactoring(RefactoringStatus status) Creates the a new refactoring instance for this refactoring descriptor.Returns the destination container to move the resources in.IPath[]Returns the resource to move.booleanReturns if move will also update referencesvoidsetDestination(IContainer container) Sets the destination container to move the resources in.voidsetDestinationPath(IPath path) Sets the path of the destination container to move the resources in.voidsetResourcePathsToMove(IPath[] resourcePaths) Sets the paths of the resources to move.voidsetResourcesToMove(IResource[] resources) Sets the resources to move.voidsetUpdateReferences(boolean updateReferences) If set totrue, move will also update references.Methods inherited from class org.eclipse.ltk.core.refactoring.RefactoringDescriptor
compareTo, createRefactoringContext, equals, getComment, getDescription, getFlags, getID, getProject, getTimeStamp, hashCode, setComment, setDescription, setFlags, setProject, setTimeStamp, toString
-
Field Details
-
ID
Refactoring id of the 'Move Resources Resource' refactoring (value:org.eclipse.ltk.core.refactoring.move.resources).Clients may safely cast the obtained refactoring descriptor to
MoveResourcesDescriptor.- See Also:
-
-
Constructor Details
-
MoveResourcesDescriptor
public MoveResourcesDescriptor()Creates a new refactoring descriptor.Clients should not instantiated this class but use
RefactoringCore.getRefactoringContribution(String)withIDto get the contribution that can create the descriptor.
-
-
Method Details
-
setDestination
Sets the destination container to move the resources in.- Parameters:
container- the destination
-
setDestinationPath
Sets the path of the destination container to move the resources in.- Parameters:
path- the destination path
-
getDestinationPath
Returns the destination container to move the resources in.- Returns:
- the destination container to move the resource in
-
setResourcePathsToMove
- Parameters:
resourcePaths- the paths of the resource to move
-
setResourcesToMove
- Parameters:
resources- the resource to move
-
getResourcePathsToMove
Returns the resource to move.- Returns:
- the resource to move
-
setUpdateReferences
public void setUpdateReferences(boolean updateReferences) If set totrue, move will also update references. The default is to update references.- Parameters:
updateReferences-trueif this move will update references
-
isUpdateReferences
public boolean isUpdateReferences()Returns if move will also update references- Returns:
- returns
trueif this move will update references
-
createRefactoring
Description copied from class:RefactoringDescriptorCreates the a new refactoring instance for this refactoring descriptor.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.- Specified by:
createRefactoringin classRefactoringDescriptor- Parameters:
status- a refactoring status used to describe the outcome of the initialization- Returns:
- the refactoring, or
nullif this refactoring descriptor represents the unknown refactoring, or if no refactoring contribution is available for this refactoring descriptor which is capable to create a refactoring - Throws:
CoreException- if an error occurs while creating the refactoring instance
-