com.intellij.openapi.components

Annotation Type Storage

@Retention(value=RUNTIME)
public @interface Storage

See Also:

Persisting States

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	NOT_ROAMABLE_FILE Deprecated.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	deprecated If deprecated: Data will be removed on write.
boolean	exclusive
boolean	exportable Is exportable (Export Settings dialog) regardless of roaming type.
java.lang.String	file Deprecated. Use value().
RoamingType	roamingType Used by the Settings Repository plugin to determine how application-level settings should be shared between different IDE installations.
java.lang.Class<? extends StateSplitter>	stateSplitter
java.lang.Class<? extends StateStorage>	storageClass Class must have constructor (String fileSpec, ComponentManager componentManager, StateStorageManager storageManager).
ThreeState	useSaveThreshold Whether to apply save threshold policy (defaults to true if roamingType is set to DISABLED)
java.lang.String	value Relative to component container configuration root path.

Field Detail

NOT_ROAMABLE_FILE

@Deprecated
public static final java.lang.String NOT_ROAMABLE_FILE

Deprecated.

Element Detail

file

@Deprecated
public abstract java.lang.String file

Deprecated. Use value().

Default:

""

value

public abstract java.lang.String value

Relative to component container configuration root path. Consider using shorthand form - @Storage("yourName.xml") (when you need to specify only file path). Consider reusing existing storage files instead of a new one. No one need myriads config files. Related components should reuse storage file.

See Also:

StoragePathMacros

Default:

""

deprecated

public abstract boolean deprecated

If deprecated: Data will be removed on write. And ignored on read if (and only if) new storage exists.

Default:

false

roamingType

public abstract RoamingType roamingType

Used by the Settings Repository plugin to determine how application-level settings should be shared between different IDE installations. You must not store components with different roaming types in one file (value()).

Default:

com.intellij.openapi.components.RoamingType.DEFAULT

storageClass

public abstract java.lang.Class<? extends StateStorage> storageClass

Class must have constructor (String fileSpec, ComponentManager componentManager, StateStorageManager storageManager). componentManager parameter can have more concrete type - e.g. Module (if storage intended to support only one type).

Default:

<error>

stateSplitter

public abstract java.lang.Class<? extends StateSplitter> stateSplitter

Default:

com.intellij.openapi.components.StateSplitterEx.class

useSaveThreshold

public abstract ThreeState useSaveThreshold

Whether to apply save threshold policy (defaults to true if roamingType is set to DISABLED)

Default:

com.intellij.util.ThreeState.UNSURE

exclusive

public abstract boolean exclusive

Default:

false

exportable

public abstract boolean exportable

Is exportable (Export Settings dialog) regardless of roaming type.

Default:

false