Package com.intellij.refactoring.rename

Class RenameProcessor

java.lang.Object

com.intellij.refactoring.BaseRefactoringProcessor

com.intellij.refactoring.rename.RenameProcessor

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

MemberInplaceRenamer.MyRenameProcessor

public class RenameProcessor
extends BaseRefactoringProcessor

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.refactoring.BaseRefactoringProcessor

BaseRefactoringProcessor.ConflictsInTestsException, BaseRefactoringProcessor.UnknownReferenceTypeException

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedHashMap<PsiElement,java.lang.String>	myAllRenames
protected boolean	myForceShowPreview

Fields inherited from class com.intellij.refactoring.BaseRefactoringProcessor

myPrepareSuccessfulSwingThreadCallback, myProject, myRefactoringScope

Constructor Summary

Constructors

Constructor and Description
RenameProcessor(Project project, PsiElement element, java.lang.String newName, boolean isSearchInComments, boolean isSearchTextOccurrences)
RenameProcessor(Project project, PsiElement element, java.lang.String newName, SearchScope refactoringScope, boolean isSearchInComments, boolean isSearchTextOccurrences)

Method Summary

Modifier and Type	Method and Description
void	addElement(PsiElement element, java.lang.String newName)
void	addRenamerFactory(AutomaticRenamerFactory factory)
static void	assertNonCompileElement(PsiElement element)
static MultiMap<PsiElement,UsageInfo>	classifyUsages(java.util.Collection<? extends PsiElement> elements, UsageInfo[] usages)
protected UsageViewDescriptor	createUsageViewDescriptor(UsageInfo [] usages)
void	doRun()
UsageInfo []	findUsages() Is called inside atomic action.
protected RefactoringEventData	getAfterData(UsageInfo [] usages)
protected RefactoringEventData	getBeforeData()
protected java.lang.String	getCommandName()
java.util.Set<PsiElement>	getElements()
java.lang.String	getNewName(PsiElement element)
java.util.Collection<java.lang.String>	getNewNames()
protected java.lang.String	getRefactoringId()
boolean	hasNonCodeUsages()
protected boolean	isPreviewUsages(UsageInfo [] usages) Is called inside atomic action.
boolean	isSearchInComments()
boolean	isSearchTextOccurrences()
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 BaseRefactoringProcessor.performRefactoring(UsageInfo[]).
void	performRefactoring(UsageInfo [] usages) Is called in a command and inside atomic action.
void	prepareRenaming(PsiElement element, java.lang.String newName, java.util.LinkedHashMap<PsiElement,java.lang.String> allRenames)
boolean	preprocessUsages(Ref<UsageInfo[]> refUsages) Is called inside atomic action.
protected void	refreshElements(PsiElement [] elements) is called when usage search is re-run.
void	removeRenamerFactory(AutomaticRenamerFactory factory)
void	setCommandName(java.lang.String commandName)
void	setSearchInComments(boolean value)
void	setSearchTextOccurrences(boolean searchTextOccurrences)
protected boolean	showAutomaticRenamingDialog(AutomaticRenamer automaticVariableRenamer)

Methods inherited from class com.intellij.refactoring.BaseRefactoringProcessor

createConflictsDialog, customizeUsagesView, execute, getElementsToWrite, getTransaction, getUndoConfirmationPolicy, isGlobalUndoAction, isPreviewUsages, isToBeChanged, prepareConflictsDialog, prepareSuccessful, previewRefactoring, processConflicts, run, runWithDisabledPreview, setPrepareSuccessfulSwingThreadCallback, setPreviewUsages, shouldDisableAccessChecks, showConflicts, showConflicts, skipNonCodeUsages

Methods inherited from class java.lang.Object

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

Field Detail

myAllRenames

protected final java.util.LinkedHashMap<PsiElement,java.lang.String> myAllRenames

myForceShowPreview

protected boolean myForceShowPreview

Constructor Detail

RenameProcessor

