Package com.intellij.codeInspection

Interface QuickFix<D extends CommonProblemDescriptor>

All Superinterfaces:

WriteActionAware

All Known Subinterfaces:

ContainerBasedSuppressQuickFix, InjectionAwareSuppressQuickFix, LocalQuickFix, RefactoringQuickFix, SpellCheckerQuickFix, SuppressQuickFix

All Known Implementing Classes:

AbstractBatchSuppressByNoInspectionCommentFix, AbstractCreateFileFix, AbstractManifestQuickFix, AcceptWordAsCorrect, AccessStaticViaInstanceFix, AddAnnotationAttributeNameFix, AddAnnotationFix, AddAnnotationPsiFix, AddArgumentFix, AddAssertStatementFix, AddAttributeValueIntentionFix, AddCallSuperQuickFix, AddClassToExtendsFix, AddConstructorFix, AddCustomHtmlElementIntentionAction, AddDefaultConstructorFix, AddDomElementQuickFix, AddDtdDeclarationFix, AddEmptyRecordHeaderFix, AddEncodingQuickFix, AddFieldQuickFix, AddFunctionQuickFix, AddGlobalQuickFix, AddHtmlTagOrAttributeToCustomsIntention, AddIgnoredIdentifierQuickFix, AddIgnoredRoleFix, AddMethodFix, AddMethodFix, AddMethodQuickFix, AddMissingPropertyFix, AddNotNullAnnotationFix, AddNullableAnnotationFix, AddNullableNotNullAnnotationFix, AddParameterListFix, AddSelfQuickFix, AddSerialVersionUIDFix, AddThisQualifierFix, AddTypeCastFix, AddVariableInitializerFix, AdjustFunctionContextFix, AdjustPackageNameFix, AnnotateMethodFix, AnnotateOverriddenMethodParameterFix, AntChangeContextLocalFix, AntCreatePropertyFix, AntCreateTargetFix, AugmentedAssignmentQuickFix, AutoImportHintAction, AutoImportQuickFix, BaseCommitMessageInspection.BaseCommitMessageQuickFix, BaseCommitMessageInspection.ReformatCommitMessageQuickFix, BaseConvertToLocalQuickFix, BaseSwitchFix, BodyLimitInspection.WrapLineQuickFix, ChainedComparisonsQuickFix, ChangeExtendsToImplementsFix, ChangeModifierFix, ChangeParameterClassFix, ChangeSuperClassFix, ChangeTo, CheckTagEmptyBodyInspection.Fix, CollapseAnnotationsFix, CollapseTagIntention, ComparisonWithNoneQuickFix, CompatibilityPrintCallQuickFix, ConvertDictCompQuickFix, ConvertDocstringQuickFix, ConvertIndentsFix, ConvertSetLiteralQuickFix, ConvertToVarargsMethodFix, CreateClassOrPackageFix, CreateClassQuickFix, CreateDefaultBranchFix, CreateDirectoryPathFix, CreateFieldFromConstructorLabelFix, CreateFieldOrPropertyFix, CreateFileFix, CreateFilePathFix, CreateMethodQuickFix, CreateMissingSwitchBranchesFix, CreateNSDeclarationIntentionFix, CreatePropertyFix, CreateStaticMethodQuickFix, CreateTemplateFix, DefineAttributeQuickFix, DelegatingFix, DeleteCatchSectionFix, DeleteElementFix, DeleteImportFix, DeleteReturnFix, DeleteSideEffectsAwareFix, DeleteSwitchLabelFix, DeleteUnnecessaryStatementFix, DeleteUnusedElementBase, DeleteUnusedParameterFix, DeleteUnusedVariableFix, DictCreationQuickFix, DisableInspectionToolAction, DocstringQuickFix, DownloadResourceFix, DynamicPropertyFix, DynamicPropertyFromLabelFix, DynamicPropertyFromRefFix, EncapsulateVariableFix, EqualityToEqualsFix, EqualityToSafeEqualsFix, EqualsToEqualityFix, ExtendsListFix, ExternalAnnotatorInspectionVisitor.LocalQuickFixBackedByIntentionAction, ExtractMethodFix, ExtractParameterAsLocalVariableFix, FindDfaProblemCauseFix, GenerateBinaryStubsFix, GenerateToStringQuickFix, GenerifyFileFix, GrCastFix, GrChangeVariableType, GrModifierFix, GrMoveToDirFix, GroovyFix, GrPackageInspection.ChangePackageQuickFix, GrRemoveModifierFix, GrReplacePrimitiveTypeWithWrapperFix, GuavaInspection.MigrateGuavaTypeFix, I18nizeBatchQuickFix, I18nizeConcatenationQuickFix, I18nizeFormBatchFix, I18nizeQuickFix, IgnoreClassFix, IgnoreFileRemoveEntryFix, ImplementAbstractClassMethodsFix, ImplementMethodsFix, IncreaseLanguageLevelFix, InitializeFinalFieldInConstructorFix, InlineGetterSetterCallFix, InlineVariableFix, InsertRequiredAttributeFix, InspectionGadgetsFix, IntentionAndQuickFixAction, IntentionWrapper, IntroduceConstantFix, IntroduceVariableFix, InvertBooleanFix, JavaCreatePropertyFix, JavaStylePropertiesInvocationFixer, ListCreationQuickFix, LocalQuickFixAndIntentionActionOnPsiElement, LocalQuickFixBase, LocalQuickFixOnPsiElement, MakeClassFinalFix, MakeClassInterfaceFix, MakeFieldFinalFix, MakeFieldStaticFinalFix, MakeInitializerExplicitFix, MakeMethodFinalFix, MakeTypeExplicitFix, MakeVoidQuickFix, MergeModuleStatementsFix, MergePackageAccessibilityStatementsFix, MergeProvidesStatementsFix, MethodParameterFix, MethodReturnTypeFix, MethodThrowsFix, MethodThrowsFix.Add, MethodThrowsFix.Remove, MethodThrowsFix.RemoveFirst, MigrateAssertToMatcherAssertInspection.MyQuickFix, ModifierFix, MoveAnonymousToInnerClassFix, MoveBoundClassToFrontFix, MoveClassFix, MoveFromFutureImportQuickFix, MoveToPackageFix, NormalizeDeclarationFix, NullableStuffInspection.NavigateToNullLiteralArguments, ObviousNullCheckInspection.RemoveExcessiveNullComparisonFix, ObviousNullCheckInspection.RemoveNullCheckFix, OptimizeImportsQuickFix, OrderEntryFix, ParameterCanBeLocalInspection.ConvertParameterToLocalQuickFix, PriorityActionWrapper, PullAsAbstractUpFix, PyAddExceptionSuperClassQuickFix, PyAddImportFix, PyAddPropertyForFieldQuickFix, PyAddSpecifierToFormatQuickFix, PyChangeBaseClassQuickFix, PyChangeSignatureQuickFix, PyConvertToNewStyleQuickFix, PyCreatePropertyQuickFix, PyDefaultArgumentQuickFix, PyImplementMethodsQuickFix, PyInterpreterInspection.ConfigureInterpreterFix, PyInterpreterInspection.InterpreterSettingsQuickFix, PyMakeFunctionFromMethodQuickFix, PyMakeFunctionReturnTypeQuickFix, PyMakeMethodStaticQuickFix, PyMakePublicQuickFix, PyMoveAttributeToInitQuickFix, PyMoveExceptQuickFix, PyPackageRequirementsInspection.InstallAndImportQuickFix, PyPackageRequirementsInspection.PyGenerateRequirementsFileQuickFix, PyPackageRequirementsInspection.PyInstallRequirementsFix, PyPsiPep8NamingInspection.IgnoreErrorFix, PyRemoveArgumentQuickFix, PyRemoveAssignmentQuickFix, PyRemoveCallQuickFix, PyRemoveDictKeyQuickFix, PyRemoveParameterQuickFix, PyRemoveStatementQuickFix, PyRemoveUnderscoresInNumericLiteralsQuickFix, PyRenameArgumentQuickFix, PyRenameElementQuickFix, PyRenameUnresolvedRefQuickFix, PyReplaceTupleWithListQuickFix, PySuppressInspectionFix, PyUpdatePropertySignatureQuickFix, PyWrapInExceptionQuickFix, RedundantInstanceofFix, RedundantParenthesesQuickFix, RefactoringInspectionGadgetsFix, ReformatFix, RemoveAnnotationQuickFix, RemoveArgumentEqualDefaultQuickFix, RemoveAssignmentFix, RemoveAttributeIntentionFix, RemoveDecoratorQuickFix, RemoveDomElementQuickFix, RemoveElementQuickFix, RemoveElementQuickFix, RemoveExplicitConversionFix, RemoveExtraClosingTagIntentionAction, RemoveInitializerFix, RemoveModifierFix, RemovePrefixQuickFix, RemoveProhibitedPropertyFix, RemovePropertyLocalFix, RemoveRedundantConversionFix, RemoveRedundantPolyadicOperandFix, RemoveSuppressWarningAction, RemoveTagIntentionFix, RemoveTrailingBlankLinesFix, RemoveTrailingSemicolonQuickFix, RemoveTrailingSuffixQuickFix, RemoveTypeArgumentsFix, RemoveUnnecessaryBackslashQuickFix, RemoveUnusedParameterFix, RenameElementFix, RenameFileFix, RenameFix, RenameFix, RenameParameterQuickFix, RenameTo, RenameToIgnoredFix, ReplaceAssignmentWithComparisonFix, ReplaceBackquoteExpressionQuickFix, ReplaceBuiltinsQuickFix, ReplaceComputeWithComputeIfPresentFix, ReplaceElementFix, ReplaceEmptyArrayToConstantFix, ReplaceExceptPartQuickFix, ReplaceExpressionWithTextFix, ReplaceFunctionWithSetLiteralQuickFix, ReplaceGetClassWithClassLiteralFix, ReplaceInaccessibleFieldWithGetterSetterFix, ReplaceInheritanceWithDelegationFix, ReplaceListComprehensionsQuickFix, ReplaceNotEqOperatorQuickFix, ReplaceOctalNumericLiteralQuickFix, ReplacePrimitiveWithBoxedTypeAction, ReplaceRaiseStatementQuickFix, ReplaceTypeInCastFix, ReplaceWithConstantValueFix, ReplaceWithFileTemplateFix, ReplaceWithImportFix, ReplaceWithObjectsEqualsFix, ReplaceWithTernaryOperatorFix, ReplaceWithTernaryOperatorFix.ReplaceMethodRefWithTernaryOperatorFix, ReplaceWithTrivialLambdaFix, RepositoryAddLibraryAction, ResolvingElementQuickFix, RncNameImpl.CreateDeclFix, SafeDeleteFix, SameErasureButDifferentMethodsFix, SameParameterValueInspection.InlineParameterValueFix, SaveTo, SecondUnsafeCallQuickFix, SetInspectionOptionFix, ShowModulePropertiesFix, ShowSuggestions, SimplifyBooleanCheckQuickFix, SimplifyBooleanExpressionFix, SimplifyForEachInspection.SimplifyForEachFix, SimplifyToAssignmentFix, SizeReplaceableByIsEmptyInspection.SizeReplaceableByIsEmptyFix, StatementEffectFunctionCallQuickFix, StatementEffectIntroduceVariableQuickFix, StaticPseudoFunctionalStyleMethodInspection.ReplacePseudoLambdaWithLambda, StreamFilterNotNullFix, SubjectBodySeparationInspection.AddBlankLineQuickFix, SuggestEnumValuesFix, SuppressAllForClassFix, SuppressByCommentFix, SuppressByGroovyCommentFix, SuppressByJavaCommentFix, SuppressFix, SuppressForClassFix, SuppressForMemberFix, SuppressForTestsScopeFix, SuppressLocalWithCommentFix, SuppressParameterFix, SurroundWithIfFix, SurroundWithRequireNonNullFix, SwitchStatementWithTooFewBranchesInspection.UnwrapSwitchStatementFix, SwitchToHtml5Action, SwitchToHtml5WithHighPriorityAction, TransformClassicClassQuickFix, UnnecessaryModuleDependencyInspection.RemoveModuleDependencyFix, UnresolvedRefCreateFunctionQuickFix, UnresolvedReferenceAddParameterQuickFix, UnresolvedReferenceAddSelfQuickFix, UnresolvedRefTrueFalseQuickFix, UnwrapSwitchLabelFix, UnwrapTagFix, UtilityClassWithoutPrivateConstructorInspection.CreateEmptyPrivateConstructor, VariableArrayTypeFix, VariableTypeFix, WrapWithAdapterMethodCallFix, WrapWithMutableCollectionFix, XmlDeclareIdInCommentAction, XmlSuppressableInspectionTool.SuppressAllForFile, XmlSuppressableInspectionTool.SuppressForFile, XmlSuppressableInspectionTool.SuppressTagStatic, XmlSuppressableInspectionTool.XmlSuppressFix, XmlUnusedNamespaceInspection.RemoveNamespaceDeclarationFix, XmlUnusedNamespaceInspection.RemoveNamespaceLocationFix, XPathQuickFixFactory.Fix

public interface QuickFix<D extends CommonProblemDescriptor>
extends WriteActionAware

Common base interface for quick fixes provided by local and global inspections.

See Also:

CommonProblemDescriptor.getFixes()

Field Summary

Fields

Modifier and Type	Field and Description
static QuickFix[]	EMPTY_ARRAY

Method Summary

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

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

startInWriteAction

Field Detail

EMPTY_ARRAY

static final QuickFix[] EMPTY_ARRAY

Method Detail

getName

default java.lang.String getName()

Returns:

the name of the quick fix.

getFamilyName

java.lang.String getFamilyName()

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

applyFix

void applyFix(Project project,
              D descriptor)

Called to apply the fix.

Please call com.intellij.profile.codeInspection.ProjectInspectionProfileManager#fireProfileChanged() if inspection profile is changed as result of fix.

Parameters:

project - Project

descriptor - problem reported by the tool which provided this quick fix action