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

Class MethodArgumentFix

java.lang.Object

com.intellij.codeInsight.daemon.impl.quickfix.MethodArgumentFix

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware

Direct Known Subclasses:

AddTypeArgumentsFix, CastMethodArgumentFix, WrapObjectWithOptionalOfNullableFix

public abstract class MethodArgumentFix
extends java.lang.Object
implements IntentionAction

Field Summary

Fields

Modifier and Type	Field and Description
protected PsiExpressionList	myArgList
protected ArgumentFixerActionFactory	myArgumentFixerActionFactory
protected int	myIndex
protected PsiType	myToType

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

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MethodArgumentFix(PsiExpressionList list, int i, PsiType toType, ArgumentFixerActionFactory fixerActionFactory)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFamilyName() Returns the name of the family of intentions.
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	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.IntentionAction

getText

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

getElementToMakeWritable

Field Detail

myArgList

protected final PsiExpressionList myArgList

myIndex

protected final int myIndex

myArgumentFixerActionFactory

protected final ArgumentFixerActionFactory myArgumentFixerActionFactory

myToType

protected final PsiType myToType

Constructor Detail

MethodArgumentFix

protected MethodArgumentFix(PsiExpressionList list,
                            int i,
                            PsiType toType,
                            ArgumentFixerActionFactory fixerActionFactory)

Method Detail

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.

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.

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.

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...)