Package com.intellij.codeInspection

Class ExternalAnnotatorInspectionVisitor.LocalQuickFixBackedByIntentionAction

java.lang.Object

com.intellij.codeInspection.ExternalAnnotatorInspectionVisitor.LocalQuickFixBackedByIntentionAction

All Implemented Interfaces:

FileModifier, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware, Iconable

Enclosing class:

ExternalAnnotatorInspectionVisitor

public static class ExternalAnnotatorInspectionVisitor.LocalQuickFixBackedByIntentionAction
extends java.lang.Object
implements LocalQuickFix, Iconable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Constructor Summary

Constructors

Constructor and Description
LocalQuickFixBackedByIntentionAction(IntentionAction action)

Method Summary

Modifier and Type	Method and Description
void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
boolean	equals(java.lang.Object o)
PsiElement	getElementToMakeWritable(PsiFile file) Controls whether this intention/fix is going to modify the current file.
java.lang.String	getFamilyName()
javax.swing.Icon	getIcon(int flags)
java.lang.String	getName()
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.application.WriteActionAware

startInWriteAction

Constructor Detail

LocalQuickFixBackedByIntentionAction

public LocalQuickFixBackedByIntentionAction(IntentionAction action)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface QuickFix<ProblemDescriptor>

Returns:

the name of the quick fix.

getFamilyName

public java.lang.String getFamilyName()

Specified by:

getFamilyName in interface QuickFix<ProblemDescriptor>

Returns:

text to appear in "Apply Fix" popup when multiple Quick Fixes exist (in the results of batch code inspection). For example, if the name of the quickfix is "Create template <filename>", the return value of getFamilyName() should be "Create template". If the name of the quickfix does not depend on a specific element, simply return QuickFix.getName().

applyFix

public void applyFix(Project project,
                     ProblemDescriptor descriptor)

Description copied from interface: QuickFix

Called to apply the fix.

Please call com.intellij.profile.codeInspection.ProjectInspectionProfileManager#fireProfileChanged() if inspection profile is changed as result of fix.

Specified by:

applyFix in interface QuickFix<ProblemDescriptor>

Parameters:

project - Project

descriptor - problem reported by the tool which provided this quick fix action

getElementToMakeWritable

public PsiElement getElementToMakeWritable(PsiFile file)

Description copied from interface: FileModifier

Controls whether this intention/fix is going to modify the current file. If @NotNull, and the current file is read-only, it will be made writable (honoring version control integration) before the intention/fix is invoked.

By default, as a heuristic, returns the same as WriteActionAware.startInWriteAction().

If the action is going to modify multiple files, or the set of the files is unknown in advance, please don't bother overriding this method, return false from WriteActionAware.startInWriteAction(), and call FileModificationService methods in the implementation, and take write actions yourself as needed.

Specified by:

getElementToMakeWritable in interface FileModifier

Parameters:

file - the same file where intention would be invoked (for LocalQuickFix it would be the containing file of ProblemDescriptor.getPsiElement())

getIcon

public javax.swing.Icon getIcon(int flags)

Specified by:

getIcon in interface Iconable

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object