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

Class AbstractBatchSuppressByNoInspectionCommentFix

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

PySuppressInspectionFix, SuppressByCommentFix, SuppressFix, SuppressForMemberFix, SuppressParameterFix

public abstract class AbstractBatchSuppressByNoInspectionCommentFix
extends java.lang.Object
implements ContainerBasedSuppressQuickFix, InjectionAwareSuppressQuickFix, Iconable

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	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
AbstractBatchSuppressByNoInspectionCommentFix(java.lang.String ID, boolean replaceOtherSuppressionIds)

Method Summary

Modifier and Type	Method and Description
void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
protected void	createSuppression(Project project, PsiElement element, PsiElement container)
protected Language	getCommentLanguage(PsiElement element)
protected java.util.List<? extends PsiElement>	getCommentsFor(PsiElement container)
abstract PsiElement	getContainer(PsiElement context)
java.lang.String	getFamilyName()
javax.swing.Icon	getIcon(int flags)
java.lang.String	getName()
java.lang.String	getText()
void	invoke(Project project, PsiElement element)
boolean	isAvailable(Project project, PsiElement context)
ThreeState	isShouldBeAppliedToInjectionHost()
boolean	isSuppressAll()
protected void	replaceSuppressionComment(PsiElement comment)
protected boolean	replaceSuppressionComments(PsiElement container)
void	setShouldBeAppliedToInjectionHost(ThreeState shouldBeAppliedToInjectionHost)
protected void	setText(java.lang.String text)
java.lang.String	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

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

startInWriteAction

Field Detail

myID

protected final java.lang.String myID

Constructor Detail

AbstractBatchSuppressByNoInspectionCommentFix

public AbstractBatchSuppressByNoInspectionCommentFix(java.lang.String ID,
                                                     boolean replaceOtherSuppressionIds)

Parameters:

ID - Inspection ID

replaceOtherSuppressionIds - Merge suppression policy. If false new tool id will be append to the end otherwise replace other ids

Method Detail

getContainer

public abstract PsiElement getContainer(PsiElement context)

Specified by:

getContainer in interface ContainerBasedSuppressQuickFix

setShouldBeAppliedToInjectionHost

public void setShouldBeAppliedToInjectionHost(ThreeState shouldBeAppliedToInjectionHost)

Specified by:

setShouldBeAppliedToInjectionHost in interface InjectionAwareSuppressQuickFix

isShouldBeAppliedToInjectionHost

public ThreeState isShouldBeAppliedToInjectionHost()

Specified by:

isShouldBeAppliedToInjectionHost in interface InjectionAwareSuppressQuickFix

getName

public java.lang.String getName()

Specified by:

getName in interface QuickFix<ProblemDescriptor>

Returns:

the name of the quick fix.

getIcon

public javax.swing.Icon getIcon(int flags)

Specified by:

getIcon in interface Iconable

getText

public java.lang.String getText()

setText

protected void setText(java.lang.String text)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

isSuppressAll

public boolean isSuppressAll()

Specified by:

isSuppressAll in interface SuppressQuickFix

replaceSuppressionComment

protected final void replaceSuppressionComment(PsiElement comment)

createSuppression

protected void createSuppression(Project project,
                                 PsiElement element,
                                 PsiElement container)
                          throws IncorrectOperationException

Throws:

IncorrectOperationException

getCommentLanguage

protected Language getCommentLanguage(PsiElement element)

Parameters:

element - quickfix target or existing comment element

Returns:

language that will be used for comment creating. In common case language will be the same as language of quickfix target

isAvailable

public boolean isAvailable(Project project,
                           PsiElement context)

Specified by:

isAvailable in interface SuppressQuickFix

invoke

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

Throws:

IncorrectOperationException

replaceSuppressionComments

protected boolean replaceSuppressionComments(PsiElement container)

getCommentsFor

protected java.util.List<? extends PsiElement> getCommentsFor(PsiElement container)

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