Package com.intellij.codeInsight.daemon.impl.actions

Class SuppressFix

java.lang.Object

com.intellij.codeInsight.daemon.impl.actions.AbstractBatchSuppressByNoInspectionCommentFix

com.intellij.codeInsight.daemon.impl.actions.SuppressFix

All Implemented Interfaces:

FileModifier, ContainerBasedSuppressQuickFix, InjectionAwareSuppressQuickFix, LocalQuickFix, QuickFix<ProblemDescriptor>, SuppressQuickFix, WriteActionAware, Iconable

Direct Known Subclasses:

SuppressAllForClassFix, SuppressForClassFix

public class SuppressFix
extends AbstractBatchSuppressByNoInspectionCommentFix

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.codeInsight.daemon.impl.actions.AbstractBatchSuppressByNoInspectionCommentFix

myID

Fields inherited from interface com.intellij.codeInspection.SuppressQuickFix

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
SuppressFix(HighlightDisplayKey key)
SuppressFix(java.lang.String ID)

Method Summary

Modifier and Type	Method and Description
PsiJavaDocumentedElement	getContainer(PsiElement context)
java.lang.String	getFamilyName()
java.lang.String	getText()
void	invoke(Project project, PsiElement element)
boolean	isAvailable(Project project, PsiElement context)
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.
protected boolean	use15Suppressions(PsiJavaDocumentedElement container)

Methods inherited from class com.intellij.codeInsight.daemon.impl.actions.AbstractBatchSuppressByNoInspectionCommentFix

applyFix, createSuppression, getCommentLanguage, getCommentsFor, getIcon, getName, isShouldBeAppliedToInjectionHost, isSuppressAll, replaceSuppressionComment, replaceSuppressionComments, setShouldBeAppliedToInjectionHost, setText, toString

Methods inherited from class java.lang.Object

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

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

getElementToMakeWritable

Constructor Detail

SuppressFix

public SuppressFix(HighlightDisplayKey key)

SuppressFix

public SuppressFix(java.lang.String ID)

Method Detail

getText

public java.lang.String getText()

Overrides:

getText in class AbstractBatchSuppressByNoInspectionCommentFix

getContainer

public PsiJavaDocumentedElement getContainer(PsiElement context)

Specified by:

getContainer in interface ContainerBasedSuppressQuickFix

Specified by:

getContainer in class AbstractBatchSuppressByNoInspectionCommentFix

isAvailable

public boolean isAvailable(Project project,
                           PsiElement context)

Specified by:

isAvailable in interface SuppressQuickFix

Overrides:

isAvailable in class AbstractBatchSuppressByNoInspectionCommentFix

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: WriteActionAware

Indicate whether this action should be invoked inside write action.

Should return false if e.g. 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).

Returns:

true if the action requires a write action (default), false otherwise.

invoke

public void invoke(Project project,
                   PsiElement element)
            throws IncorrectOperationException

Overrides:

invoke in class AbstractBatchSuppressByNoInspectionCommentFix

Throws:

IncorrectOperationException

getFamilyName

public java.lang.String getFamilyName()

Specified by:

getFamilyName in interface QuickFix<ProblemDescriptor>

Overrides:

getFamilyName in class AbstractBatchSuppressByNoInspectionCommentFix

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

use15Suppressions

protected boolean use15Suppressions(PsiJavaDocumentedElement container)