Package com.intellij.ide.util

Class PropertiesComponent

java.lang.Object

com.intellij.openapi.util.SimpleModificationTracker

com.intellij.ide.util.PropertiesComponent

All Implemented Interfaces:

ModificationTracker

Direct Known Subclasses:

PropertiesComponentImpl

public abstract class PropertiesComponent
extends SimpleModificationTracker

Roaming is disabled for PropertiesComponent, so, use it only and only for temporary non-roamable properties. See http://www.jetbrains.org/intellij/sdk/docs/basics/persisting_state_of_components.html "Using PropertiesComponent for Simple non-roamable Persistence"

Field Summary

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

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
PropertiesComponent()

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(java.lang.String name)
boolean	getBoolean(java.lang.String name, boolean defaultValue)
float	getFloat(java.lang.String name, float defaultValue)
static PropertiesComponent	getInstance()
static PropertiesComponent	getInstance(Project project)
int	getInt(java.lang.String name, int defaultValue)
long	getLong(java.lang.String name, long defaultValue)
java.lang.String	getOrInit(java.lang.String name, java.lang.String defaultValue) Deprecated. Use getValue(String, String)
int	getOrInitInt(java.lang.String name, int defaultValue) Deprecated. Use getInt(String, int) Init was never performed and in any case is not recommended.
long	getOrInitLong(java.lang.String name, long defaultValue) Deprecated. Use #getLong(String, int) Init was never performed and in any case is not recommended.
abstract java.lang.String	getValue(java.lang.String name)
java.lang.String	getValue(java.lang.String name, java.lang.String defaultValue)
abstract java.lang.String []	getValues(java.lang.String name)
boolean	isTrueValue(java.lang.String name)
abstract boolean	isValueSet(java.lang.String name)
boolean	loadFields(java.lang.Object object)
boolean	saveFields(java.lang.Object object)
void	setValue(java.lang.String name, boolean value) Set value or unset if equals to false
abstract void	setValue(java.lang.String name, boolean value, boolean defaultValue) Set value or unset if equals to default
abstract void	setValue(java.lang.String name, float value, float defaultValue) Set value or unset if equals to default value
abstract void	setValue(java.lang.String name, int value, int defaultValue) Set value or unset if equals to default value
abstract void	setValue(java.lang.String name, java.lang.String value) Consider to use setValue(String, String, String) to avoid write defaults.
abstract void	setValue(java.lang.String name, java.lang.String value, java.lang.String defaultValue) Set value or unset if equals to default value
abstract void	setValues(java.lang.String name, java.lang.String[] values)
abstract void	unsetValue(java.lang.String name)

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

Constructor Detail

PropertiesComponent

public PropertiesComponent()

Method Detail

unsetValue

public abstract void unsetValue(java.lang.String name)

isValueSet

public abstract boolean isValueSet(java.lang.String name)

getValue

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

setValue

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

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

setValue

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

Set value or unset if equals to default value

setValue

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

Set value or unset if equals to default value

setValue

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

Set value or unset if equals to default value

setValue

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

Set value or unset if equals to false

setValue

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

Set value or unset if equals to default

getValues

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

setValues

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

getInstance

public static PropertiesComponent getInstance(Project project)

getInstance

public static PropertiesComponent getInstance()

isTrueValue

public final boolean isTrueValue(java.lang.String name)

getBoolean

public final boolean getBoolean(java.lang.String name,
                                boolean defaultValue)

getBoolean

public final boolean getBoolean(java.lang.String name)

getValue

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

getOrInitInt

@Deprecated
public final int getOrInitInt(java.lang.String name,
                              int defaultValue)

Deprecated. Use getInt(String, int) Init was never performed and in any case is not recommended.

getInt

public int getInt(java.lang.String name,
                  int defaultValue)

getLong

public long getLong(java.lang.String name,
                    long defaultValue)

getOrInitLong

@Deprecated
public final long getOrInitLong(java.lang.String name,
                                long defaultValue)

Deprecated. Use #getLong(String, int) Init was never performed and in any case is not recommended.

getOrInit

@Deprecated
public java.lang.String getOrInit(java.lang.String name,
                                  java.lang.String defaultValue)

Deprecated. Use getValue(String, String)

saveFields

public final boolean saveFields(java.lang.Object object)

loadFields

public final boolean loadFields(java.lang.Object object)

getFloat

public float getFloat(java.lang.String name,
                      float defaultValue)