Package com.intellij.refactoring.move.moveClassesOrPackages

Class MoveJavaFileHandler

java.lang.Object

com.intellij.refactoring.move.moveFilesOrDirectories.MoveFileHandler

com.intellij.refactoring.move.moveClassesOrPackages.MoveJavaFileHandler

public class MoveJavaFileHandler
extends MoveFileHandler

Constructor Summary

Constructors

Constructor and Description
MoveJavaFileHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canProcessElement(PsiFile element) Checks whether a file can be handled by this move handler.
java.util.List<UsageInfo>	findUsages(PsiFile psiFile, PsiDirectory newParent, boolean searchInComments, boolean searchInNonJavaFiles) Finds the list of references to the file being moved that will need to be updated during the move refactoring.
void	prepareMovedFile(PsiFile file, PsiDirectory moveDestination, java.util.Map<PsiElement,PsiElement> oldToNewMap) Performs any necessary modifications of the file contents before the move.
void	retargetUsages(java.util.List<UsageInfo> usageInfos, java.util.Map<PsiElement,PsiElement> oldToNewMap) After a file has been moved, updates the references to the file so that they point to the new location of the file.
void	updateMovedFile(PsiFile file) Updates the contents of the file after it has been moved (e.g.

Methods inherited from class com.intellij.refactoring.move.moveFilesOrDirectories.MoveFileHandler

forElement

Methods inherited from class java.lang.Object

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

Constructor Detail

MoveJavaFileHandler

public MoveJavaFileHandler()

Method Detail

canProcessElement

public boolean canProcessElement(PsiFile element)

Description copied from class: MoveFileHandler

Checks whether a file can be handled by this move handler.

Specified by:

canProcessElement in class MoveFileHandler

Parameters:

element - the file being moved.

Returns:

true if this handler can handle this file, false otherwise.

prepareMovedFile

public void prepareMovedFile(PsiFile file,
                             PsiDirectory moveDestination,
                             java.util.Map<PsiElement,PsiElement> oldToNewMap)

Description copied from class: MoveFileHandler

Performs any necessary modifications of the file contents before the move.

Specified by:

prepareMovedFile in class MoveFileHandler

Parameters:

file - the file being moved.

moveDestination - the directory to which the file is being moved.

oldToNewMap - the map of elements which can be referenced from other files directly (not through a file reference) to their counterparts after the move. The handler needs to add elements to this map according to the file modifications that it has performed.

findUsages

public java.util.List<UsageInfo> findUsages(PsiFile psiFile,
                                            PsiDirectory newParent,
                                            boolean searchInComments,
                                            boolean searchInNonJavaFiles)

Description copied from class: MoveFileHandler

Finds the list of references to the file being moved that will need to be updated during the move refactoring.

Specified by:

findUsages in class MoveFileHandler

Parameters:

psiFile - the file being moved.

newParent - the directory to which the file is being moved.

searchInComments - if true, search for references in comments has been requested.

searchInNonJavaFiles - if true, search for references in non-code files (such as .xml) has been requested.

Returns:

the list of usages that need to be updated, or null if nothing needs to be updated.

retargetUsages

public void retargetUsages(java.util.List<UsageInfo> usageInfos,
                           java.util.Map<PsiElement,PsiElement> oldToNewMap)

Description copied from class: MoveFileHandler

After a file has been moved, updates the references to the file so that they point to the new location of the file.

Specified by:

retargetUsages in class MoveFileHandler

Parameters:

usageInfos - the list of references, as returned from MoveFileHandler.findUsages(com.intellij.psi.PsiFile, com.intellij.psi.PsiDirectory, boolean, boolean)

oldToNewMap - the map of all moved elements, filled by MoveFileHandler.prepareMovedFile(com.intellij.psi.PsiFile, com.intellij.psi.PsiDirectory, java.util.Map<com.intellij.psi.PsiElement, com.intellij.psi.PsiElement>)

updateMovedFile

public void updateMovedFile(PsiFile file)
                     throws IncorrectOperationException

Description copied from class: MoveFileHandler

Updates the contents of the file after it has been moved (e.g. updates the package statement to correspond to the new location of a Java class).

Specified by:

updateMovedFile in class MoveFileHandler

Parameters:

file - the moved file.

Throws:

IncorrectOperationException