Package com.intellij.refactoring

Class BaseRefactoringProcessor

java.lang.Object

com.intellij.refactoring.BaseRefactoringProcessor

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

ChangeClassSignatureProcessor, ChangeSignatureProcessorBase, ConvertToInstanceMethodProcessor, ConvertToJavaProcessor, ConvertToStaticProcessor, EncapsulateFieldsProcessor, ExtractClosureProcessorBase, ExtractMethodObjectProcessor, FixableUsagesRefactoringProcessor, GrIntroduceClosureParameterProcessor, GrIntroduceParameterProcessor, GroovyInlineLocalProcessor, InheritanceToDelegationProcessor, InlineConstantFieldProcessor, InlineMethodProcessor, InlineObjectProcessor, InlineParameterExpressionProcessor, InlineToAnonymousClassProcessor, IntroduceParameterProcessor, InvertBooleanProcessor, MakeMethodOrClassStaticProcessor, MigrationProcessor, MoveClassesOrPackagesProcessor, MoveClassToInnerProcessor, MoveDirectoryWithClassesProcessor, MoveFilesOrDirectoriesProcessor, MoveInnerProcessor, MoveInstanceMethodProcessor, MoveMembersProcessor, PullUpProcessor, PushDownProcessor, PyBaseMakeFunctionTopLevelProcessor, PyMembersRefactoringBaseProcessor, PyMoveModuleMembersProcessor, RenameProcessor, ReplaceConstructorWithFactoryProcessor, SafeDeleteProcessor, TurnRefsToSuperProcessorBase, TypeCookProcessor, TypeMigrationProcessor

public abstract class BaseRefactoringProcessor
extends java.lang.Object
implements java.lang.Runnable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseRefactoringProcessor.ConflictsInTestsException
static class	BaseRefactoringProcessor.UnknownReferenceTypeException

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Runnable	myPrepareSuccessfulSwingThreadCallback
protected Project	myProject
protected SearchScope	myRefactoringScope

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseRefactoringProcessor(Project project)
protected	BaseRefactoringProcessor(Project project, java.lang.Runnable prepareSuccessfulCallback)
protected	BaseRefactoringProcessor(Project project, SearchScope refactoringScope, java.lang.Runnable prepareSuccessfulCallback)

Method Summary

Modifier and Type	Method and Description
protected ConflictsDialog	createConflictsDialog(MultiMap<PsiElement,java.lang.String> conflicts, UsageInfo [] usages)
protected abstract UsageViewDescriptor	createUsageViewDescriptor(UsageInfo [] usages)
protected void	customizeUsagesView(UsageViewDescriptor viewDescriptor, UsageView usageView)
protected void	doRun()
protected void	execute(UsageInfo [] usages)
protected abstract UsageInfo []	findUsages() Is called inside atomic action.
protected RefactoringEventData	getAfterData(UsageInfo [] usages)
protected RefactoringEventData	getBeforeData()
protected abstract java.lang.String	getCommandName()
protected java.util.Collection<? extends PsiElement>	getElementsToWrite(UsageViewDescriptor descriptor)
protected java.lang.String	getRefactoringId()
protected RefactoringTransaction	getTransaction()
protected UndoConfirmationPolicy	getUndoConfirmationPolicy()
protected boolean	isGlobalUndoAction()
protected boolean	isPreviewUsages()
protected boolean	isPreviewUsages(UsageInfo [] usages) Is called inside atomic action.
protected boolean	isToBeChanged(UsageInfo usageInfo)
protected void	performPsiSpoilingRefactoring() Refactorings that spoil PSI (write something directly to documents etc.) should do that in this method. This method is called immediately after performRefactoring(UsageInfo[]).
protected abstract void	performRefactoring(UsageInfo [] usages) Is called in a command and inside atomic action.
protected ConflictsDialog	prepareConflictsDialog(MultiMap<PsiElement,java.lang.String> conflicts, UsageInfo [] usages)
protected void	prepareSuccessful()
protected boolean	preprocessUsages(Ref<UsageInfo[]> refUsages) Is called inside atomic action.
protected void	previewRefactoring(UsageInfo [] usages)
static boolean	processConflicts(Project project, MultiMap<PsiElement,java.lang.String> conflicts) Processes conflicts (possibly shows UI).
protected void	refreshElements(PsiElement [] elements) is called when usage search is re-run.
void	run()
static <T extends java.lang.Throwable> void	runWithDisabledPreview(ThrowableRunnable<T> runnable)
void	setPrepareSuccessfulSwingThreadCallback(java.lang.Runnable prepareSuccessfulSwingThreadCallback)
void	setPreviewUsages(boolean isPreviewUsages)
protected boolean	shouldDisableAccessChecks()
protected boolean	showConflicts(MultiMap<PsiElement,java.lang.String> conflicts) Deprecated. use showConflicts(MultiMap, UsageInfo[])
protected boolean	showConflicts(MultiMap<PsiElement,java.lang.String> conflicts, UsageInfo [] usages)
protected boolean	skipNonCodeUsages()

