Package com.intellij.refactoring.safeDelete

Interface SafeDeleteProcessorDelegate

All Known Implementing Classes:

JavaSafeDeleteProcessor, PropertiesFilesSafeDeleteProcessor, PropertyKeysSafeDeleteProcessor, RelatedFilesSafeDeleteProcessorDelegate, SafeDeleteProcessorDelegateBase

public interface SafeDeleteProcessorDelegate

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<SafeDeleteProcessorDelegate>	EP_NAME

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	findConflicts(PsiElement element, PsiElement [] allElementsToDelete)
NonCodeUsageSearchInfo	findUsages(PsiElement element, PsiElement [] allElementsToDelete, java.util.List<UsageInfo> result)
java.util.Collection<PsiElement>	getAdditionalElementsToDelete(PsiElement element, java.util.Collection<PsiElement> allElementsToDelete, boolean askUser)
java.util.Collection<? extends PsiElement>	getElementsToSearch(PsiElement element, java.util.Collection<PsiElement> allElementsToDelete) Called before the refactoring dialog is shown.
boolean	handlesElement(PsiElement element)
boolean	isToSearchForTextOccurrences(PsiElement element)
boolean	isToSearchInComments(PsiElement element)
void	prepareForDeletion(PsiElement element)
UsageInfo []	preprocessUsages(Project project, UsageInfo[] usages) Called after the user has confirmed the refactoring.
void	setToSearchForTextOccurrences(PsiElement element, boolean enabled)
void	setToSearchInComments(PsiElement element, boolean enabled)

Field Detail

EP_NAME

static final ExtensionPointName<SafeDeleteProcessorDelegate> EP_NAME

Method Detail

handlesElement

boolean handlesElement(PsiElement element)

findUsages

NonCodeUsageSearchInfo findUsages(PsiElement element,
                                  PsiElement [] allElementsToDelete,
                                  java.util.List<UsageInfo> result)

getElementsToSearch

java.util.Collection<? extends PsiElement> getElementsToSearch(PsiElement element,
                                                               java.util.Collection<PsiElement> allElementsToDelete)

Called before the refactoring dialog is shown. Returns the list of elements for which the usages should be searched for the specified element selected by the user for deletion. May show UI to ask the user if some additional elements should be deleted along with the specified selected element.

Parameters:

element - an element selected for deletion.

allElementsToDelete - all elements selected for deletion.

Returns:

additional elements to search for usages, or null if the user has cancelled the refactoring.

getAdditionalElementsToDelete

java.util.Collection<PsiElement> getAdditionalElementsToDelete(PsiElement element,
                                                               java.util.Collection<PsiElement> allElementsToDelete,
                                                               boolean askUser)

findConflicts

java.util.Collection<java.lang.String> findConflicts(PsiElement element,
                                                     PsiElement [] allElementsToDelete)

preprocessUsages

UsageInfo [] preprocessUsages(Project project,
                              UsageInfo[] usages)

Called after the user has confirmed the refactoring. Can filter out some of the usages found by the refactoring. May show UI to ask the user if some of the usages should be excluded.

Parameters:

project - the project where the refactoring happens.

usages - all usages to be processed by the refactoring.

Returns:

the filtered list of usages, or null if the user has cancelled the refactoring.

prepareForDeletion

void prepareForDeletion(PsiElement element)
                 throws IncorrectOperationException

Throws:

IncorrectOperationException

isToSearchInComments

boolean isToSearchInComments(PsiElement element)

setToSearchInComments

void setToSearchInComments(PsiElement element,
                           boolean enabled)

isToSearchForTextOccurrences

boolean isToSearchForTextOccurrences(PsiElement element)

setToSearchForTextOccurrences

void setToSearchForTextOccurrences(PsiElement element,
                                   boolean enabled)