Package com.intellij.codeInspection

Class AnnotateMethodFix

java.lang.Object

com.intellij.codeInspection.AnnotateMethodFix

All Implemented Interfaces:

FileModifier, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

public class AnnotateMethodFix
extends java.lang.Object
implements LocalQuickFix

Field Summary

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
AnnotateMethodFix(java.lang.String fqn, java.lang.String... annotationsToRemove)

Method Summary

Modifier and Type	Method and Description
protected boolean	annotateOverriddenMethods()
protected boolean	annotateSelf()
void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
java.lang.String	getFamilyName()
java.lang.String	getName()
protected java.lang.String	getPreposition()
static boolean	processModifiableInheritorsUnderProgress(PsiMethod method, java.util.function.Consumer<? super PsiMethod> consumer)
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.FileModifier

getElementToMakeWritable

Constructor Detail

AnnotateMethodFix

public AnnotateMethodFix(java.lang.String fqn,
                         java.lang.String... annotationsToRemove)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface QuickFix<ProblemDescriptor>

Returns:

the name of the quick fix.

getPreposition

protected java.lang.String getPreposition()

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

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

Specified by:

startInWriteAction in interface WriteActionAware

Returns:

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

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

annotateOverriddenMethods

protected boolean annotateOverriddenMethods()

annotateSelf

protected boolean annotateSelf()

processModifiableInheritorsUnderProgress

public static boolean processModifiableInheritorsUnderProgress(PsiMethod method,
                                                               java.util.function.Consumer<? super PsiMethod> consumer)