Package com.intellij.refactoring.safeDelete

Class RelatedFilesSafeDeleteProcessorDelegate

java.lang.Object

com.intellij.refactoring.safeDelete.RelatedFilesSafeDeleteProcessorDelegate

All Implemented Interfaces:

SafeDeleteProcessorDelegate

public class RelatedFilesSafeDeleteProcessorDelegate
extends java.lang.Object
implements SafeDeleteProcessorDelegate

According to NestingTreeStructureProvider some files in the Project View are shown as children of another peer file. When going to delete such 'parent' file RelatedFilesSafeDeleteProcessorDelegate suggests to delete child files as well. Example: when deleting foo.ts file user is suggested to delete generated foo.js and foo.js.map files as well.

Field Summary

Fields inherited from interface com.intellij.refactoring.safeDelete.SafeDeleteProcessorDelegate

EP_NAME

Constructor Summary

Constructors

Constructor and Description
RelatedFilesSafeDeleteProcessorDelegate()

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatedFilesSafeDeleteProcessorDelegate

public RelatedFilesSafeDeleteProcessorDelegate()

Method Detail

handlesElement

public boolean handlesElement(PsiElement element)

Specified by:

handlesElement in interface SafeDeleteProcessorDelegate

getAdditionalElementsToDelete

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

Specified by:

getAdditionalElementsToDelete in interface SafeDeleteProcessorDelegate

findUsages

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

Specified by:

findUsages in interface SafeDeleteProcessorDelegate

getElementsToSearch

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

Description copied from interface: SafeDeleteProcessorDelegate

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.

Specified by:

getElementsToSearch in interface SafeDeleteProcessorDelegate

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.

findConflicts

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

Specified by:

findConflicts in interface SafeDeleteProcessorDelegate

preprocessUsages

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

Description copied from interface: SafeDeleteProcessorDelegate

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.

Specified by:

preprocessUsages in interface SafeDeleteProcessorDelegate

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

public void prepareForDeletion(PsiElement element)
                        throws IncorrectOperationException

Specified by:

prepareForDeletion in interface SafeDeleteProcessorDelegate

Throws:

IncorrectOperationException

isToSearchInComments

public boolean isToSearchInComments(PsiElement element)

Specified by:

isToSearchInComments in interface SafeDeleteProcessorDelegate

isToSearchForTextOccurrences

public boolean isToSearchForTextOccurrences(PsiElement element)

Specified by:

isToSearchForTextOccurrences in interface SafeDeleteProcessorDelegate

setToSearchInComments

public void setToSearchInComments(PsiElement element,
                                  boolean enabled)

Specified by:

setToSearchInComments in interface SafeDeleteProcessorDelegate

setToSearchForTextOccurrences

public void setToSearchForTextOccurrences(PsiElement element,
                                          boolean enabled)

Specified by:

setToSearchForTextOccurrences in interface SafeDeleteProcessorDelegate