Composite Refactoring
v1.0

compositeRefactoring.refactoringComposite
Class RefactoringComponent

java.lang.Object
  |
  +--compositeRefactoring.refactoringComposite.RefactoringComponent
Direct Known Subclasses:
RefactoringComposite, RefactoringNode

public abstract class RefactoringComponent
extends Object

this class is the superclass of all RefactoringComponents. A RefactoringComponent can be


Field Summary
protected  String fName
           
 
Method Summary
abstract  RefactoringStatus checkPreconditions(IProgressMonitor pm)
          abstract method for checking the refactorings' enabling conditions
abstract  IChange createChange(IProgressMonitor pm)
          abstract method for creating the code change of the refactoring
 String getName()
          gets the name of the RefactoringComponent
abstract  RefactoringStatus refactor()
          this method performs the refactoring.
abstract  RefactoringStatus undo()
          this method undos the refactoring when it was performed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fName

protected String fName
Method Detail

refactor

public abstract RefactoringStatus refactor()
this method performs the refactoring.
Returns:
the status of the performed refactoring.

undo

public abstract RefactoringStatus undo()
this method undos the refactoring when it was performed.
Returns:
the status of the undo operation.

getName

public String getName()
gets the name of the RefactoringComponent
Returns:
the name of the RefactoringComponent.

checkPreconditions

public abstract RefactoringStatus checkPreconditions(IProgressMonitor pm)
                                              throws JavaModelException
abstract method for checking the refactorings' enabling conditions
Parameters:
pm - the progress monitor to track the checks.
Returns:
the status of the check.

createChange

public abstract IChange createChange(IProgressMonitor pm)
                              throws JavaModelException
abstract method for creating the code change of the refactoring
Parameters:
pm - the progress monitor to track the change.
Returns:
the change object of the refactoring.

Composite Refactoring
v1.0