PersistentSettings

internal class PersistentSettings : PersistentStateComponent<Element> (source)

The persistent Settings instance, stored as an Element to allow custom conversion for backwards compatibility.

Constructors

constructor()

Holds constants.

private var loadedState: Element?

Contains the state passed to loadState if loadState failed to deserialize or upgrade the given state, and contains null otherwise.

The Settings that should be persisted, or null if loadState failed to deserialize or upgrade the given state.

open override fun getState(): Element

Returns the settings as an Element.

open override fun loadState(element: Element)

Deserializes element into a Settings instance, which is then stored in settings.

Resets all settings, including any embedded invalidity states.

internal fun upgrade(element: Element, targetVersion: ModuleDescriptor.Version = CURRENT_VERSION): Element

Upgrades the format of the settings contained in element to the newest format compatible with targetVersion.