Package com.intellij.codeInspection

Class LocalQuickFixBase

java.lang.Object

com.intellij.codeInspection.LocalQuickFixBase

All Implemented Interfaces:

FileModifier, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

Direct Known Subclasses:

BaseCommitMessageInspection.BaseCommitMessageQuickFix

public abstract class LocalQuickFixBase
extends java.lang.Object
implements LocalQuickFix

Field Summary

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalQuickFixBase(java.lang.String name)
protected	LocalQuickFixBase(java.lang.String name, java.lang.String familyName)

Method Summary

Modifier and Type	Method and Description
abstract void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
java.lang.String	getFamilyName()
java.lang.String	getName()

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

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

startInWriteAction

Constructor Detail

LocalQuickFixBase

protected LocalQuickFixBase(java.lang.String name)

Parameters:

name - the name of the quick fix

LocalQuickFixBase

protected LocalQuickFixBase(java.lang.String name,
                            java.lang.String familyName)

Parameters:

name - the name of the quick fix

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

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 abstract 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