public final class UseSupertypeDescriptor extends JavaRefactoringDescriptor
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.
ATTRIBUTE_ELEMENT, ATTRIBUTE_INPUT, ATTRIBUTE_NAME, ATTRIBUTE_REFERENCES, ATTRIBUTE_SELECTION, ATTRIBUTE_VERSION, fArguments, JAR_MIGRATION, JAR_REFACTORING, JAR_SOURCE_ATTACHMENT, VALUE_VERSION_1_0
BREAKING_CHANGE, ID_UNKNOWN, MULTI_CHANGE, NONE, STRUCTURAL_CHANGE, USER_CHANGE
Constructor and Description |
---|
UseSupertypeDescriptor()
Creates a new refactoring descriptor.
|
UseSupertypeDescriptor(String project,
String description,
String comment,
Map arguments,
int flags)
Creates a new refactoring descriptor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
populateArgumentMap()
Populates the refactoring descriptor argument map based on the specified
arguments.
|
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.
|
createRefactoring, elementToHandle, getArguments, handleToElement, handleToElement, handleToElement, handleToResource, resourceToHandle, setComment, setDescription, setFlags, setProject
compareTo, createRefactoringContext, equals, getComment, getDescription, getFlags, getID, getProject, getTimeStamp, hashCode, setTimeStamp, toString
public UseSupertypeDescriptor()
public UseSupertypeDescriptor(String project, String description, String comment, Map arguments, int flags)
project
- the non-empty name of the project associated with this
refactoring, or null
for a workspace
refactoringdescription
- a non-empty human-readable description of the particular
refactoring instancecomment
- the human-readable comment of the particular refactoring
instance, or null
for no commentarguments
- a map of arguments that will be persisted and describes
all settings for this refactoringflags
- the flags of the refactoring descriptorIllegalArgumentException
- if the argument map contains invalid keys/valuesprotected void populateArgumentMap()
JavaRefactoringDescriptor.fArguments
.populateArgumentMap
in class JavaRefactoringDescriptor
public void setReplaceInstanceof(boolean replace)
The default is to not replace the subtype occurrence.
replace
- true
to replace subtype occurrences in
'instanceof' statements, false
otherwisepublic void setSubtype(IType type)
Occurrences of the subtype are replaced by the supertype set by
setSupertype(IType)
where possible.
type
- the subtype to setpublic void setSupertype(IType type)
Occurrences of the subtype set by setSubtype(IType)
are replaced
by the supertype where possible.
type
- the supertype to setpublic RefactoringStatus validateDescriptor()
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.
validateDescriptor
in class JavaRefactoringDescriptor
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.