public final class RenameLocalVariableDescriptor 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 |
---|
RenameLocalVariableDescriptor()
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 |
setCompilationUnit(IJavaScriptUnit unit)
Sets the compilation unit which contains the local variable.
|
void |
setNewName(java.lang.String name)
Sets the new name to rename the local variable to.
|
void |
setSelection(ISourceRange selection)
Sets the selection within the compilation unit which references the local
variable to rename.
|
void |
setUpdateReferences(boolean update)
Determines whether references to the local variable should 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, setProject
public RenameLocalVariableDescriptor()
protected void populateArgumentMap()
populateArgumentMap
in class JavaScriptRefactoringDescriptor
public void setCompilationUnit(IJavaScriptUnit unit)
unit
- the compilation unit to setpublic void setNewName(java.lang.String name)
name
- the non-empty new name to setpublic void setSelection(ISourceRange selection)
selection
- the selection to setpublic void setUpdateReferences(boolean update)
The default is to not update references.
update
- true
to update references, false
otherwisepublic 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.