Package com.intellij.openapi.actionSystem

Interface UpdateInBackground

All Known Implementing Classes:

AbstractCommonUpdateAction, AddGradleDslDependencyAction, AnonymousToInnerAction, AutoIndentLinesAction, AutoSvnUpdater, BackspaceAction, BackwardParagraphAction, BackwardParagraphWithSelectionAction, BaseCodeInsightAction, BaseExpandToLevelAction, BaseGenerateAction, BaseGenerateTestSupportMethodAction, BaseJavaRefactoringAction, BasePlatformRefactoringAction, BaseRefactoringAction, BraceOrQuoteOutAction, ChangeSignatureAction, ChangeTypeSignatureAction, ChooseItemAction, ChooseItemAction.ChooseWithDot, ChooseItemAction.CompletingStatement, ChooseItemAction.FocusedOnly, ChooseItemAction.Replacing, CloneCaretAbove, CloneCaretBelow, CodeBlockEndAction, CodeBlockEndWithSelectionAction, CodeBlockStartAction, CodeBlockStartWithSelectionAction, CodeInsightAction, CollapseAllRegionsAction, CollapseBlockAction, CollapseDocCommentsAction, CollapseRegionAction, CollapseRegionRecursivelyAction, CollapseSelectionAction, CommonIntegrateFileOrDirectoryAction, CommonIntegrateProjectAction, CommonStatusFileOrDirectoryAction, CommonUpdateFileOrDirectoryAction, CommonUpdateProjectAction, CompileAction, CompileActionBase, CompileDirtyAction, CompileProjectAction, ConvertIndentsActionBase, ConvertIndentsToSpacesAction, ConvertIndentsToTabsAction, ConvertToInstanceMethodAction, ConvertToJavaAction, ConvertToStaticAction, CopyAction, CreateClassMappingAction, CreateDomElementAction, CutAction, CutLineBackwardAction, CutLineEndAction, DelegateMethodsAction, DeleteAction, DeleteLineAction, DeleteToLineEndAction, DeleteToLineStartAction, DeleteToWordEndAction, DeleteToWordEndInDifferentHumpsModeAction, DeleteToWordStartAction, DeleteToWordStartInDifferentHumpsModeAction, DuplicateAction, DuplicateLinesAction, EditorAction, EditPropertyValueAction, EmacsStyleIndentAction, EmmetPreviewAction, EmmetUpdateTagAction, EncapsulateFieldsAction, EnterAction, EscapeAction, EscapeEntitiesAction, ExpandAllRegionsAction, ExpandAllToLevel1Action, ExpandAllToLevel2Action, ExpandAllToLevel3Action, ExpandAllToLevel4Action, ExpandAllToLevel5Action, ExpandDocCommentsAction, ExpandLiveTemplateByTabAction, ExpandLiveTemplateCustomAction, ExpandRegionAction, ExpandRegionRecursivelyAction, ExpandToLevel1Action, ExpandToLevel2Action, ExpandToLevel3Action, ExpandToLevel4Action, ExpandToLevel5Action, ExtractClassAction, ExtractIncludeAction, ExtractInterfaceAction, ExtractModuleAction, ExtractSuperActionBase, ExtractSuperclassAction, FillParagraphAction, FindAction, FindWordAtCaretAction, FixDocCommentAction, FocusGutterAction, ForwardParagraphAction, ForwardParagraphWithSelectionAction, GenerateAfterClassMethodAction, GenerateBeforeClassMethodAction, GenerateConstructorAction, GenerateCreateUIAction, GenerateDataMethodAction, GenerateDomElementAction, GenerateDTDAction, GenerateEqualsAction, GenerateGetterAction, GenerateGetterAndSetterAction, GenerateGetterSetterBaseAction, GenerateSetterAction, GenerateSetUpMethodAction, GenerateSuperMethodCallAction, GenerateTearDownMethodAction, GenerateTestMethodAction, GenerateToStringAction, GenerateXmlTagAction, GotoDeclarationAction, GoToEditPointAction, GoToEditPointAction.Backward, GoToEditPointAction.Forward, GotoImplementationAction, GotoNextElementUnderCaretUsageAction, GotoNextErrorAction, GotoPrevElementUnderCaretUsageAction, GotoPreviousErrorAction, GotoSuperAction, GotoTestOrCodeAction, GotoTypeDeclarationAction, GrBaseGenerateAction, GroovyGenerateConstructorAction, GroovyGenerateEqualsAction, GroovyGenerateGetterAction, GroovyGenerateGetterSetterAction, GroovyGenerateMethodMissingAction, GroovyGeneratePropertyMissingAction, GroovyGenerateSetterAction, GroovyGenerateToStringAction, HippieBackwardCompletionAction, HippieCompletionAction, HungryBackspaceAction, ImplementMethodsAction, InactiveEditorAction, IncrementalFindAction, IndentLineOrSelectionAction, IndentSelectionAction, InheritanceToDelegationAction, InlineAction, IntroduceParameterObjectAction, InvertBooleanAction, JavaMethodOverloadSwitchDownAction, JavaMethodOverloadSwitchUpAction, JoinLinesAction, KillRegionAction, KillRingSaveAction, KillToWordEndAction, KillToWordStartAction, LangIndentSelectionAction, LineEndAction, LineEndWithSelectionAction, LineStartAction, LineStartWithSelectionAction, ListTemplatesAction, LookupActionHandler.DownAction, LookupActionHandler.UpAction, MakeModuleAction, MakeStaticAction, MatchBraceAction, MethodDownAction, MethodDuplicatesAction, MethodUpAction, MoveAction, MoveCaretDownAction, MoveCaretDownWithSelectionAction, MoveCaretLeftAction, MoveCaretLeftWithSelectionAction, MoveCaretRightAction, MoveCaretRightWithSelectionAction, MoveCaretUpAction, MoveCaretUpWithSelectionAction, MoveDownAndScrollAction, MoveDownWithSelectionAndScrollAction, MoveElementLeftAction, MoveElementRightAction, MoveLineDownAction, MoveLineUpAction, MoveStatementDownAction, MoveStatementUpAction, MoveUpAndScrollAction, MoveUpWithSelectionAndScrollAction, NextBookmarkAction, NextParameterAction, NextPrevParameterAction, NextPrevParameterAction.Next, NextPrevParameterAction.Prev, NextVariableAction, NextWordAction, NextWordInDifferentHumpsModeAction, NextWordInDifferentHumpsModeWithSelectionAction, NextWordWithSelectionAction, OverrideMethodsAction, PageBottomAction, PageBottomWithSelectionAction, PageDownAction, PageDownWithSelectionAction, PageTopAction, PageTopWithSelectionAction, PageUpAction, PageUpWithSelectionAction, PasteAction, PasteFromX11Action, PresentableActionHandlerBasedAction, PreviousBookmarkAction, PreviousVariableAction, PreviousWordAction, PreviousWordInDifferentHumpsModeAction, PreviousWordInDifferentHumpsModeWithSelectionAction, PreviousWordWithSelectionAction, PrevParameterAction, PullUpAction, PushDownAction, PyBaseConvertModulePackageAction, PyBaseRefactoringAction, PyConvertModuleToPackageAction, PyConvertPackageToModuleAction, ReloadFileAction, RemoveMiddlemanAction, RenameElementAction, ReplaceAction, ReplaceConstructorWithBuilderAction, ReplaceConstructorWithFactoryAction, ReplaceMethodWithMethodObjectAction, ResetFontSizeAction, ReverseLinesAction, RollbackAction, SafeDeleteAction, ScrollDownAction, ScrollDownAndMoveAction, ScrollLeftAction, ScrollRightAction, ScrollToBottomAction, ScrollToCenterAction, ScrollToTopAction, ScrollUpAction, ScrollUpAndMoveAction, SearchAgainAction, SearchBackAction, SelectAllAction, SelectAllOccurrencesAction, SelectLineAction, SelectNextOccurrenceAction, SelectWordAtCaretAction, ShGenerateForLoop, ShGenerateUntilLoop, ShGenerateWhileLoop, ShowContainerInfoAction, ShowControlFlowAction, ShowErrorDescriptionAction, ShowExpressionTypeAction, ShowFontsUsedByEditorAction, ShowGutterIconTooltipAction, ShowIntentionActionsAction, ShowParameterInfoAction, ShowQuickDocInfoAction, SimpleCodeInsightAction, SimplePasteAction, SingleRootSwitcher, SliceBackwardAction, SliceForwardAction, SmartEnterAction, SortLinesAction, SplitLineAction, StartNewLineAction, StartNewLineBeforeAction, SurroundWithAction, SurroundWithEmmetAction, SurroundWithTemplateAction, SwapSelectionBoundariesAction, TabAction, TabbedShowHistoryAction, TempWithQueryAction, TextComponentEditorAction, TextEndAction, TextEndWithSelectionAction, TextStartAction, TextStartWithSelectionAction, ToggleCaseAction, ToggleInsertStateAction, ToggleRenderedDocPresentationAction, ToggleStickySelectionModeAction, TurnRefsToSuperAction, TypeCookAction, UnindentSelectionAction, UnselectPreviousOccurrenceAction, UnselectWordAtCaretAction, UnwrapAction, WrapReturnValueAction

public interface UpdateInBackground

Implement this in actions or action groups to flag that their AnAction.update(com.intellij.openapi.actionSystem.AnActionEvent), ActionGroup.getChildren(AnActionEvent) and ActionGroup.canBePerformed(com.intellij.openapi.actionSystem.DataContext) methods can be invoked on a background thread.

This means that those updating methods shouldn't access Swing component hierarchy directly, and any further data they access should be thread-safe. The reason: it's possible that update methods are invoked concurrently from Swing thread and background thread. When on background thread, application-wide read access is guaranteed, so no synchronization for PSI, VFS and project model is necessary.

Update methods should call ProgressManager.checkCanceled() often enough to guard against UI freezes.