Package com.intellij.refactoring

Class RefactoringImpl<T extends BaseRefactoringProcessor>

java.lang.Object

com.intellij.refactoring.RefactoringImpl<T>

All Implemented Interfaces:

Refactoring

Direct Known Subclasses:

ConvertToInstanceMethodRefactoringImpl, MakeClassStaticRefactoringImpl, MakeMethodStaticRefactoringImpl, MoveClassesOrPackagesRefactoringImpl, MoveInnerRefactoringImpl, MoveInstanceMethodRefactoringImpl, MoveMembersRefactoringImpl, RenameRefactoringImpl, ReplaceConstructorWithFactoryRefactoringImpl, SafeDeleteRefactoringImpl, TurnRefsToSuperRefactoringImpl, TypeCookRefactoringImpl

public abstract class RefactoringImpl<T extends BaseRefactoringProcessor>
extends java.lang.Object
implements Refactoring

Field Summary

Fields

Modifier and Type	Field and Description
protected T	myProcessor

Constructor Summary

Constructors

Constructor and Description
RefactoringImpl(T refactoringProcessor)

Method Summary

Modifier and Type	Method and Description
void	doRefactoring(UsageInfo[] usages) Performs all changes in code that are necessary.
UsageInfo[]	findUsages() Searches for places in code that refactoring will change.
boolean	isInteractive() Returns whether refactoring is interactive.
boolean	isPreviewUsages() Returns value of previewUsages property.
boolean	preprocessUsages(Ref<UsageInfo[]> usages) Analyses usages (presumably obtained from Refactoring.findUsages() for possible conflicts and (if refactoring is interactive) presents user with appropriate conflicts dialog.
void	run() Runs the whole refactoring.
void	setInteractive(java.lang.Runnable prepareSuccessfulCallback) Controls whether this refactoring is interactive: whether it should show conflicts dialog and other dialogs.
void	setPreviewUsages(boolean value) Controls whether refactoring shows a preview.
boolean	shouldPreviewUsages(UsageInfo[] usages) Checks whether usages need to be shown.

Methods inherited from class java.lang.Object

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

Field Detail

myProcessor

protected final T extends BaseRefactoringProcessor myProcessor

Constructor Detail

RefactoringImpl

public RefactoringImpl(T refactoringProcessor)

Method Detail

setPreviewUsages

public void setPreviewUsages(boolean value)

Description copied from interface: Refactoring

Controls whether refactoring shows a preview.

If there are modifications that should be performed in non-java files or not in code, preview will be shown regardless of this setting.

Specified by:

setPreviewUsages in interface Refactoring

isPreviewUsages

public boolean isPreviewUsages()

Description copied from interface: Refactoring

Returns value of previewUsages property. If there are modifications that should be performed in non-java files or not in code, preview will be shown regardless of this setting.

Specified by:

isPreviewUsages in interface Refactoring

setInteractive

public void setInteractive(java.lang.Runnable prepareSuccessfulCallback)

Description copied from interface: Refactoring

Controls whether this refactoring is interactive: whether it should show conflicts dialog and other dialogs.

If prepareSuccessfulCallback is not null, refactoring is interactive, and the callback is executed if user did not cancel the refactoring operation, right after preprocessUsages has finished.

If prepareSuccessfulCallback is null, user is not presented with conflicts etc., but the preview may still be shown.

Note: the callback is executed in dispatch thread.

Refactorings are interactive by default, with empty runnable as a callback.

Specified by:

setInteractive in interface Refactoring

isInteractive

public boolean isInteractive()

Description copied from interface: Refactoring

Returns whether refactoring is interactive.

Specified by:

isInteractive in interface Refactoring

See Also:

Refactoring.setInteractive(Runnable)

findUsages

public UsageInfo[] findUsages()

Description copied from interface: Refactoring

Searches for places in code that refactoring will change. <[> This method should be best invoked in the process with progress and it does all the lengthy code analysis operations.

Specified by:

findUsages in interface Refactoring

preprocessUsages

public boolean preprocessUsages(Ref<UsageInfo[]> usages)

Description copied from interface: Refactoring

Analyses usages (presumably obtained from Refactoring.findUsages() for possible conflicts and (if refactoring is interactive) presents user with appropriate conflicts dialog.

Specified by:

preprocessUsages in interface Refactoring

See Also:

Refactoring.setInteractive(Runnable)

shouldPreviewUsages

public boolean shouldPreviewUsages(UsageInfo[] usages)

Description copied from interface: Refactoring

Checks whether usages need to be shown.

Specified by:

shouldPreviewUsages in interface Refactoring

See Also:

Refactoring.setPreviewUsages(boolean), Refactoring.isPreviewUsages()

doRefactoring

public void doRefactoring(UsageInfo[] usages)

Description copied from interface: Refactoring

Performs all changes in code that are necessary. Does NOT require command or write action, but should be invoked in dispatch thread.

Specified by:

doRefactoring in interface Refactoring

run

public void run()

Description copied from interface: Refactoring

Runs the whole refactoring. The logic of this method is as follows:

1. execute Refactoring.findUsages() (with progress dialog and all)
2. execute Refactoring.preprocessUsages(Ref)
3. if refactoring was not cancelled, check whether we Refactoring.shouldPreviewUsages(UsageInfo[]), and show the preview
4. execute Refactoring.doRefactoring(UsageInfo[]) if appropriate (if either the preview was not shown, or 'Do Refactor' button has been pressed)

Specified by:

run in interface Refactoring