Package com.intellij.codeInspection

Class LocalQuickFixOnPsiElement

java.lang.Object

com.intellij.codeInspection.LocalQuickFixOnPsiElement

All Implemented Interfaces:

FileModifier, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

Direct Known Subclasses:

AbstractManifestQuickFix, AddAnnotationPsiFix, AutoImportQuickFix, DeleteUnusedElementBase, LocalQuickFixAndIntentionActionOnPsiElement, MethodThrowsFix, NullableStuffInspection.NavigateToNullLiteralArguments, PyChangeSignatureQuickFix, PyImplementMethodsQuickFix, SimplifyBooleanExpressionFix, VariableArrayTypeFix

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG
protected SmartPsiElementPointer<PsiElement>	myEndElement
protected SmartPsiElementPointer<PsiElement>	myStartElement

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalQuickFixOnPsiElement(PsiElement element)
	LocalQuickFixOnPsiElement(PsiElement startElement, PsiElement endElement)

Method Summary

Modifier and Type	Method and Description
void	applyFix()
void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
PsiElement	getEndElement()
java.lang.String	getName()
PsiElement	getStartElement()
abstract java.lang.String	getText()
abstract void	invoke(Project project, PsiFile file, PsiElement startElement, PsiElement endElement)
protected boolean	isAvailable()
boolean	isAvailable(Project project, PsiFile file, PsiElement startElement, PsiElement endElement)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInspection.QuickFix

getFamilyName

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

getElementToMakeWritable

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

startInWriteAction

Field Detail

LOG

protected static final Logger LOG

myStartElement

protected final SmartPsiElementPointer<PsiElement> myStartElement

myEndElement

protected final SmartPsiElementPointer<PsiElement> myEndElement

Constructor Detail

LocalQuickFixOnPsiElement

protected LocalQuickFixOnPsiElement(PsiElement element)

LocalQuickFixOnPsiElement

public LocalQuickFixOnPsiElement(PsiElement startElement,
                                 PsiElement endElement)

Method Detail

getName

public final java.lang.String getName()

Specified by:

getName in interface QuickFix<ProblemDescriptor>

Returns:

the name of the quick fix.

isAvailable

public boolean isAvailable(Project project,
                           PsiFile file,
                           PsiElement startElement,
                           PsiElement endElement)

isAvailable

protected boolean isAvailable()

getStartElement

public PsiElement getStartElement()

getEndElement

public PsiElement getEndElement()

getText

public abstract java.lang.String getText()

applyFix

public final 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

applyFix

public void applyFix()

invoke

public abstract void invoke(Project project,
                            PsiFile file,
                            PsiElement startElement,
                            PsiElement endElement)