Package com.intellij.codeInspection

Interface RefactoringQuickFix

All Superinterfaces:

FileModifier, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

All Known Implementing Classes:

EncapsulateVariableFix, ExtractMethodFix, IntroduceConstantFix, IntroduceVariableFix, InvertBooleanFix, MoveAnonymousToInnerClassFix, MoveClassFix, RefactoringInspectionGadgetsFix, RenameFix, RenameFix, ReplaceInheritanceWithDelegationFix

public interface RefactoringQuickFix
extends LocalQuickFix

Field Summary

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
default void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
default void	doFix(PsiElement element)
default DataContext	enhanceDataContext(DataContext context)
default PsiElement	getElementToRefactor(PsiElement element)
RefactoringActionHandler	getHandler() Usually a call to com.intellij.refactoring.RefactoringActionHandlerFactory or a language specific factory like com.intellij.refactoring.JavaRefactoringActionHandlerFactory.
default RefactoringActionHandler	getHandler(DataContext context) Override if preferred handler can be chosen based on context
default boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from interface com.intellij.codeInspection.QuickFix

getFamilyName, getName

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

getElementToMakeWritable

Method Detail

startInWriteAction

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

getHandler

RefactoringActionHandler getHandler()

Usually a call to com.intellij.refactoring.RefactoringActionHandlerFactory or a language specific factory like com.intellij.refactoring.JavaRefactoringActionHandlerFactory.

getHandler

default RefactoringActionHandler getHandler(DataContext context)

Override if preferred handler can be chosen based on context

getElementToRefactor

default PsiElement getElementToRefactor(PsiElement element)

doFix

default void doFix(PsiElement element)

applyFix

default 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

enhanceDataContext

default DataContext enhanceDataContext(DataContext context)

See Also:

SimpleDataContext