Package com.intellij.openapi.components

Interface PersistentStateComponent<T>

All Known Subinterfaces:

PersistentStateComponentWithModificationTracker<T>

All Known Implementing Classes:

AbbreviationManagerImpl, AcceptedLanguageLevelsSettings, ActionMacroManager, AnalysisUIOptions, AntArtifactProperties, AntConfigurationImpl, AntWorkspaceConfiguration, AppCodeStyleSettingsManager, AppEditorFontOptions, AppEngineFacetConfiguration, AppEngineServerConfiguration, AppInspectionProfilesVisibleTreeState, ApplicationLibraryTable, AppPropertiesComponentImpl, ApprovedGroupsCacheConfigurable, ArchivePackagingElement, ArtifactEditorSettings, ArtifactManagerImpl, ArtifactPackagingElement, ArtifactProperties, ArtifactRootElement, ArtifactRootElementImpl, ArtifactsWorkspaceSettings, BaseInjection, BookmarkManager, BuildProcessCustomPluginsConfiguration, BuiltInServerOptions, CachedDictionaryState, CertificateManager, ChangeListManagerImpl, ChangesViewManager, ChooseByNameFilterConfiguration, ClientLibraryManagerImpl, ClientPropertiesManager, CloudConfigurationBase, CloudDeploymentNameConfiguration, CodeInsightSettings, CodeInsightWorkspaceSettings, CodeStyleSchemesUIConfiguration, CodeStyleSettingsManager, Commander, CommitMessageInspectionProfile, CompilerConfigurationImpl, CompilerWorkspaceConfiguration, CompletionMLRankingSettings, ComplexPackagingElement, CompositeElementWithManifest, CompositePackagingElement, Configuration, Configuration.App, Configuration.Prj, ConfigurationManager, ConsoleFoldingSettings, CoreModuleManager, CoverageOptionsProvider, CoverageViewManager, CustomActionsSchema, CvsApplicationLevelConfiguration, CvsConfiguration, DaemonCodeAnalyzerImpl, DateTimeFormatManager, DebuggerManagerImpl, DebuggerProjectSettings, DebuggerSettings, DependenciesAnalyzeManager, DependencyUISettings, DependencyValidationManager, DependencyValidationManagerImpl, DeploymentConfigurationBase, DetectionExcludesConfigurationImpl, DictionaryState, DimensionService, DirectoryCopyPackagingElement, DirectoryPackagingElement, DockManagerImpl, DslActivationStatus, DummyDeploymentConfiguration, DummyLibraryProperties, DuplocatorSettings, DynamicManager, DynamicManagerImpl, EclipseCompilerConfiguration, EclipseModuleManagerImpl, EditorColorsManagerImpl, EditorConfigPreviewManager, EditorHistoryManager, EditorSettingsExternalizable, EditorSettingsExternalizable.OsSpecificState, EmmetOptions, EncodingManagerImpl, EncodingProjectManagerImpl, EntryPointsManagerBase, EntryPointsManagerImpl, EqualsHashCodeTemplatesManager, ErrorTreeViewConfiguration, EventLogWhitelistSettingsPersistence, ExceptionBreakpointProperties, ExcludedEntriesConfiguration, ExecuteGradleTaskHistoryService, ExecutionTargetManagerImpl, ExportableApplicationLibraryTable, ExportToHTMLSettings, ExternalDependenciesManagerImpl, ExternalProjectsDataStorage, ExternalProjectsManagerImpl, ExternalProjectsWorkspaceImpl, ExternalResourceManagerExImpl, ExtractedDirectoryPackagingElement, FacetEditorsStateManagerImpl, FacetFromExternalSourcesStorage, FacetManagerImpl, FavoritesManager, FeatureUsageTrackerImpl, FileAssociationsConfigurable.UIState, FileCopyPackagingElement, FileEditorManagerImpl, FileEditorProviderManagerImpl, FileHistoryUiProperties, FileOrDirectoryCopyPackagingElement, FileTemplateManagerImpl, FileTypeManagerImpl, FindInProjectSettingsBase, FindSettingsImpl, GantSettings, GeneralSettings, GenerateToStringContext, GetterTemplatesManager, GitCompareBranchesLogProperties, GitExternalLogTabsProperties, GithubProjectSettings, GithubSettings, GitRebaseSettings, GitRememberedInputs, GitSharedSettings, GitUpdateProjectInfoLogProperties, GitVcsApplicationSettings, GlobalAntConfiguration, GlobalProjectStructureProblemsSettings, GotoClassSymbolConfiguration, GotoFileConfiguration, GradleLocalSettings, GradleSettings, GradleSettingsMigration, GradleSettingsMigration.LegacyDefaultGradleProjectSettings, GradleSystemSettings, GreclipseIdeaCompilerSettings, GroovyApplicationSettings, GroovyCompilerConfiguration, GroovyDebuggerSettings, GroovyLibraryProperties, GroovyRefactoringSettings, GuiDesignerConfiguration, HgGlobalSettings, HgProjectSettings, HgRememberedInputs, HgUpdateConfigurationSettings, HierarchyBrowserManager, HighlightingSettingsPerFile, HttpConfigurable, IdeDocumentHistoryImpl, ImageTagManager, ImportFilteringUsageViewSetting, InspectionProblemsView, InstancesTracker, IntentionManagerSettings, InvalidFacetManagerImpl, IssueNavigationConfiguration, JavaAwareProjectJdkTableImpl, JavaBreakpointProperties, JavacConfiguration, JavaCodeFoldingSettingsImpl, JavaCoverageOptionsProvider, JavaDebuggerSettings, JavadocGenerationManager, JavaExceptionBreakpointProperties, JavaFieldBreakpointProperties, JavaFxArtifactProperties, JavaFxPreloaderArtifactProperties, JavaFxSettings, JavaLineBreakpointProperties, JavaMethodBreakpointProperties, JavaProjectCodeInsightSettings, JavaRefactoringSettings, JsonEditorOptions, JsonSchemaCatalogProjectConfiguration, JsonSchemaMappingsProjectConfiguration, KeyboardSettingsExternalizable, LafManagerImpl, LanguageLevelModuleExtensionImpl, LanguagePerFileMappings, LastSelectedPropertiesFileStore, LegacyCodeStyleSettingsManager, LegacyFUSProjectUsageTrigger, LibraryPackagingElement, LibraryProperties, LibraryTableBase, LibraryVersionProperties, LightEditServiceImpl, LineMarkerSettingsImpl, LogConsolePreferences, LogFilterRegistrar, MarkdownApplicationSettings, MasterDetailsStateService, MavenRepositoryServicesManager, MemoryViewManager, ModuleManagerComponent, ModuleManagerImpl, ModuleOutputPackagingElementBase, ModulePackagingElementBase, ModuleRootManagerComponent, ModuleRunConfigurationManager, MultilanguageDuplocatorSettings, MvcProjectViewState, MvcRunTargetHistoryService, NamedScopeManager, NamedScopesHolder, NodeRendererSettings, NotificationsConfigurationImpl, NullableNotNullManagerImpl, OldFacetDetectionExcludesConfiguration, PackagingElement, Palette, PerFileMappingsBase, PersistableCodeStyleSchemes, PlaybackDebugger.PlaybackDebuggerState, PluginManagerUISettings, PostfixTemplatesSettings, PostfixTemplateStorage, PreviewManagerImpl, PrintSettings, ProductionModuleOutputPackagingElement, ProjectCodeStyleSettingsManager, ProjectDictionaryState, ProjectFacetManagerImpl, ProjectInspectionProfilesVisibleTreeState, ProjectJdkTableImpl, ProjectLevelVcsManagerImpl, ProjectPlainTextFileTypeManager, ProjectPropertiesComponentImpl, ProjectResources, ProjectRootManagerComponent, ProjectRootManagerImpl, ProjectStartupConfigurationBase, ProjectStructureProblemsSettingsBase, ProjectStructureProblemsSettingsImpl, ProjectTypeService, ProjectViewFileNestingService, ProjectViewImpl, PropertiesComponentImpl, PropertiesRefactoringSettings, PropertiesSeparatorManager, PsiAwareFileEditorManagerImpl, PsiViewerSettings, PushSettings, PyCharmProfessionalAdvertiserSettings, PyCodeInsightSettings, PyCompatibilityInspectionAdvertiserSettings, PyCondaPackageService, PyConsoleOptions, PyDebuggerOptionsProvider, PyDebuggerSettings, PyDefaultProjectAwareService, PyDocumentationSettings, PyDocumentationSettings.AppService, PyDocumentationSettings.ModuleService, PyExceptionBreakpointProperties, PyFindUsagesOptions, PyPackageRequirementsSettings, PyPackageRequirementsSettings.AppService, PyPackageRequirementsSettings.ModuleService, PyPackageService, PyPackagingSettings, PyTestFrameworkService, PythonDocumentationMap, PythonFoldingSettings, ReadonlyStatusHandlerImpl, RecentsManager, RecentTaskRepositories, RefactoringSettings, RemoteMappingsManager, RemoteRepositoriesConfiguration, RemoteServersManagerImpl, RepositoryLibraryProperties, ResourceBundleManager, RestoreUpdateTree, ReSTService, ReSTService.AppService, ReSTService.ModuleService, RestSettings, RichCopySettings, RmicConfiguration, RunAnythingCache, RunConfigurationProducerService, RunDashboardManagerImpl, RunnerLayoutSettings, ScratchFileServiceImpl, SdkHomeSettings, SearchEverywhereConfiguration, SelectTemplateSettings, ServerConfigurationBase, ServiceViewManagerImpl, SetterTemplatesManager, ShelveChangesManager, SliceManager, SliceToolwindowSettings, SpellCheckerSettings, SSHConnectionSettings, StructureViewFactoryImpl, StubIndexImpl, SvnApplicationSettings, SvnBranchMapperManager, SvnConfiguration, SvnFileUrlMappingImpl, TaskManagerImpl, TaskProjectConfiguration, TaskSettings, TemplateDataLanguageMappings, TemplateDataLanguagePatterns, TemplateSettings, TemplatesManager, TerminalArrangementManager, TestHistoryConfiguration, TestModuleOutputPackagingElement, TestRunnerService, TextMateSettings, ThreadsViewSettings, TodoConfiguration, TodoView, ToolsProjectConfig, ToStringTemplatesManager, TraceSettings, UnknownFeaturesCollector, UnknownLibraryKind.UnknownLibraryProperties, UnloadedModulesListStorage, UpdateCopyrightCheckinHandlerState, UpdateSettings, UsageStatisticsPersistenceComponent, ValidationConfiguration, ValidationConfiguration.ExcludedFromValidationConfiguration, VcsApplicationSettings, VcsConfiguration, VcsContentAnnotationSettings, VcsLogApplicationSettings, VcsLogBigRepositoriesList, VcsLogProjectTabsProperties, VcsLogSharedSettings, VcsLogUiPropertiesImpl, VcsLogUiPropertiesWithSharedRecentFilters, ViewsGeneralSettings, WebBrowserManager, WebEditorOptions, WindowManagerImpl, XBreakpointProperties, XDebuggerHistoryManager, XDebuggerManagerImpl, XDebuggerSettingManagerImpl, XDebuggerSettings, XmlFoldingSettings, XmlSettings, XPathAppComponent, XPathProjectComponent, YAMLEditorOptions

public interface PersistentStateComponent<T>

Every component which would like to persist its state across IDE restarts should implement this interface.

See IntelliJ Platform SDK DevGuide for detailed description.

Do NOT use for sensitive data, see Persisting Sensitive Data.

In general, implementation should be thread-safe, because "loadState" is called from the same thread where component is initialized. If component used only from one thread (e.g. EDT), thread-safe implementation is not required.

See Also:

SimplePersistentStateComponent

Method Summary

Modifier and Type	Method and Description
T	getState()
default void	initializeComponent() If class also is a component, then this method will be called after loading state (even if not state) but only once throughout the life cycle
void	loadState(T state) This method is called when new component state is loaded.
default void	noStateLoaded() This method is called when the component is initialized, but no state is persisted.

Method Detail

getState

T getState()

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

void loadState(T state)

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

noStateLoaded

default void noStateLoaded()

This method is called when the component is initialized, but no state is persisted.

initializeComponent

default void initializeComponent()

If class also is a component, then this method will be called after loading state (even if not state) but only once throughout the life cycle