public RenameProcessor(Project project,
                       PsiElement element,
                       java.lang.String newName,
                       boolean isSearchInComments,
                       boolean isSearchTextOccurrences)

RenameProcessor

public RenameProcessor(Project project,
                       PsiElement element,
                       java.lang.String newName,
                       SearchScope refactoringScope,
                       boolean isSearchInComments,
                       boolean isSearchTextOccurrences)

Method Detail

getElements

public java.util.Set<PsiElement> getElements()

getNewName

public java.lang.String getNewName(PsiElement element)

addRenamerFactory

public void addRenamerFactory(AutomaticRenamerFactory factory)

removeRenamerFactory

public void removeRenamerFactory(AutomaticRenamerFactory factory)

doRun

public void doRun()

Overrides:

doRun in class BaseRefactoringProcessor

prepareRenaming

public void prepareRenaming(PsiElement element,
                            java.lang.String newName,
                            java.util.LinkedHashMap<PsiElement,java.lang.String> allRenames)

preprocessUsages

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

Description copied from class: BaseRefactoringProcessor

Is called inside atomic action.

Overrides:

preprocessUsages in class BaseRefactoringProcessor

Parameters:

refUsages - usages to be filtered

Returns:

true if preprocessed successfully

assertNonCompileElement

public static void assertNonCompileElement(PsiElement element)

showAutomaticRenamingDialog

protected boolean showAutomaticRenamingDialog(AutomaticRenamer automaticVariableRenamer)

addElement

public void addElement(PsiElement element,
                       java.lang.String newName)

createUsageViewDescriptor

protected UsageViewDescriptor createUsageViewDescriptor(UsageInfo [] usages)

Specified by:

createUsageViewDescriptor in class BaseRefactoringProcessor

findUsages

public UsageInfo [] findUsages()

Description copied from class: BaseRefactoringProcessor

Is called inside atomic action.

Specified by:

findUsages in class BaseRefactoringProcessor

hasNonCodeUsages

public boolean hasNonCodeUsages()

refreshElements

protected void refreshElements(PsiElement [] elements)

Description copied from class: BaseRefactoringProcessor

is called when usage search is re-run.

Overrides:

refreshElements in class BaseRefactoringProcessor

Parameters:

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

isPreviewUsages

protected boolean isPreviewUsages(UsageInfo [] usages)

Description copied from class: BaseRefactoringProcessor

Is called inside atomic action.

Overrides:

isPreviewUsages in class BaseRefactoringProcessor

getRefactoringId

protected java.lang.String getRefactoringId()

Overrides:

getRefactoringId in class BaseRefactoringProcessor

getBeforeData

protected RefactoringEventData getBeforeData()

Overrides:

getBeforeData in class BaseRefactoringProcessor

getAfterData

protected RefactoringEventData getAfterData(UsageInfo [] usages)

Overrides:

getAfterData in class BaseRefactoringProcessor

performRefactoring

public void performRefactoring(UsageInfo [] usages)

Description copied from class: BaseRefactoringProcessor

Is called in a command and inside atomic action.

Specified by:

performRefactoring in class BaseRefactoringProcessor

performPsiSpoilingRefactoring

protected void performPsiSpoilingRefactoring()

Description copied from class: BaseRefactoringProcessor

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

Overrides:

performPsiSpoilingRefactoring in class BaseRefactoringProcessor

getCommandName

protected java.lang.String getCommandName()

Specified by:

getCommandName in class BaseRefactoringProcessor

classifyUsages

public static MultiMap<PsiElement,UsageInfo> classifyUsages(java.util.Collection<? extends PsiElement> elements,
                                                            UsageInfo[] usages)

getNewNames

public java.util.Collection<java.lang.String> getNewNames()

setSearchInComments

public void setSearchInComments(boolean value)

setSearchTextOccurrences

public void setSearchTextOccurrences(boolean searchTextOccurrences)

isSearchInComments

public boolean isSearchInComments()

isSearchTextOccurrences

public boolean isSearchTextOccurrences()

setCommandName

public void setCommandName(java.lang.String commandName)