Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse JDT
Release 3.5

org.eclipse.jdt.core.refactoring.descriptors
Class RenameLocalVariableDescriptor

java.lang.Object
  extended by 

org.eclipse.ltk.core.refactoring.RefactoringDescriptor
      extended by 

org.eclipse.jdt.core.refactoring.descriptors.JavaRefactoringDescriptor
          extended by 
org.eclipse.jdt.core.refactoring.descriptors.RenameLocalVariableDescriptor
All Implemented Interfaces:
Comparable

Deprecated. since 1.2 merged into RenameJavaElementDescriptor

public final class RenameLocalVariableDescriptor
extends JavaRefactoringDescriptor

Refactoring descriptor for the rename local variable 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 appropriate refactoring id.

Note: this class is not intended to be instantiated by clients.

Since:
1.1
Restriction:
This class is not intended to be instantiated by clients.

Field Summary
 
Fields inherited from class org.eclipse.jdt.core.refactoring.descriptors. JavaRefactoringDescriptor
ATTRIBUTE_ELEMENT, ATTRIBUTE_INPUT, ATTRIBUTE_NAME, ATTRIBUTE_REFERENCES, ATTRIBUTE_SELECTION, ATTRIBUTE_VERSION, fArguments, JAR_MIGRATION, JAR_REFACTORING, JAR_SOURCE_ATTACHMENT, VALUE_VERSION_1_0
 
Fields inherited from class org.eclipse.ltk.core.refactoring. RefactoringDescriptor
BREAKING_CHANGE, ID_UNKNOWN, MULTI_CHANGE, NONE, STRUCTURAL_CHANGE, USER_CHANGE
 
Constructor Summary
RenameLocalVariableDescriptor ()
          Deprecated. merged into RenameJavaElementDescriptor
 
Method Summary
protected  void populateArgumentMap ()
          Deprecated. Populates the refactoring descriptor argument map based on the specified arguments.
 void setCompilationUnit ( ICompilationUnit unit)
          Deprecated. Sets the compilation unit which contains the local variable.
 void setNewName ( String name)
          Deprecated. Sets the new name to rename the local variable to.
 void setSelection ( ISourceRange selection)
          Deprecated. Sets the selection within the compilation unit which references the local variable to rename.
 void setUpdateReferences (boolean update)
          Deprecated. Determines whether references to the local variable should be renamed.
  RefactoringStatus validateDescriptor ()
          Deprecated. Validates the refactoring descriptor with respect to the constraints imposed by the represented refactoring.
 
Methods inherited from class org.eclipse.jdt.core.refactoring.descriptors. JavaRefactoringDescriptor
createRefactoring, elementToHandle, getArguments, handleToElement, handleToElement, handleToElement, handleToResource, resourceToHandle, setComment, setDescription, setFlags, setProject
 
Methods inherited from class org.eclipse.ltk.core.refactoring. RefactoringDescriptor
compareTo, equals, getComment, getDescription, getFlags, getID, getProject, getTimeStamp, hashCode, setTimeStamp, toString
 
Methods inherited from class java.lang. Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RenameLocalVariableDescriptor

public RenameLocalVariableDescriptor()
Deprecated. merged into RenameJavaElementDescriptor

Creates a new refactoring descriptor.

Method Detail

populateArgumentMap

protected void populateArgumentMap()
Deprecated. 
Populates the refactoring descriptor argument map based on the specified arguments. Subclasses should extend and add their arguments to JavaRefactoringDescriptor.fArguments.

Overrides:
populateArgumentMap in class JavaRefactoringDescriptor

setCompilationUnit

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

Parameters:
unit - the compilation unit to set

setNewName

public void setNewName(
String name)
Deprecated. 
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)
Deprecated. 
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)
Deprecated. 
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()
Deprecated. 
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 JavaRefactoringDescriptor
Returns:
a refactoring status describing the outcome of the validation

Eclipse JDT
Release 3.5

Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire