Package com.intellij.codeInsight.intention

Interface IntentionAction

All Superinterfaces:

FileModifier, WriteActionAware

All Known Subinterfaces:

HintAction, IntentionActionWithOptions, JvmGroupIntentionAction

All Known Implementing Classes:

AbstractChopListAction, AbstractCreateFileFix, AbstractEmptyIntentionAction, AbstractFix, AbstractIntentionAction, AbstractJavaChopListAction, AbstractJavaJoinListAction, AbstractJoinListAction, AbstractListIntentionAction, AbstractNumberConversionIntention, AbstractSuppressByNoInspectionCommentFix, AccessStaticViaInstanceFix, AdapterToListenerIntention, AddAnnotationAttributeNameFix, AddAnnotationFix, AddAttributeValueIntentionFix, AddConstructorFix, AddDefaultConstructorFix, AddEmptyRecordHeaderFix, AddExceptionFromFieldInitializerToConstructorThrowsFix, AddExceptionToCatchFix, AddExceptionToExistingCatchFix, AddExceptionToThrowsFix, AddExplicitTypeArgumentsIntention, AddFinallyFix, AddJavadocIntention, AddMethodBodyFix, AddMethodFix, AddMethodQualifierFix, AddMissingRequiredAnnotationParametersFix, AddNewArrayExpressionFix, AddOnDemandStaticImportAction, AddOptionalArgumentsIntention, AddParamBase, AddParameterFix, AddParameterListFix, AddReturnFix, AddReturnTypeFix, AddRuntimeExceptionToThrowsAction, AddSchemaPrefixIntention, AddSingleMemberStaticImportAction, AddTypeArgumentsConditionalFix, AddTypeArgumentsFix, AddTypeCastFix, AddVariableInitializerFix, AddWithParamFix, AddXsiSchemaLocationForExtResourceAction, AdjustFunctionContextFix, AnnotateCapitalizationIntention, AnnotateIntentionAction, AnnotateOverriddenMethodsIntention, AntChangeContextFix, ApplyChangeSignatureAction, AssignFieldFromParameterAction, AutoImportHintAction, BaseColorIntentionAction, BaseCommitMessageInspection.ReformatCommitMessageQuickFix, BaseElementAtCaretIntentionAction, BaseIntentionAction, BaseMoveInitializerToMethodAction, BaseRefactoringIntentionAction, BaseSwitchFix, BindFieldsFromParametersAction, BreakStringOnLineBreaksIntentionAction, BringVariableIntoScopeFix, CastMethodArgumentFix, CDataToTextIntention, ChangeBoundFieldTypeFix, ChangeClassParametersIntention, ChangeClassSignatureFromUsageFix, ChangeExtendsImplementsQuickFix, ChangeExtendsToImplementsFix, ChangeFormComponentTypeFix, ChangeMethodSignatureFromUsageFix, ChangeMethodSignatureFromUsageReverseOrderFix, ChangeModifierIntention, ChangeNewOperatorTypeFix, ChangeParameterClassFix, ChangeStringLiteralToCharInMethodCallFix, ChangeToAppendFix, ChangeToCStyleCommentIntention, ChangeToCStyleCommentIntention, ChangeToEndOfLineCommentIntention, ChangeTypeArgumentsFix, ChangeUIDAction, ChangeVariableTypeToRhsTypeIntention, CharToStringIntention, CheckTagEmptyBodyInspection.Fix, CleanupAllIntention, CleanupInspectionIntention, CleanupIntention, CleanupOnScopeIntention, CollapseAnnotationsFix, CollapseTagIntention, ComposeFunctionChainAction, ConcatenationToMessageFormatAction, ConfigureCodeStyleOnSelectedFragment, ConstantSubexpressionIntention, ConvertAbsolutePathToRelativeIntentionAction, ConvertAtomicToLongAdderIntention, ConvertCatchToThrowsIntention, ConvertClosureToMethodIntention, ConvertCollectionToArrayFix, ConvertColorRepresentationIntentionAction, ConvertCompactConstructorToCanonicalAction, ConvertCompareToToEqualsIntention, ConvertConcatenationToGstringIntention, ConvertDoubleToFloatFix, ConvertFieldToAtomicIntention, ConvertFieldToAtomicIntention.ConvertNonFinalLocalToAtomicFix, ConvertFieldToThreadLocalIntention, ConvertFormatOperatorToMethodIntention, ConvertFromGeeseBracesIntention, ConvertGStringToStringIntention, ConvertIfToChooseIntention, ConvertIntegerToBinaryIntention, ConvertIntegerToDecimalIntention, ConvertIntegerToHexIntention, ConvertIntegerToOctalIntention, ConvertInterfaceToClassIntention, ConvertJUnit3TestCaseToJUnit4Intention, ConvertJunitAssertionToAssertStatementIntention, ConvertMapToClassIntention, ConvertMethodToClosureIntention, ConvertMultilineStringToSingleLineIntention, ConvertParameterToMapEntryIntention, ConvertRelativePathToAbsoluteIntentionAction, ConvertSchemaPrefixToDefaultIntention, ConvertSimpleGetterToPropertyIntention, ConvertStringToMultilineIntention, ConvertSwitchToIfIntention, ConvertToBasicLatinAction, ConvertToEntityFix, ConvertToGeeseBracesIntention, ConvertToNestedIfIntention, ConvertToRegexIntention, ConvertToSingleReturnAction, ConvertToStringLiteralAction, ConvertVariadicParamIntention, CopyAbstractMethodImplementationAction, CopyConcatenatedStringToClipboardIntention, CreateAnnotationMethodFromUsageFix, CreateAssertIntention, CreateCastExpressionFromInstanceofAction, CreateClassActionBase, CreateClassFromNewFix, CreateClassFromUsageBaseFix, CreateClassFromUsageFix, CreateClassInPackageInModuleFix, CreateClassOrPackageFix, CreateConstructorMatchingSuperFix, CreateConstructorParameterFromFieldFix, CreateDefaultBranchFix, CreateDirectoryPathFix, CreateFieldFromParameterAction, CreateFieldFromParameterActionBase, CreateFieldFromUsageFix, CreateFieldFromUsageFix, CreateFieldOrPropertyFix, CreateFileFix, CreateFilePathFix, CreateFromUsageBaseFix, CreateGetterFromUsageFix, CreateGetterOrSetterFix, CreateInnerClassFromNewFix, CreateInnerClassFromUsageFix, CreateInnerRecordFromNewFix, CreateLocalFromUsageFix, CreateLocalVarFromInstanceofAction, CreateLocalVariableFromUsageFix, CreateMethodFromMethodReferenceFix, CreateMethodFromUsageFix, CreateMethodQuickFix, CreateMissingSwitchBranchesAction, CreateMissingSwitchBranchesFix, CreateNSDeclarationIntentionFix, CreateParameterFix, CreateParameterForFieldIntention, CreateParameterFromUsageFix, CreateParameterFromUsageFix, CreatePropertyFix, CreateRecordFromNewFix, CreateServiceClassFixBase, CreateServiceImplementationClassFix, CreateServiceInterfaceOrClassFix, CreateSetterFromUsageFix, CreateSubclassAction, CreateSwitchIntention, CreateTestAction, CreateTestAction, CreateTypeParameterFromUsageFix, CreateVarFromUsageFix, CreateVariableFix, CustomEditInspectionToolsSettingsAction, DataPointHolderConversionIntention, DeannotateIntentionAction, DeferFinalAssignmentFix, DefineParamsDefaultValueAction, DeleteCatchFix, DeleteElementFix, DeleteMethodBodyFix, DeleteMultiCatchFix, DeleteRepeatedInterfaceFix, DeleteReturnFix, DeleteSideEffectsAwareFix, DemorgansIntention, DemorgansLawIntention, DetailExceptionsIntention, DisableInspectionToolAction, DynamicMethodFix, DynamicPropertyFix, DynamicPropertyFromLabelFix, DynamicPropertyFromRefFix, EachToForIntention, EditCleanupProfileIntentionAction, EditContractIntention, EditFoldingOptionsAction, EditInjectionSettingsAction, EditInspectionToolsSettingsAction, EditInspectionToolsSettingsInSuppressedPlaceIntention, EditIntentionSettingsAction, EditPropertyValueIntentionAction, EditRangeIntention, EliminateParenthesesIntention, EmptyIntentionAction, EnableDisableIntentionAction, EnableOptimizeImportsOnTheFlyFix, EncapsulateFieldAction, EntryPointsManagerBase.AddImplicitlyWriteAnnotation, ExpandBooleanIntention, ExpandBooleanIntention, ExpandStaticImportAction, ExtendsListFix, ExtractChainedMapAction, ExtractIfConditionAction, ExtractIncrementIntention, ExtractMethodIntentionAction, ExtractSetFromComparisonChainAction, ExtractToMethodReferenceIntention, ExtractWhileLoopConditionToIfStatementIntention, FetchExtResourceAction, FindJarFix, FlipAssertLiteralIntention, FlipCommaIntention, FlipCommutativeMethodCallIntention, FlipComparisonIntention, FlipComparisonIntention, FlipConditionalIntention, FlipConditionalIntention, FlipConjunctionIntention, FlipExpressionIntention, FlipIfIntention, FlipIntersectionSidesFix, FlipOperandsFix, FlipSetterCallIntention, ForToEachIntention, GenerateMissedTestsAction, GenerifyFileFix, GoToSymbolFix, GrabDependencies, GrAliasImportIntention, GrBreakStringOnLineBreaksIntention, GrChangeMemberVisibilityModifierBase, GrConvertStringToCharIntention, GrConvertTypeCastToSafeCastIntention, GrCopyStringConcatenationContentIntention, GrCreateFieldForParameterIntention, GrCreateFromUsageBaseFix, GrCreateMissingSwitchBranchesIntention, GrCreateSubclassAction, GrIntroduceLocalVariableIntention, GrMakeMemberPrivateIntention, GrMakeMemberProtectedIntention, GrMakeMemberPublicIntention, GrMoveClassToCorrectPlaceFix, GroovyAddImportAction, GroovyFindJarFix, GroovyOptimizeImportsFix, GroovyStaticImportMethodFix, GrRedundantElseIntention, GrRemoveAnnotationIntention, GrRemoveExceptionFix, GrRemoveExplicitTypeDeclarationIntention, GrSetStrongTypeIntention, GrSortMapKeysIntention, GrSplitDeclarationIntention, GuavaInspection.MigrateGuavaTypeFix, IgnoreExtResourceAction, IgnoreFileRemoveEntryFix, ImplementAbstractClassMethodsFix, ImplementAbstractMethodAction, ImplementMethodsFix, ImportClassFix, ImportClassFixBase, ImportFromToImportIntention, ImportOnDemandIntention, ImportStaticIntention, ImportToggleAliasIntention, ImportToImportFromIntention, IncreaseLanguageLevelFix, IndexedExpressionConversionIntention, IndexingMethodConversionIntention, InitializeFinalFieldInConstructorFix, InjectLanguageAction, InlineIncrementIntention, InlineStreamMapAction, InlineXslAttribute, InsertConstructorCallFix, InsertLiteralUnderscoresAction, InsertMethodCallFix, InsertNewFix, InsertRequiredAttributeFix, InsertSuperFix, InsertThisFix, Intention, Intention, IntentionActionWrapper, IntentionAndQuickFixAction, IntentionWrapper, IntroduceVariableIntentionAction, InvertIfConditionAction, InvertIfIntention, InvestigateFix, IterateOverIterableIntention, JavaChopArgumentsAction, JavaChopParametersAction, JavaCreatePropertyFix, JavaFindJarFix, JavaFxCollapseSubTagToAttributeIntention, JavaFxExpandAttributeIntention, JavaFxFieldToPropertyIntention, JavaFxInjectPageLanguageIntention, JavaFxWrapWithDefineIntention, JavaJoinArgumentsAction, JavaJoinParametersAction, JavaNumberConversionIntention, JoinConcatenatedStringLiteralsIntention, JsonSortPropertiesIntention, LightEditOpenInProjectIntention, LocalQuickFixAndIntentionActionOnPsiElement, LocalQuickFixAsIntentionAdapter, LocalQuickFixOnPsiElementAsIntentionAdapter, MakeAnnotationExternal, MakeCallChainIntoCallSequenceIntention, MakeClassInterfaceFix, MakeClosureCallExplicitIntention, MakeClosureCallImplicitIntention, MakeExternalAnnotationExplicit, MakeInferredAnnotationExplicit, MakeMethodConstructorFix, MakeMethodDefaultIntention, MakeTypeExplicitFix, MakeVarargParameterLastFix, ManuallySetupExtResourceAction, MergeCallSequenceToChainIntention, MergeElseIfIntention, MergeElseIfIntention, MergeFilterChainAction, MergeIfAndIntention, MergeIfAndIntention, MergeIfOrIntention, MergeModuleStatementsFix, MergeNestedTryStatementsIntention, MergePackageAccessibilityStatementsFix, MergeParallelIfsIntention, MergeProvidesStatementsFix, MethodArgumentFix, MethodParameterFix, MethodReturnTypeFix, ModifierFix, MoveBoundClassToFrontFix, MoveCatchUpFix, MoveClassToModuleFix, MoveClassToNewFileIntention, MoveClassToSeparateFileFix, MoveCommentToSeparateLineIntention, MoveFileFix, MoveInitializerToConstructorAction, MoveInitializerToSetUpMethodAction, MutablyNamedIntention, MutablyNamedIntention, NavigateToAlreadyDeclaredVariableFix, NegateComparisonIntention, NegateComparisonIntention, NegateConditionalIntention, NegationBroadScopeFix, ObjectsRequireNonNullIntention, ObscureThrownExceptionsIntention, OptimizeImportsQuickFix, OrderEntryFix, PermuteArgumentsFix, PostfixPrefixIntention, PriorityActionWrapper, PriorityIntentionActionWrapper, PsiElementBaseIntentionAction, PullAsAbstractUpFix, PyAnnotateTypesIntention, PyAnnotateVariableTypeIntention, PyBaseConvertCollectionLiteralIntention, PyBaseIntentionAction, PyConvertLambdaToFunctionIntention, PyConvertLiteralToListIntention, PyConvertLiteralToSetIntention, PyConvertLiteralToTupleIntention, PyConvertMethodToPropertyIntention, PyConvertStaticMethodToFunctionIntention, PyConvertToFStringIntention, PyConvertTripleQuotedStringIntention, PyConvertTypeCommentToVariableAnnotationIntention, PyDemorganIntention, PyDictConstructorToLiteralFormIntention, PyDictLiteralFormToConstructorIntention, PyFillParagraphFix, PyFlipComparisonIntention, PyGenerateDocstringIntention, PyJoinIfIntention, PyNegateComparisonIntention, PyQuotedStringIntention, PyRenameElementQuickFix, PySplitIfIntention, PyStringConcatenationToFormatIntention, PyTransformConditionalExpressionIntention, PyYieldFromIntention, QualifyStaticConstantFix, QualifyStaticMethodCallFix, QualifySuperArgumentFix, QualifyThisArgumentFix, QualifyThisOrSuperArgumentFix, QualifyWithThisFix, QuickEditAction, QuickFixWrapper, RearrangeAttributesIntention, ReformatFix, RemoveAttributeIntentionFix, RemoveExplicitConversionFix, RemoveExtraClosingTagIntentionAction, RemoveLiteralUnderscoresAction, RemoveNewQualifierFix, RemoveParameterListFix, RemoveParamFix, RemoveQualifierFix, RemoveRedundantArgumentsFix, RemoveRedundantClassPropertyIntention, RemoveRedundantConversionFix, RemoveTagAndPromoteChildrenIntentionAction, RemoveTagIntentionFix, RemoveTrailingBlankLinesFix, RemoveTypeArgumentsFix, RemoveUnnecessaryBracesInGStringIntention, RemoveUnnecessaryEscapeCharactersIntention, RemoveUnnecessaryReturnIntention, RemoveUnusedGrParameterFix, RemoveUnusedParameterFix, RemoveUnusedVariableFix, RenameElementFix, RenameFileFix, RenameFileWithClassIntention, RenameTagBeginOrEndIntentionAction, RenameToIgnoredFix, RenameVariableFix, RenameWrongRefFix, ReplaceAbstractClassInstanceByMapIntention, ReplaceAddAllArrayToCollectionFix, ReplaceArmWithTryFinallyIntention, ReplaceAssertLiteralWithAssertEqualsIntention, ReplaceAssignmentFromVoidWithStatementIntentionAction, ReplaceAssignmentWithComparisonFix, ReplaceAssignmentWithPostfixExpressionIntention, ReplaceCastWithVariableAction, ReplaceConcatenationWithFormatStringIntention, ReplaceConcatenationWithStringBufferIntention, ReplaceConditionalWithBooleanExpressionIntention, ReplaceDelimiterFix, ReplaceDoWhileLoopWithWhileLoopIntention, ReplaceElementFix, ReplaceForEachLoopWithIndexedForLoopIntention, ReplaceForEachLoopWithIteratorForLoopIntention, ReplaceForEachLoopWithOptimizedIndexedForLoopIntention, ReplaceFormatStringWithConcatenationIntention, ReplaceFullyQualifiedNameWithImportIntention, ReplaceGetClassWithClassLiteralFix, ReplaceIfWithTernaryIntention, ReplaceImplementsWithStaticImportAction, ReplaceInaccessibleFieldWithGetterSetterFix, ReplaceIteratorForEachLoopWithIteratorForLoopFix, ReplaceListComprehensionWithForIntention, ReplaceMultiplyWithShiftIntention, ReplaceOctalEscapeWithUnicodeEscapeIntention, ReplaceOnDemandImportIntention, ReplaceOperatorAssignmentWithAssignmentIntention, ReplaceOperatorAssignmentWithPostfixExpressionIntention, ReplacePostfixExpressionWithAssignmentIntention, ReplacePostfixExpressionWithOperatorAssignmentIntention, ReplacePrimitiveWithBoxedTypeAction, ReplaceShiftWithMultiplyIntention, ReplaceSwitchWithIfIntention, ReplaceTernaryWithIfElseIntention, ReplaceWhileLoopWithDoWhileLoopIntention, ReplaceWithArraysAsListIntention, ReplaceWithListAccessFix, ReplaceWithMutableCollectionIntention, ReplaceWithOperatorAssignmentIntention, ReplaceWithXslAttribute, RepositoryAddLibraryAction, ResolvingElementQuickFix, ReuseVariableDeclarationFix, ReverseForLoopDirectionIntention, RunInspectionIntention, RunRefactoringAction, SafeDeleteFix, SameErasureButDifferentMethodsFix, SetupJDKFix, ShDisableInspectionIntention, ShExplainShellIntention, ShowModulePropertiesFix, ShQuickFixIntention, ShRenameAllOccurrencesIntention, SimplifyBooleanExpressionAction, SimplifyForEachInspection.ForEachNonFinalFix, SimplifyTernaryOperatorIntention, SortContentAction, SpecifyTypeInDocstringIntention, SpecifyTypeInPy3AnnotationsIntention, SplitDeclarationAction, SplitDeclarationAndInitializationIntention, SplitElseIfIntention, SplitElseIfIntention, SplitFilterAction, SplitIfAction, SplitIfIntention, SplitSwitchBranchWithSeveralCaseValuesAction, StaticImportConstantFix, StaticImportMemberFix, StaticImportMethodFix, SuperMethodReturnFix, SuppressInspectionIntention, SuppressIntentionAction, SuppressIntentionActionFromFix, SurroundAutoCloseableAction, SurroundWithArrayFix, SurroundWithQuotesAnnotationParameterValueFix, SurroundWithTryCatchFix, SwapIfStatementsIntentionAction, SwitchToHtml5Action, SwitchToHtml5WithHighPriorityAction, TextToCDataIntention, TypeAssertionIntention, TypeIntention, UnicodeUnescapeIntention, UnimplementInterfaceAction, UnInjectLanguageAction, UnrollLoopAction, UnwrapElseBranchAction, VariableAccessFromInnerClassFix, VariableAccessFromInnerClassJava10Fix, VariableTypeFix, VariableTypeFromCallFix, WrapExpressionFix, WrapObjectWithOptionalOfNullableFix, WrapSwitchRuleStatementsIntoBlockFix, WrapVarargArgumentsWithExplicitArrayIntention, WrapWithAdapterMethodCallFix, WrapWithUnmodifiableAction, XmlChooseColorIntentionAction, XmlSplitTagAction, XPathQuickFixFactory.Fix

public interface IntentionAction
extends FileModifier

Intention actions are invoked by pressing Alt-Enter in the code editor at the location where an intention is available, and can be enabled or disabled in the "Intentions" settings dialog.

Implement Iconable interface to change icon in intention popup menu.

Implement HighPriorityAction, LowPriorityAction or PriorityAction to change ordering.

Can be DumbAware.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

Field Summary

Fields

Modifier and Type	Field and Description
static IntentionAction[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFamilyName() Returns the name of the family of intentions.
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
void	invoke(Project project, Editor editor, PsiFile file) Called when user invokes intention.
boolean	isAvailable(Project project, Editor editor, PsiFile file) Checks whether this intention is available at a caret offset in the file.
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

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

getElementToMakeWritable

Field Detail

EMPTY_ARRAY

static final IntentionAction[] EMPTY_ARRAY

Method Detail

getText

java.lang.String getText()

Returns text to be shown in the list of available actions, if this action is available.

Returns:

the text to show in the intention popup.

See Also:

isAvailable(Project, Editor, PsiFile)

getFamilyName

java.lang.String getFamilyName()

Returns the name of the family of intentions. It is used to externalize "auto-show" state of intentions. When the user clicks on a light bulb in intention list, all intentions with the same family name get enabled/disabled. The name is also shown in settings tree.

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

isAvailable

boolean isAvailable(Project project,
                    Editor editor,
                    PsiFile file)

Checks whether this intention is available at a caret offset in the file. If this method returns true, a light bulb for this intention is shown.

Parameters:

project - the project in which the availability is checked.

editor - the editor in which the intention will be invoked.

file - the file open in the editor.

Returns:

true if the intention is available, false otherwise.

invoke

void invoke(Project project,
            Editor editor,
            PsiFile file)
     throws IncorrectOperationException

Called when user invokes intention. This method is called inside command. If startInWriteAction() returns true, this method is also called inside write action.

Parameters:

project - the project in which the intention is invoked.

editor - the editor in which the intention is invoked.

file - the file open in the editor.

Throws:

IncorrectOperationException

startInWriteAction

boolean startInWriteAction()

Indicate whether this action should be invoked inside write action. Should return false if, e.g., a 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 intention requires a write action, false otherwise.