IntelliJ Platform Plugin SDK Help

Persisting State of Components

The IntelliJ Platform provides an API that allows components or services to persist their state between restarts of the IDE. You can use either a simple API to persist a few values or persist the state of more complicated components using the PersistentStateComponent interface.

Using PersistentStateComponent

The com.intellij.openapi.components.PersistentStateComponent interface gives you the most flexibility for defining the values to be persisted, their format, and storage location.

To use it:

  • mark a service as implementing the PersistentStateComponent interface

  • define the state class

  • specify the storage location using @com.intellij.openapi.components.State

Note that instances of extensions cannot persist their state by implementing PersistentStateComponent. If your extension needs to have a persistent state, you need to define a separate service responsible for managing that state.

Implementing the PersistentStateComponent Interface

The implementation of PersistentStateComponent needs to be parameterized with the type of state class. The state class can either be a separate JavaBean class, or the class implementing PersistentStateComponent.

In the former case, the state class instance is typically stored as a field in the PersistentStateComponent class:

@State(...) class MyService implements PersistentStateComponent<MyService.State> { public static MyService getInstance() { // implementation according to Application/Project level service } static class State { public String value; } private State myState = new State(); public State getState() { return myState; } public void loadState(State state) { myState = state; } }

In the latter case, you can use the following pattern to implement getState() and loadState() methods:

@State(...) class MyService implements PersistentStateComponent<MyService> { public static MyService getInstance() { // implementation according to Application/Project level service } public String stateValue; public MyService getState() { return this; } public void loadState(MyService state) { XmlSerializerUtil.copyBean(state, this); } }

Implementing the State Class

The implementation of PersistentStateComponent works by serializing public fields, annotated private fields (see also Customizing the XML format of persisted values), and bean properties into an XML format.

To exclude a public field or bean property from serialization, annotate the field or getter with @com.intellij.util.xmlb.annotations.Transient.

Note that the state class must have a default constructor. It should return the component's default state: the one used if there is nothing persisted in the XML files yet.

State class should have an equals() method, but state objects are compared by fields if it is not implemented. When using Kotlin, use Data Classes.

The following types of values can be persisted:

  • numbers (both primitive types, such as int, and boxed types, such as Integer)

  • booleans

  • strings

  • collections

  • maps

  • enums

For other types, extend com.intellij.util.xmlb.Converter:

class LocalDateTimeConverter extends Converter<LocalDateTime> { public LocalDateTime fromString(String value) { long epochMilli = Long.parseLong(value); ZoneId zoneId = ZoneId.systemDefault(); return Instant.ofEpochMilli(epochMilli).atZone(zoneId).toLocalDateTime(); } public String toString(LocalDateTime value) { ZoneId zoneId = ZoneId.systemDefault(); long toEpochMilli = value.atZone(zoneId).toInstant().toEpochMilli(); return Long.toString(toEpochMilli); } }

Define the converter above in @com.intellij.util.xmlb.annotations.OptionTag or @com.intellij.util.xmlb.annotations.Attribute:

class State { @OptionTag(converter = LocalDateTimeConverter.class) public LocalDateTime dateTime; }

Defining the Storage Location

To specify where precisely the persisted values are stored, add @State annotation to the PersistentStateComponent class.

It has the following fields:

  • name (required) — specifies the name of the state (name of the root tag in XML).

  • storages — one or more of @com.intellij.openapi.components.Storage annotations to specify the storage locations. Optional for project-level values — standard project file is used in this case.

  • reloadable (optional) — if set to false, a full project (or application) reload is required when the XML file is changed externally, and the state has changed.

The simplest ways of specifying the @Storage annotation are as follows:

  • @Storage("yourName.xml") If a component is project-level — for .ipr based projects standard project file is used automatically - no need to specify anything.

  • @Storage(StoragePathMacros.WORKSPACE_FILE) for values stored in the workspace file.

The state is persisted in a separate file by specifying a different setting for the value parameter, which was the file parameter before 2016.x.

See StoragePathMacros for commonly used values.

The roamingType parameter of the @Storage annotation specifies the roaming type when the settings are shared:

  • RoamingType.DEFAULT - settings are shared

  • RoamingType.PER_OS - settings are shared per operating system

  • RoamingType.DISABLED - settings sharing is disabled

Sharing Settings Between IDE Installations

It is possible to share the persistent state of components between different IDE installations. This allows users to have the same settings on every development machine or to share their settings within a team.

Settings can be shared via the following functionalities:

  • Settings Sync plugin that allows synchronizing settings on JetBrains servers. Users can choose the category of settings that are synchronized.

  • Settings Repository plugin that allows synchronizing settings in a Git repository created and configured by a user.

  • Export Settings feature that allows for the manual import and export of settings.

The decision about making a specific component's state shareable should be made carefully. Only the settings that are not specific to a given machine should be shared, e.g. paths to user-specific directories shouldn't be shared. If a component contains both shareable and non-shareable data, it should be split into two separate components.

Settings Sync Plugin

To include a plugin's component state in the Settings Sync plugin synchronization, the settings category must be specified via the category attribute of the @State annotation. The default SettingsCategory.OTHER value disables synchronization of a component's state.

If the component state is OS-dependent, the roamingType of the @Storage annotation must be set to RoamingType.PER_OS.

Settings Repository Plugin and Export Settings Feature

Persistent components can be shared via the Settings Repository plugin and Export Settings feature, depending on the roamingType of the @Storage annotation. See the Defining the Storage Location for more details.

Customizing the XML Format of Persisted Values

If you want to use the default bean serialization but need to customize the storage format in XML (for example, for compatibility with previous versions of your plugin or externally defined XML formats), you can use the @Tag, @Attribute, @Property, @MapAnnotation, @XCollection annotations.

Please see com.intellij.util.xmlb.annotations's package.html for more information.

If the state you need to serialize doesn't map cleanly to a JavaBean, you can use org.jdom.Element as the state class. In that case, you can use the getState() method to build an XML element with an arbitrary structure, which then is saved directly in the state XML file. In the loadState() method, you can deserialize the JDOM element tree using any custom logic. Please note this is not recommended and should be avoided whenever possible.

Migrating Persisted Values

If the underlying persistence model or storage format has changed, a ConverterProvider can provide ProjectConverter whose getAdditionalAffectedFiles() method returns affected files to migrate and performs programmatic migration of stored values.

Persistent Component Lifecycle

The loadState() method is called after the component has been created (only if there is some non-default state persisted for the component), and after the XML file with the persisted state is changed externally (for example, if the project file was updated from the version control system). In the latter case, the component is responsible for updating the UI and other related components according to the changed state.

The getState() method is called every time the settings are saved (for example, on frame deactivation or when closing the IDE). If the state returned from getState() is equal to the default state (obtained by creating the state class with a default constructor), nothing is persisted in the XML. Otherwise, the returned state is serialized in XML and stored.

Using PropertiesComponent for Simple Non-Roamable Persistence

If the plugin needs to persist just a few simple values, the easiest way to do so is to use the com.intellij.ide.util.PropertiesComponent service. It can save both application-level values and project-level values in the workspace file. Roaming is disabled for PropertiesComponent, so use it only for temporary, non-roamable properties.

Use the PropertiesComponent.getInstance() method for storing application-level values, and the PropertiesComponent.getInstance(Project) method for storing project-level values.

Since all plugins share the same namespace, it is highly recommended prefixing key names (e.g., using plugin ID com.example.myCustomSetting).

Legacy API (JDOMExternalizable)

Older components use the JDOMExternalizable interface for persisting state. It uses the readExternal() method for reading the state from a JDOM element, and writeExternal() to write the state.

Implementations can manually store the state in attributes and sub-elements or use the DefaultJDOMExternalizer class to store the values of all public fields automatically.

Components save their state in the following files:

  • Project-level: project (.ipr) file. However, if the workspace option in the plugin.xml file is set to true, then the workspace (.iws) file is used instead.

  • Module-level: module (.iml) file.

Last modified: 07 December 2022