Package com.intellij.refactoring.rename

Class RenamePsiElementProcessor

java.lang.Object

com.intellij.refactoring.rename.RenamePsiElementProcessor

Direct Known Subclasses:

AntRenameProcessor, GrLightElementRenamer, JavaFxRenameFxIdFieldProcessor, RenameAliasingPomTargetProcessor, RenameGroovyPropertyProcessor, RenameJavaClassProcessor, RenameJavaMemberProcessor, RenameJavaModuleProcessor, RenamePropertyProcessor, RenamePsiDirectoryProcessor, RenamePsiFileProcessor, RenamePsiPackageProcessor, RenamePyElementProcessor, RenameXmlAttributeProcessor, YAMLRenamePsiElementProcessor

public abstract class RenamePsiElementProcessor
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static RenamePsiElementProcessor	DEFAULT
static ExtensionPointName<RenamePsiElementProcessor>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
RenamePsiElementProcessor()

Method Summary

Modifier and Type	Method and Description
static java.util.List<RenamePsiElementProcessor>	allForElement(PsiElement element)
abstract boolean	canProcessElement(PsiElement element)
RenameDialog	createRenameDialog(Project project, PsiElement element, PsiElement nameSuggestionContext, Editor editor)
UsageInfo	createUsageInfo(PsiElement element, PsiReference ref, PsiElement referenceElement)
void	findCollisions(PsiElement element, java.lang.String newName, java.util.Map<? extends PsiElement,java.lang.String> allRenames, java.util.List<UsageInfo> result)
void	findExistingNameConflicts(PsiElement element, java.lang.String newName, MultiMap<PsiElement,java.lang.String> conflicts)
void	findExistingNameConflicts(PsiElement element, java.lang.String newName, MultiMap<PsiElement,java.lang.String> conflicts, java.util.Map<PsiElement,java.lang.String> allRenames)
java.util.Collection<PsiReference>	findReferences(PsiElement element) Deprecated. use findReferences(PsiElement, SearchScope, boolean) instead
java.util.Collection<PsiReference>	findReferences(PsiElement element, boolean searchInCommentsAndStrings) Deprecated. use findReferences(PsiElement, SearchScope, boolean) instead
java.util.Collection<PsiReference>	findReferences(PsiElement element, SearchScope searchScope, boolean searchInCommentsAndStrings)
boolean	forcesShowPreview() Use this method to force showing preview for custom processors.
static RenamePsiElementProcessor	forElement(PsiElement element)
PsiElement	getElementToSearchInStringsAndComments(PsiElement element)
java.lang.String	getHelpID(PsiElement element)
java.lang.Runnable	getPostRenameCallback(PsiElement element, java.lang.String newName, RefactoringElementListener elementListener)
java.lang.String	getQualifiedNameAfterRename(PsiElement element, java.lang.String newName, boolean nonJava)
Pair<java.lang.String,java.lang.String>	getTextOccurrenceSearchStrings(PsiElement element, java.lang.String newName)
boolean	isInplaceRenameSupported()
boolean	isToSearchForTextOccurrences(PsiElement element)
boolean	isToSearchInComments(PsiElement element)
void	prepareRenaming(PsiElement element, java.lang.String newName, java.util.Map<PsiElement,java.lang.String> allRenames) Builds the complete set of elements to be renamed during the refactoring.
void	prepareRenaming(PsiElement element, java.lang.String newName, java.util.Map<PsiElement,java.lang.String> allRenames, SearchScope scope)
void	renameElement(PsiElement element, java.lang.String newName, UsageInfo [] usages, RefactoringElementListener listener)
void	setToSearchForTextOccurrences(PsiElement element, boolean enabled)
void	setToSearchInComments(PsiElement element, boolean enabled)
boolean	showRenamePreviewButton(PsiElement psiElement)
PsiElement	substituteElementToRename(PsiElement element, Editor editor) Returns the element to be renamed instead of the element on which the rename refactoring was invoked (for example, a super method of an inherited method).
void	substituteElementToRename(PsiElement element, Editor editor, Pass<PsiElement> renameCallback) Substitutes element to be renamed and initiate rename procedure.

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<RenamePsiElementProcessor> EP_NAME

DEFAULT

public static final RenamePsiElementProcessor DEFAULT

Constructor Detail

RenamePsiElementProcessor

public RenamePsiElementProcessor()

Method Detail

canProcessElement

public abstract boolean canProcessElement(PsiElement element)

createRenameDialog

