org.eclipse.wst.jsdt.core.refactoring.descriptors
Class RenameLocalVariableDescriptor

java.lang.Object
  extended by RefactoringDescriptor
      extended by org.eclipse.wst.jsdt.core.refactoring.descriptors.JavaScriptRefactoringDescriptor
          extended by org.eclipse.wst.jsdt.core.refactoring.descriptors.RenameLocalVariableDescriptor

public final class RenameLocalVariableDescriptor
extends JavaScriptRefactoringDescriptor

Refactoring descriptor for the rename local variable refactoring.

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.


Field Summary
 
Fields inherited from class org.eclipse.wst.jsdt.core.refactoring.descriptors.JavaScriptRefactoringDescriptor
JAR_MIGRATION, JAR_REFACTORING, JAR_SOURCE_ATTACHMENT
 
Constructor Summary
RenameLocalVariableDescriptor()
          Creates a new refactoring descriptor.
 
Method Summary
 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.
 
Methods inherited from class org.eclipse.wst.jsdt.core.refactoring.descriptors.JavaScriptRefactoringDescriptor
createRefactoring, setComment, setDescription, setFlags, setProject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RenameLocalVariableDescriptor

public RenameLocalVariableDescriptor()
Creates a new refactoring descriptor.

Method Detail

setCompilationUnit

public void setCompilationUnit(IJavaScriptUnit unit)
Sets the compilation unit which contains the local variable.

Parameters:
unit - the compilation unit to set

setNewName

public void setNewName(java.lang.String name)
Sets the new name to rename the local variable to.

Parameters:
name - the non-empty new name to set

setSelection

public void setSelection(ISourceRange selection)
Sets the selection within the compilation unit which references the local variable to rename.

Parameters:
selection - the selection to set

setUpdateReferences

public void setUpdateReferences(boolean update)
Determines whether references to the local variable should be renamed.

The default is to not update references.

Parameters:
update - true to update references, false otherwise

validateDescriptor

public RefactoringStatus validateDescriptor()
Validates the refactoring descriptor with respect to the constraints imposed by the represented refactoring.

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.

Overrides:
validateDescriptor in class JavaScriptRefactoringDescriptor
Returns:
a refactoring status describing the outcome of the validation