Eclipse JDT
Release 3.3

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

java.lang.Object
  extended byorg.eclipse.ltk.core.refactoring.RefactoringDescriptor
      extended byorg.eclipse.jdt.core.refactoring.descriptors.JavaRefactoringDescriptor
          extended byorg.eclipse.jdt.core.refactoring.descriptors.RenameResourceDescriptor
All Implemented Interfaces:
Comparable

public final class RenameResourceDescriptor
extends JavaRefactoringDescriptor

Refactoring descriptor for the rename resource 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:
3.3

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
RenameResourceDescriptor()
          Creates a new refactoring descriptor.
 
Method Summary
protected  void populateArgumentMap()
          Populates the refactoring descriptor argument map based on the specified arguments.
 void setNewName(String name)
          Sets the new name to rename the resource to.
 void setProject(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.

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.

 
Methods inherited from class org.eclipse.jdt.core.refactoring.descriptors.JavaRefactoringDescriptor
createRefactoring, elementToHandle, getArguments, handleToElement, handleToElement, handleToElement, handleToResource, resourceToHandle, setComment, setDescription, setFlags
 
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

RenameResourceDescriptor

public RenameResourceDescriptor()
Creates a new refactoring descriptor.

Method Detail

populateArgumentMap

protected void populateArgumentMap()
Populates the refactoring descriptor argument map based on the specified arguments.

Overrides:
populateArgumentMap in class JavaRefactoringDescriptor

setNewName

public void setNewName(String name)
Sets the new name to rename the resource to.

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

setProject

public void setProject(String project)
Sets the project name of this refactoring.

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.

Overrides:
setProject in class JavaRefactoringDescriptor
Parameters:
project - the non-empty project name to set, or null for the workspace
See Also:
RefactoringDescriptor.getProject()

setResource

public void setResource(IResource resource)
Sets the resource to be renamed.

Note: If the resource to be renamed is of type IResource.PROJECT, clients are required to to set the project name to null.

Parameters:
resource - the resource to be renamed

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 JavaRefactoringDescriptor
Returns:
a refactoring status describing the outcome of the validation

Eclipse JDT
Release 3.3

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