org.netbeans.modules.refactoring.spi

Interface RefactoringPlugin

public interface RefactoringPlugin

Interface implemented by refactoring plugins. Contains callback methods which a particular refactoring calls to check pre-conditions, validity of parameters and collect refactoring elements. It is expected that the refactoring that this plugin operates on is passed to the plugin in its constructor by a corresponding implementation of RefactoringPluginFactory.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelRequest() Asynchronous request to cancel ongoing long-term request (such as preCheck(), checkParameters() or prepare())
Problem	checkParameters() Checks parameters of the refactoring.
Problem	fastCheckParameters() Fast checks parameters of the refactoring.
Problem	preCheck() Checks pre-conditions of the refactoring and returns problems.
Problem	prepare(RefactoringElementsBag refactoringElements) Collects refactoring elements for a given refactoring.

Method Detail

preCheck

Problem preCheck()

Checks pre-conditions of the refactoring and returns problems.

Returns:

Problems found or null (if no problems were identified)

checkParameters

Problem checkParameters()

Checks parameters of the refactoring.

Returns:

Problems found or null (if no problems were identified)

fastCheckParameters

Problem fastCheckParameters()

Fast checks parameters of the refactoring. This method will be used for online error checking.

Returns:

Problems found or null (if no problems were identified)

cancelRequest

void cancelRequest()

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

prepare

Problem prepare(RefactoringElementsBag refactoringElements)

Collects refactoring elements for a given refactoring.

Parameters:

refactoringElements - RefactoringElementsBag of refactoring elements - the implementation of this method should add refactoring elements to this collections. It should make no assumptions about the collection content.

Returns:

Problems found or null (if no problems were identified)