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

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.MoveDescriptor

public final class MoveDescriptor
extends JavaScriptRefactoringDescriptor

Refactoring descriptor for the move 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
MoveDescriptor()
          Creates a new refactoring descriptor.
 
Method Summary
 void setDestination(IJavaScriptElement element)
          Sets the destination of the move.
 void setFileNamePatterns(java.lang.String patterns)
          Sets the file name patterns to use during qualified name updating.
 void setMoveMembers(IMember[] members)
          Sets the members to move.
 void setMovePackageFragmentRoots(IPackageFragmentRoot[] roots)
          Sets the package fragment roots to move.
 void setMovePackages(IPackageFragment[] fragments)
          Sets the package fragments to move.
 void setMoveResources(IFile[] files, IFolder[] folders, IJavaScriptUnit[] units)
          Sets the resources and compilation units to move.
 void setUpdateQualifiedNames(boolean update)
          Determines whether qualified names of the Java element should be renamed.
 void setUpdateReferences(boolean update)
          Determines whether references to the Java element 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

MoveDescriptor

public MoveDescriptor()
Creates a new refactoring descriptor.

Method Detail

setDestination

public void setDestination(IJavaScriptElement element)
Sets the destination of the move.

Note: Clients may call only one of the setDestination methods.

Parameters:
element - the java element

setFileNamePatterns

public void setFileNamePatterns(java.lang.String patterns)
Sets the file name patterns to use during qualified name updating.

The syntax of the file name patterns is a sequence of individual name patterns, separated by comma. Additionally, wildcard characters '*' (any string) and '?' (any character) may be used.

Note: If file name patterns are set, qualified name updating must be enabled by calling setUpdateQualifiedNames(boolean).

Note: Qualified name updating is currently applicable to files, folders and compilation units. The default is to not update qualified names.

Parameters:
patterns - the non-empty file name patterns string

setMoveMembers

public void setMoveMembers(IMember[] members)
Sets the members to move.

Note: Clients must only call one of the setMoveXXX methods.

Parameters:
members - the members to move

setMovePackageFragmentRoots

public void setMovePackageFragmentRoots(IPackageFragmentRoot[] roots)
Sets the package fragment roots to move.

Note: Clients must only call one of the setMoveXXX methods.

Parameters:
roots - the package fragment roots to move

setMovePackages

public void setMovePackages(IPackageFragment[] fragments)
Sets the package fragments to move.

Note: Clients must only call one of the setMoveXXX methods.

Parameters:
fragments - the package fragments to move

setMoveResources

public void setMoveResources(IFile[] files,
                             IFolder[] folders,
                             IJavaScriptUnit[] units)
Sets the resources and compilation units to move.

Note: Clients must only call one of the setMoveXXX methods.

Parameters:
files - the files to move
folders - the folders to move
units - the compilation units to move

setUpdateQualifiedNames

public void setUpdateQualifiedNames(boolean update)
Determines whether qualified names of the Java element should be renamed.

Qualified name updating adapts fully qualified names of the Java element to be renamed in non-Java text files. Clients may specify file name patterns by calling setFileNamePatterns(String) to constrain the set of text files to be processed.

Note: Qualified name updating is currently applicable to files, folders and compilation units. The default is to use no file name patterns (meaning that all files are processed).

Parameters:
update - true to update qualified names, false otherwise

setUpdateReferences

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

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