Package com.intellij.refactoring

Interface Refactoring

All Known Subinterfaces:

ConvertToInstanceMethodRefactoring, IntroduceParameterRefactoring, JavaRenameRefactoring, MakeStaticRefactoring<T>, MoveClassesOrPackagesRefactoring, MoveInnerRefactoring, MoveInstanceMethodRefactoring, MoveMembersRefactoring, RenameRefactoring, ReplaceConstructorWithFactoryRefactoring, SafeDeleteRefactoring, TurnRefsToSuperRefactoring, TypeCookRefactoring

All Known Implementing Classes:

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

public interface Refactoring

Represents refactoring in IDE.

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 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.

Method Detail

setPreviewUsages

void setPreviewUsages(boolean value)

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.

isPreviewUsages

boolean isPreviewUsages()

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.

setInteractive

void setInteractive(java.lang.Runnable prepareSuccessfulCallback)

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.

isInteractive

boolean isInteractive()

Returns whether refactoring is interactive.

See Also:

setInteractive(Runnable)

findUsages

UsageInfo[] findUsages()

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.

preprocessUsages

boolean preprocessUsages(Ref<UsageInfo[]> usages)

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

See Also:

setInteractive(Runnable)

shouldPreviewUsages

boolean shouldPreviewUsages(UsageInfo[] usages)

Checks whether usages need to be shown.

See Also:

setPreviewUsages(boolean), isPreviewUsages()

doRefactoring

void doRefactoring(UsageInfo[] usages)

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

run

void run()

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

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