AbstractRefactoring (Refactoring API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.refactoring.api 1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.refactoring.api
Class AbstractRefactoring

java.lang.Object
  org.netbeans.modules.refactoring.api.AbstractRefactoring

Direct Known Subclasses:: MoveRefactoring, MultipleCopyRefactoring, RenameRefactoring, SafeDeleteRefactoring, SingleCopyRefactoring, WhereUsedQuery

public abstract class AbstractRefactoring
extends Object
extends Object

Abstract superclass for particular refactorings. Methods should be typically called in following order:

preCheck
setParameter1(..), setParameter2(..) (this methods will typically be added by the subclass to allow parametrization of the implemented refactoring)
fastCheckParameters() (performs only fast check - useful for online error checking)
checkParameters() (full check of parameters)
prepare() (collects usages)

See Also:: RefactoringSession

Field Summary

static int INIT
          Initial state

static int PARAMETERS_CHECK
          Parameters check state.

static int PRE_CHECK
          Pre-check state.

static int PREPARE
          Prepare state.

Constructor Summary

protected AbstractRefactoring(Lookup refactoringSource)


Method Summary

void addProgressListener(ProgressListener listener)
          Registers ProgressListener to receive events.

void cancelRequest()
          Asynchronous request to cancel ongoing long-term request (such as preCheck(), checkParameters() or prepare())

Problem checkParameters()
          Checks if this refactoring has correctly set all parameters.

Problem fastCheckParameters()
          This method checks parameters.

Context getContext()
          getter for refactoring Context

Lookup getRefactoringSource()
          Object being refactored

Problem preCheck()
          Perform checks to ensure that the preconditions are met for the implemented refactoring.

Problem prepare(RefactoringSession session)
          Collects and returns a set of refactoring elements - objects that will be affected by the refactoring.

void removeProgressListener(ProgressListener listener)
          Removes ProgressListener from the list of listeners.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Summary
`static int`	`INIT` Initial state
`static int`	`PARAMETERS_CHECK` Parameters check state.
`static int`	`PRE_CHECK` Pre-check state.
`static int`	`PREPARE` Prepare state.

Constructor Summary
`protected`	`AbstractRefactoring(Lookup refactoringSource)`

Method Summary
`void`	`addProgressListener(ProgressListener listener)` Registers ProgressListener to receive events.
`void`	`cancelRequest()` Asynchronous request to cancel ongoing long-term request (such as preCheck(), checkParameters() or prepare())
`Problem`	`checkParameters()` Checks if this refactoring has correctly set all parameters.
`Problem`	`fastCheckParameters()` This method checks parameters.
`Context`	`getContext()` getter for refactoring Context
`Lookup`	`getRefactoringSource()` Object being refactored
`Problem`	`preCheck()` Perform checks to ensure that the preconditions are met for the implemented refactoring.
`Problem`	`prepare(RefactoringSession session)` Collects and returns a set of refactoring elements - objects that will be affected by the refactoring.
`void`	`removeProgressListener(ProgressListener listener)` Removes ProgressListener from the list of listeners.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

INIT

public static final int INIT

Initial state

See Also:: Constant Field Values

PRE_CHECK

public static final int PRE_CHECK

Pre-check state.

See Also:: Constant Field Values

PARAMETERS_CHECK

public static final int PARAMETERS_CHECK

Parameters check state.

See Also:: Constant Field Values

PREPARE

public static final int PREPARE

Prepare state.

See Also:: Constant Field Values

Constructor Detail