Package com.intellij.refactoring.util.duplicates

Class MethodDuplicatesHandler

java.lang.Object

com.intellij.refactoring.util.duplicates.MethodDuplicatesHandler

All Implemented Interfaces:

ContextAwareActionHandler, RefactoringActionHandler

public class MethodDuplicatesHandler
extends java.lang.Object
implements RefactoringActionHandler, ContextAwareActionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REFACTORING_NAME Deprecated. Use getRefactoringName() instead

Constructor Summary

Constructors

Constructor and Description
MethodDuplicatesHandler()

Method Summary

Modifier and Type	Method and Description
static DuplicatesFinder	createDuplicatesFinder(PsiMember member)
static java.lang.String	getRefactoringName()
static java.util.List<Match>	hasDuplicates(PsiElement file, PsiMember member)
void	invoke(Project project, Editor editor, PsiFile file, DataContext dataContext) Invokes refactoring action from editor.
void	invoke(Project project, PsiElement [] elements, DataContext dataContext) Invokes refactoring action from elsewhere (not from editor).
static void	invokeOnScope(Project project, PsiMember member, AnalysisScope scope)
static void	invokeOnScope(Project project, java.util.Set<? extends PsiMember> members, AnalysisScope scope, boolean silent)
boolean	isAvailableForQuickList(Editor editor, PsiFile file, DataContext dataContext) Handlers could provide useful hints when they are actually not available, e.g.
static void	replaceDuplicate(Project project, java.util.Map<PsiMember,java.util.List<Match>> duplicates, java.util.Set<? extends PsiMember> methods)

Methods inherited from class java.lang.Object

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

Field Detail

REFACTORING_NAME

@Deprecated
public static final java.lang.String REFACTORING_NAME

Deprecated. Use getRefactoringName() instead

See Also:

Constant Field Values

Constructor Detail

MethodDuplicatesHandler

public MethodDuplicatesHandler()

Method Detail

isAvailableForQuickList

public boolean isAvailableForQuickList(Editor editor,
                                       PsiFile file,
                                       DataContext dataContext)

Description copied from interface: ContextAwareActionHandler

Handlers could provide useful hints when they are actually not available, e.g. 'No methods to implement', 'Selected block should represent ...', 'Caret should be positioned at the name of ...', etc. At the same time, when the action is invoked through refactorings quick list popup, generate popup or in another manner but not through main menu (shortcut or find action are treated the same), it's better to hide the action: it would pollute menu with one more choice but can't do anything.

Specified by:

isAvailableForQuickList in interface ContextAwareActionHandler

Returns:

It's assumed that handler is valid for file. Still should be lightweight, because is invoked from action update. false - if action won't proceed

invoke

public void invoke(Project project,
                   Editor editor,
                   PsiFile file,
                   DataContext dataContext)

Description copied from interface: RefactoringActionHandler

Invokes refactoring action from editor. The refactoring obtains all data from editor selection.

Specified by:

invoke in interface RefactoringActionHandler

Parameters:

project - the project in which the refactoring is invoked.

editor - editor that refactoring is invoked in

file - file should correspond to editor

dataContext - can be null for some but not all of refactoring action handlers (it is recommended to pass DataManager.getDataContext() instead of null)

invokeOnScope

public static void invokeOnScope(Project project,
                                 PsiMember member,
                                 AnalysisScope scope)

invokeOnScope

public static void invokeOnScope(Project project,
                                 java.util.Set<? extends PsiMember> members,
                                 AnalysisScope scope,
                                 boolean silent)

replaceDuplicate

public static void replaceDuplicate(Project project,
                                    java.util.Map<PsiMember,java.util.List<Match>> duplicates,
                                    java.util.Set<? extends PsiMember> methods)

hasDuplicates

public static java.util.List<Match> hasDuplicates(PsiElement file,
                                                  PsiMember member)

createDuplicatesFinder

public static DuplicatesFinder createDuplicatesFinder(PsiMember member)

invoke

public void invoke(Project project,
                   PsiElement [] elements,
                   DataContext dataContext)

Description copied from interface: RefactoringActionHandler

Invokes refactoring action from elsewhere (not from editor). Some refactorings do not implement this method.

Specified by:

invoke in interface RefactoringActionHandler

Parameters:

project - the project in which the refactoring is invoked.

elements - list of elements that refactoring should work on. Refactoring-dependent.

dataContext - can be null for some but not all of refactoring action handlers (it is recommended to pass DataManager.getDataContext() instead of null)

getRefactoringName

public static java.lang.String getRefactoringName()