Package com.intellij.ide.util

Class PropertiesComponentImpl

java.lang.Object

com.intellij.openapi.util.SimpleModificationTracker

com.intellij.ide.util.PropertiesComponent

com.intellij.ide.util.PropertiesComponentImpl

All Implemented Interfaces:

PersistentStateComponent<Element>, ModificationTracker

Direct Known Subclasses:

AppPropertiesComponentImpl, ProjectPropertiesComponentImpl

public class PropertiesComponentImpl
extends PropertiesComponent
implements PersistentStateComponent<Element>

Field Summary

Fields inherited from interface com.intellij.openapi.util.ModificationTracker

EVER_CHANGED, NEVER_CHANGED

Method Summary

Modifier and Type	Method and Description
Element	getState()
java.lang.String	getValue(java.lang.String name)
java.lang.String []	getValues(java.lang.String name)
boolean	isValueSet(java.lang.String name)
void	loadState(Element parentNode) This method is called when new component state is loaded.
void	setValue(java.lang.String name, boolean value, boolean defaultValue) Set value or unset if equals to default
void	setValue(java.lang.String name, float value, float defaultValue) Set value or unset if equals to default value
void	setValue(java.lang.String name, int value, int defaultValue) Set value or unset if equals to default value
void	setValue(java.lang.String name, java.lang.String value) Consider to use PropertiesComponent.setValue(String, String, String) to avoid write defaults.
void	setValue(java.lang.String name, java.lang.String value, java.lang.String defaultValue) Set value or unset if equals to default value
void	setValues(java.lang.String name, java.lang.String[] values)
void	unsetValue(java.lang.String name)

Methods inherited from class com.intellij.ide.util.PropertiesComponent

getBoolean, getBoolean, getFloat, getInstance, getInstance, getInt, getLong, getOrInit, getOrInitInt, getOrInitLong, getValue, isTrueValue, loadFields, saveFields, setValue

Methods inherited from class com.intellij.openapi.util.SimpleModificationTracker

getModificationCount, incModificationCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Method Detail

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

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

public void loadState(Element parentNode)

Description copied from interface: PersistentStateComponent

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.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

parentNode - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

getValue

public java.lang.String getValue(java.lang.String name)

Specified by:

getValue in class PropertiesComponent

setValue

public void setValue(java.lang.String name,
                     java.lang.String value)

Description copied from class: PropertiesComponent

Consider to use PropertiesComponent.setValue(String, String, String) to avoid write defaults.

Specified by:

setValue in class PropertiesComponent

setValue

public void setValue(java.lang.String name,
                     java.lang.String value,
                     java.lang.String defaultValue)

Description copied from class: PropertiesComponent

Set value or unset if equals to default value

Specified by:

setValue in class PropertiesComponent

setValue

public void setValue(java.lang.String name,
                     float value,
                     float defaultValue)

Description copied from class: PropertiesComponent

Set value or unset if equals to default value

Specified by:

setValue in class PropertiesComponent

setValue

public void setValue(java.lang.String name,
                     int value,
                     int defaultValue)

Description copied from class: PropertiesComponent

Set value or unset if equals to default value

Specified by:

setValue in class PropertiesComponent

setValue

public void setValue(java.lang.String name,
                     boolean value,
                     boolean defaultValue)

Description copied from class: PropertiesComponent

Set value or unset if equals to default

Specified by:

setValue in class PropertiesComponent

unsetValue

public void unsetValue(java.lang.String name)

Specified by:

unsetValue in class PropertiesComponent

isValueSet

public boolean isValueSet(java.lang.String name)

Specified by:

isValueSet in class PropertiesComponent

getValues

public java.lang.String [] getValues(java.lang.String name)

Specified by:

getValues in class PropertiesComponent

setValues

public void setValues(java.lang.String name,
                      java.lang.String[] values)

Specified by:

setValues in class PropertiesComponent