Package com.intellij.codeInsight.daemon.impl.quickfix

Class ChangeMethodSignatureFromUsageFix

java.lang.Object

com.intellij.codeInsight.daemon.impl.quickfix.ChangeMethodSignatureFromUsageFix

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware

Direct Known Subclasses:

ChangeMethodSignatureFromUsageReverseOrderFix

public class ChangeMethodSignatureFromUsageFix
extends java.lang.Object
implements IntentionAction

Field Summary

Fields inherited from interface com.intellij.codeInsight.intention.IntentionAction

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ChangeMethodSignatureFromUsageFix(PsiMethod targetMethod, PsiExpression [] expressions, PsiSubstitutor substitutor, PsiElement context, boolean changeAllUsages, int minUsagesNumberToShowDialog)

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	escapePresentableType(PsiType exprType)
protected boolean	findNewParamsPlace(PsiExpression[] expressions, PsiMethod targetMethod, PsiSubstitutor substitutor, java.lang.StringBuilder buf, java.util.HashSet<? super ParameterInfoImpl> newParams, PsiParameter[] parameters, java.util.List<? super ParameterInfoImpl> result)
java.lang.String	getFamilyName() Returns the name of the family of intentions.
static java.lang.String	getNewParameterNameByOldIndex(int oldIndex, ParameterInfoImpl[] parametersInfo)
protected ParameterInfoImpl []	getNewParametersInfo(PsiExpression[] expressions, PsiMethod targetMethod, PsiSubstitutor substitutor)
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
void	invoke(Project project, Editor editor, PsiFile file) Called when user invokes intention.
boolean	isAvailable(Project project, Editor editor, PsiFile file) Checks whether this intention is available at a caret offset in the file.
boolean	isMethodSignatureExists()
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInsight.intention.FileModifier

getElementToMakeWritable

Constructor Detail

ChangeMethodSignatureFromUsageFix

public ChangeMethodSignatureFromUsageFix(PsiMethod targetMethod,
                                         PsiExpression [] expressions,
                                         PsiSubstitutor substitutor,
                                         PsiElement context,
                                         boolean changeAllUsages,
                                         int minUsagesNumberToShowDialog)

Method Detail

getText

public java.lang.String getText()

Description copied from interface: IntentionAction

Returns text to be shown in the list of available actions, if this action is available.

Specified by:

getText in interface IntentionAction

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)

getFamilyName

public java.lang.String getFamilyName()

Description copied from interface: IntentionAction

Returns the name of the family of intentions. It is used to externalize "auto-show" state of intentions. When the user clicks on a light bulb in intention list, all intentions with the same family name get enabled/disabled. The name is also shown in settings tree.

Specified by:

getFamilyName in interface IntentionAction

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

isAvailable

public boolean isAvailable(Project project,
                           Editor editor,
                           PsiFile file)

Description copied from interface: IntentionAction

Checks whether this intention is available at a caret offset in the file. If this method returns true, a light bulb for this intention is shown.

Specified by:

isAvailable in interface IntentionAction

Parameters:

project - the project in which the availability is checked.

editor - the editor in which the intention will be invoked.

file - the file open in the editor.

Returns:

true if the intention is available, false otherwise.

isMethodSignatureExists

public boolean isMethodSignatureExists()

invoke

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

Description copied from interface: IntentionAction

Called when user invokes intention. This method is called inside command. If IntentionAction.startInWriteAction() returns true, this method is also called inside write action.

Specified by:

invoke in interface IntentionAction

Parameters:

project - the project in which the intention is invoked.

editor - the editor in which the intention is invoked.

file - the file open in the editor.

getNewParameterNameByOldIndex

public static java.lang.String getNewParameterNameByOldIndex(int oldIndex,
                                                             ParameterInfoImpl[] parametersInfo)

getNewParametersInfo

protected ParameterInfoImpl [] getNewParametersInfo(PsiExpression[] expressions,
                                                    PsiMethod targetMethod,
                                                    PsiSubstitutor substitutor)

escapePresentableType

protected static java.lang.String escapePresentableType(PsiType exprType)

findNewParamsPlace

protected boolean findNewParamsPlace(PsiExpression[] expressions,
                                     PsiMethod targetMethod,
                                     PsiSubstitutor substitutor,
                                     java.lang.StringBuilder buf,
                                     java.util.HashSet<? super ParameterInfoImpl> newParams,
                                     PsiParameter[] parameters,
                                     java.util.List<? super ParameterInfoImpl> result)

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: IntentionAction

Indicate whether this action should be invoked inside write action. Should return false if, e.g., a modal dialog is shown inside the action. If false is returned the action itself is responsible for starting write action when needed, by calling Application.runWriteAction(Runnable).

Specified by:

startInWriteAction in interface IntentionAction

Specified by:

startInWriteAction in interface WriteActionAware

Returns:

true if the intention requires a write action, false otherwise.