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

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

public final class UseSupertypeDescriptor
extends JavaScriptRefactoringDescriptor

Refactoring descriptor for the use supertype 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
UseSupertypeDescriptor()
          Creates a new refactoring descriptor.
 
Method Summary
 void setReplaceInstanceof(boolean replace)
          Determines whether 'instanceof' statements are considered as candidates to replace the subtype occurrence by one of its supertypes.
 void setSubtype(IType type)
          Sets the subtype of the refactoring.
 void setSupertype(IType type)
          Sets the supertype of the refactoring.
 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

UseSupertypeDescriptor

public UseSupertypeDescriptor()
Creates a new refactoring descriptor.

Method Detail

setReplaceInstanceof

public void setReplaceInstanceof(boolean replace)
Determines whether 'instanceof' statements are considered as candidates to replace the subtype occurrence by one of its supertypes.

The default is to not replace the subtype occurrence.

Parameters:
replace - true to replace subtype occurrences in 'instanceof' statements, false otherwise

setSubtype

public void setSubtype(IType type)
Sets the subtype of the refactoring.

Occurrences of the subtype are replaced by the supertype set by setSupertype(IType) where possible.

Parameters:
type - the subtype to set

setSupertype

public void setSupertype(IType type)
Sets the supertype of the refactoring.

Occurrences of the subtype set by setSubtype(IType) are replaced by the supertype where possible.

Parameters:
type - the supertype to set

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