|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ltk.core.refactoring.RefactoringDescriptor
org.eclipse.ltk.core.refactoring.resource.MoveResourcesDescriptor
Refactoring descriptor for the move resource refactoring.
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.
Field Summary | |
static String |
ID
Refactoring id of the 'Move Resources Resource' refactoring (value: org.eclipse.ltk.core.refactoring.rename.resources ).
|
Fields inherited from class org.eclipse.ltk.core.refactoring.RefactoringDescriptor |
BREAKING_CHANGE, ID_UNKNOWN, MULTI_CHANGE, NONE, STRUCTURAL_CHANGE, USER_CHANGE |
Constructor Summary | |
MoveResourcesDescriptor()
Creates a new refactoring descriptor. |
Method Summary | |
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. |
Methods inherited from class org.eclipse.ltk.core.refactoring.RefactoringDescriptor |
compareTo, equals, getComment, getDescription, getFlags, getID, getProject, getTimeStamp, hashCode, setComment, setDescription, setFlags, setProject, setTimeStamp, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String ID
org.eclipse.ltk.core.refactoring.rename.resources
).
Clients may safely cast the obtained refactoring descriptor to
MoveResourcesDescriptor
.
Constructor Detail |
public MoveResourcesDescriptor()
Clients should not instantiated this class but use RefactoringCore.getRefactoringContribution(String)
with ID
to get the contribution that can create the descriptor.
Method Detail |
public void setDestination(IContainer container)
container
- the destinationpublic void setDestinationPath(IPath path)
path
- the destination pathpublic IPath getDestinationPath()
public void setResourcePathsToMove(IPath[] resourcePaths)
IFile
or IFolder
.
resourcePaths
- the paths of the resource to movepublic void setResourcesToMove(IResource[] resources)
IFile
or IFolder
.
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
This method is used by the refactoring framework to instantiate a refactoring from a refactoring descriptor, in order to apply it later on a local or remote workspace.
The returned refactoring must be in an initialized state, i.e. ready to
be executed via PerformRefactoringOperation
.
createRefactoring
in class RefactoringDescriptor
status
- a refactoring status used to describe the outcome of the
initialization
null
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 refactoring
CoreException
- if an error occurs while creating the refactoring instance
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.