RenameResourceDescriptor
from
org.eclipse.ltk.core.refactoring
instead.public final class RenameResourceDescriptor extends JavaRefactoringDescriptor
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
appropriate refactoring id.
Note: this class is not intended to be instantiated by clients.
ATTRIBUTE_ELEMENT, ATTRIBUTE_INPUT, ATTRIBUTE_NAME, ATTRIBUTE_REFERENCES, ATTRIBUTE_SELECTION, ATTRIBUTE_VERSION, fArguments, JAR_MIGRATION, JAR_REFACTORING, JAR_SOURCE_ATTACHMENT, VALUE_VERSION_1_0
BREAKING_CHANGE, ID_UNKNOWN, MULTI_CHANGE, NONE, STRUCTURAL_CHANGE, USER_CHANGE
Constructor and Description |
---|
RenameResourceDescriptor()
Deprecated.
Creates a new refactoring descriptor.
|
RenameResourceDescriptor(String project,
String description,
String comment,
Map arguments,
int flags)
Deprecated.
Creates a new refactoring descriptor.
|
Modifier and Type | Method and Description |
---|---|
String |
getNewName()
Deprecated.
Returns the new name to rename the resource to.
|
IPath |
getResourcePath()
Deprecated.
Returns the path of the resource to rename.
|
protected void |
populateArgumentMap()
Deprecated.
Populates the refactoring descriptor argument map based on the specified
arguments.
|
void |
setNewName(String name)
Deprecated.
Sets the new name to rename the resource to.
|
void |
setProject(String project)
Deprecated.
Sets the project name of this refactoring.
|
void |
setResource(IResource resource)
Deprecated.
Sets the resource to be renamed.
|
RefactoringStatus |
validateDescriptor()
Deprecated.
Validates the refactoring descriptor with respect to the constraints
imposed by the represented refactoring.
|
createRefactoring, elementToHandle, getArguments, handleToElement, handleToElement, handleToElement, handleToResource, resourceToHandle, setComment, setDescription, setFlags
compareTo, createRefactoringContext, equals, getComment, getDescription, getFlags, getID, getProject, getTimeStamp, hashCode, setTimeStamp, toString
public RenameResourceDescriptor()
public RenameResourceDescriptor(String project, String description, String comment, Map arguments, int flags)
project
- the non-empty name of the project associated with this
refactoring, or null
for a workspace
refactoringdescription
- a non-empty human-readable description of the particular
refactoring instancecomment
- the human-readable comment of the particular refactoring
instance, or null
for no commentarguments
- a map of arguments that will be persisted and describes
all settings for this refactoringflags
- the flags of the refactoring descriptorIllegalArgumentException
- if the argument map contains invalid keys/valuesprotected void populateArgumentMap()
JavaRefactoringDescriptor.fArguments
.populateArgumentMap
in class JavaRefactoringDescriptor
public void setNewName(String name)
name
- the non-empty new name to setpublic String getNewName()
public void setProject(String project)
Note: If the resource to be renamed is of type IResource.PROJECT
,
clients are required to to set the project name to null
.
The default is to associate the refactoring with the workspace.
setProject
in class JavaRefactoringDescriptor
project
- the non-empty project name to set, or null
for
the workspaceRefactoringDescriptor.getProject()
public void setResource(IResource resource)
Note: If the resource to be renamed is of type IResource.PROJECT
,
clients are required to to set the project name to null
.
resource
- the resource to be renamedpublic IPath getResourcePath()
public RefactoringStatus validateDescriptor()
Clients must call this method to verify that all arguments have been
correctly set and that they satisfy the constraints imposed by specific
refactorings. Returning a refactoring status of severity
RefactoringStatus.FATAL
indicates that the refactoring descriptor
cannot be used to create a refactoring instance.
validateDescriptor
in class JavaRefactoringDescriptor
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.