Methods inherited from class java.lang.Object

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

Field Detail

myProject

protected final Project myProject

myRefactoringScope

protected final SearchScope myRefactoringScope

myPrepareSuccessfulSwingThreadCallback

protected java.lang.Runnable myPrepareSuccessfulSwingThreadCallback

Constructor Detail

BaseRefactoringProcessor

protected BaseRefactoringProcessor(Project project)

BaseRefactoringProcessor

protected BaseRefactoringProcessor(Project project,
                                   java.lang.Runnable prepareSuccessfulCallback)

BaseRefactoringProcessor

protected BaseRefactoringProcessor(Project project,
                                   SearchScope refactoringScope,
                                   java.lang.Runnable prepareSuccessfulCallback)

Method Detail

createUsageViewDescriptor

protected abstract UsageViewDescriptor createUsageViewDescriptor(UsageInfo [] usages)

findUsages

protected abstract UsageInfo [] findUsages()

Is called inside atomic action.

refreshElements

protected void refreshElements(PsiElement [] elements)

is called when usage search is re-run.

Parameters:

elements - - refreshed elements that are returned by UsageViewDescriptor.getElements()

preprocessUsages

protected boolean preprocessUsages(Ref<UsageInfo[]> refUsages)

Is called inside atomic action.

Parameters:

refUsages - usages to be filtered

Returns:

true if preprocessed successfully

isPreviewUsages

protected boolean isPreviewUsages(UsageInfo [] usages)

Is called inside atomic action.

isPreviewUsages

protected boolean isPreviewUsages()

setPreviewUsages

public void setPreviewUsages(boolean isPreviewUsages)

setPrepareSuccessfulSwingThreadCallback

public void setPrepareSuccessfulSwingThreadCallback(java.lang.Runnable prepareSuccessfulSwingThreadCallback)

getTransaction

protected RefactoringTransaction getTransaction()

performRefactoring

protected abstract void performRefactoring(UsageInfo [] usages)

Is called in a command and inside atomic action.

getCommandName

protected abstract java.lang.String getCommandName()

doRun

protected void doRun()

runWithDisabledPreview

public static <T extends java.lang.Throwable> void runWithDisabledPreview(ThrowableRunnable<T> runnable)
                                                                   throws T extends java.lang.Throwable

Throws:

T extends java.lang.Throwable

previewRefactoring

protected void previewRefactoring(UsageInfo [] usages)

skipNonCodeUsages

protected boolean skipNonCodeUsages()

execute

protected void execute(UsageInfo [] usages)

isGlobalUndoAction

protected boolean isGlobalUndoAction()

getUndoConfirmationPolicy

protected UndoConfirmationPolicy getUndoConfirmationPolicy()

processConflicts

public static boolean processConflicts(Project project,
                                       MultiMap<PsiElement,java.lang.String> conflicts)

Processes conflicts (possibly shows UI). In case we're running in unit test mode this method will throw BaseRefactoringProcessor.ConflictsInTestsException that can be handled inside a test. Thrown exception would contain conflicts' messages.

Parameters:

project - project

conflicts - map with conflict messages and locations

Returns:

true if refactoring could proceed or false if refactoring should be cancelled

customizeUsagesView

protected void customizeUsagesView(UsageViewDescriptor viewDescriptor,
                                   UsageView usageView)

isToBeChanged

protected boolean isToBeChanged(UsageInfo usageInfo)

performPsiSpoilingRefactoring

protected void performPsiSpoilingRefactoring()

Refactorings that spoil PSI (write something directly to documents etc.) should do that in this method.
This method is called immediately after performRefactoring(UsageInfo[]).

prepareSuccessful

protected void prepareSuccessful()

run

public final void run()

Specified by:

run in interface java.lang.Runnable

shouldDisableAccessChecks

protected boolean shouldDisableAccessChecks()

showConflicts

@Deprecated
protected boolean showConflicts(MultiMap<PsiElement,java.lang.String> conflicts)

Deprecated. use showConflicts(MultiMap, UsageInfo[])

showConflicts

protected boolean showConflicts(MultiMap<PsiElement,java.lang.String> conflicts,
                                UsageInfo [] usages)

prepareConflictsDialog

protected ConflictsDialog prepareConflictsDialog(MultiMap<PsiElement,java.lang.String> conflicts,
                                                 UsageInfo [] usages)

getBeforeData

protected RefactoringEventData getBeforeData()

getAfterData

protected RefactoringEventData getAfterData(UsageInfo [] usages)

getRefactoringId

protected java.lang.String getRefactoringId()

createConflictsDialog

protected ConflictsDialog createConflictsDialog(MultiMap<PsiElement,java.lang.String> conflicts,
                                                UsageInfo [] usages)

getElementsToWrite

protected java.util.Collection<? extends PsiElement> getElementsToWrite(UsageViewDescriptor descriptor)