public RenameDialog createRenameDialog(Project project,
                                       PsiElement element,
                                       PsiElement nameSuggestionContext,
                                       Editor editor)

renameElement

public void renameElement(PsiElement element,
                          java.lang.String newName,
                          UsageInfo [] usages,
                          RefactoringElementListener listener)
                   throws IncorrectOperationException

Throws:

IncorrectOperationException

findReferences

@Deprecated
public java.util.Collection<PsiReference> findReferences(PsiElement element,
                                                         boolean searchInCommentsAndStrings)

Deprecated. use findReferences(PsiElement, SearchScope, boolean) instead

findReferences

@Deprecated
public java.util.Collection<PsiReference> findReferences(PsiElement element)

Deprecated. use findReferences(PsiElement, SearchScope, boolean) instead

findReferences

public java.util.Collection<PsiReference> findReferences(PsiElement element,
                                                         SearchScope searchScope,
                                                         boolean searchInCommentsAndStrings)

getTextOccurrenceSearchStrings

public Pair<java.lang.String,java.lang.String> getTextOccurrenceSearchStrings(PsiElement element,
                                                                              java.lang.String newName)

getQualifiedNameAfterRename

public java.lang.String getQualifiedNameAfterRename(PsiElement element,
                                                    java.lang.String newName,
                                                    boolean nonJava)

prepareRenaming

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

Builds the complete set of elements to be renamed during the refactoring.

Parameters:

element - the base element for the refactoring.

newName - the name into which the element is being renamed.

allRenames - the map (from element to its new name) into which all additional elements to be renamed should be stored.

prepareRenaming

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

findExistingNameConflicts

public void findExistingNameConflicts(PsiElement element,
                                      java.lang.String newName,
                                      MultiMap<PsiElement,java.lang.String> conflicts)

findExistingNameConflicts

public void findExistingNameConflicts(PsiElement element,
                                      java.lang.String newName,
                                      MultiMap<PsiElement,java.lang.String> conflicts,
                                      java.util.Map<PsiElement,java.lang.String> allRenames)

isInplaceRenameSupported

public boolean isInplaceRenameSupported()

allForElement

public static java.util.List<RenamePsiElementProcessor> allForElement(PsiElement element)

forElement

public static RenamePsiElementProcessor forElement(PsiElement element)

getPostRenameCallback

public java.lang.Runnable getPostRenameCallback(PsiElement element,
                                                java.lang.String newName,
                                                RefactoringElementListener elementListener)

getHelpID

public java.lang.String getHelpID(PsiElement element)

isToSearchInComments

public boolean isToSearchInComments(PsiElement element)

setToSearchInComments

public void setToSearchInComments(PsiElement element,
                                  boolean enabled)

isToSearchForTextOccurrences

public boolean isToSearchForTextOccurrences(PsiElement element)

setToSearchForTextOccurrences

public void setToSearchForTextOccurrences(PsiElement element,
                                          boolean enabled)

showRenamePreviewButton

public boolean showRenamePreviewButton(PsiElement psiElement)

substituteElementToRename

public PsiElement substituteElementToRename(PsiElement element,
                                            Editor editor)

Returns the element to be renamed instead of the element on which the rename refactoring was invoked (for example, a super method of an inherited method).

Parameters:

element - the element on which the refactoring was invoked.

editor - the editor in which the refactoring was invoked.

Returns:

the element to rename, or null if the rename refactoring should be canceled.

substituteElementToRename

public void substituteElementToRename(PsiElement element,
                                      Editor editor,
                                      Pass<PsiElement> renameCallback)

Substitutes element to be renamed and initiate rename procedure. Should be used in order to prevent modal dialogs to appear during inplace rename

Parameters:

element - the element on which refactoring was invoked

editor - the editor in which inplace refactoring was invoked

renameCallback - rename procedure which should be called on the chosen substitution

findCollisions

public void findCollisions(PsiElement element,
                           java.lang.String newName,
                           java.util.Map<? extends PsiElement,java.lang.String> allRenames,
                           java.util.List<UsageInfo> result)

forcesShowPreview

public boolean forcesShowPreview()

Use this method to force showing preview for custom processors. This method is always called after prepareRenaming()

Returns:

force show preview

getElementToSearchInStringsAndComments

public PsiElement getElementToSearchInStringsAndComments(PsiElement element)

createUsageInfo

public UsageInfo createUsageInfo(PsiElement element,
                                 PsiReference ref,
                                 PsiElement referenceElement)