Package com.intellij.refactoring.typeMigration.inspections

Class GuavaInspection.MigrateGuavaTypeFix

java.lang.Object

com.intellij.codeInspection.LocalQuickFixOnPsiElement

com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement

com.intellij.refactoring.typeMigration.inspections.GuavaInspection.MigrateGuavaTypeFix

All Implemented Interfaces:

FileModifier, IntentionAction, BatchQuickFix<CommonProblemDescriptor>, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

Enclosing class:

GuavaInspection

public class GuavaInspection.MigrateGuavaTypeFix
extends LocalQuickFixAndIntentionActionOnPsiElement
implements BatchQuickFix<CommonProblemDescriptor>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FAMILY_NAME

Fields inherited from class com.intellij.codeInspection.LocalQuickFixOnPsiElement

LOG, myEndElement, myStartElement

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

EMPTY_ARRAY

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
void	applyFix(Project project, CommonProblemDescriptor [] descriptors, java.util.List<PsiElement> psiElementsToIgnore, java.lang.Runnable refreshViews) Called to apply the cumulative fix.
java.lang.String	getFamilyName() Returns the name of the family of intentions.
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
void	invoke(Project project, PsiFile file, Editor editor, PsiElement startElement, PsiElement endElement) Performs the action.
protected boolean	isAvailable()
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement

invoke, invoke, isAvailable, isAvailable

Methods inherited from class com.intellij.codeInspection.LocalQuickFixOnPsiElement

applyFix, applyFix, getEndElement, getName, getStartElement, isAvailable

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

Field Detail

FAMILY_NAME

public static final java.lang.String FAMILY_NAME

See Also:

Constant Field Values

Method Detail

invoke

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

Description copied from class: LocalQuickFixAndIntentionActionOnPsiElement

Performs the action.

Specified by:

invoke in class LocalQuickFixAndIntentionActionOnPsiElement

editor - the editor where the action is invoked or null if it's invoked from batch inspections results' tool window.

isAvailable

protected boolean isAvailable()

Overrides:

isAvailable in class LocalQuickFixOnPsiElement

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

Specified by:

getText in class LocalQuickFixOnPsiElement

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

Specified by:

getFamilyName in interface QuickFix<ProblemDescriptor>

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

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

Overrides:

startInWriteAction in class LocalQuickFixAndIntentionActionOnPsiElement

Returns:

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

applyFix

public void applyFix(Project project,
                     CommonProblemDescriptor [] descriptors,
                     java.util.List<PsiElement> psiElementsToIgnore,
                     java.lang.Runnable refreshViews)

Description copied from interface: BatchQuickFix

Called to apply the cumulative fix. Is invoked in WriteAction

Specified by:

applyFix in interface BatchQuickFix<CommonProblemDescriptor>

Parameters:

project - Project

descriptors - problem reported by the tool on which fix should work

psiElementsToIgnore - elements to be excluded from view during post-refresh

refreshViews - post-refresh inspection results view; would remove collected elements from the view