public final class RenameResourceDescriptor extends JavaScriptRefactoringDescriptor
An instance of this refactoring descriptor may be obtained by calling
org.eclipse.ltk.core.refactoring.RefactoringContribution#createDescriptor()
on a refactoring
contribution requested by invoking
org.eclipse.ltk.core.refactoring.RefactoringCore#getRefactoringContribution(String)
with the
appropriate refactoring id.
Note: this class is not intended to be instantiated by clients.
Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.ATTRIBUTE_ELEMENT, ATTRIBUTE_INPUT, ATTRIBUTE_NAME, ATTRIBUTE_REFERENCES, ATTRIBUTE_SELECTION, ATTRIBUTE_VERSION, fArguments, JAR_MIGRATION, JAR_REFACTORING, JAR_SOURCE_ATTACHMENT, VALUE_VERSION_1_0
Constructor and Description |
---|
RenameResourceDescriptor()
Creates a new refactoring descriptor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
populateArgumentMap()
Populates the refactoring descriptor argument map based on the specified
arguments.
|
void |
setNewName(java.lang.String name)
Sets the new name to rename the resource to.
|
void |
setProject(java.lang.String project)
Sets the project name of this refactoring.
|
void |
setResource(IResource resource)
Sets the resource to be renamed.
|
RefactoringStatus |
validateDescriptor()
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
public RenameResourceDescriptor()
protected void populateArgumentMap()
populateArgumentMap
in class JavaScriptRefactoringDescriptor
public void setNewName(java.lang.String name)
name
- the non-empty new name to setpublic void setProject(java.lang.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 JavaScriptRefactoringDescriptor
project
- the non-empty project name to set, or null
for
the workspace#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 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 JavaScriptRefactoringDescriptor
Copyright (c) IBM Corp. and others 2000, 2016. All Rights Reserved.