|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IKielerPreferenceStore
Interface for mappings of named preferences to values.
Most of this interface was copied from
IPreferenceStore
.
Inside Eclipse
KielerPreferenceStore
is used as implementation, which is a wrapper for IPreferenceStore
.
In other environments a new implementation must be provided, for which
MapPreferenceStore
can serve as superclass.
Names of preference entries are usually available as constants in the respective plug-ins.
A preference store may be linked to the UI so the user is able to change preference values.
Method Summary | |
---|---|
boolean |
contains(String name)
Returns whether the named preference is known to this preference store. |
boolean |
getBoolean(String name)
Returns the current value of the boolean-valued preference with the given name. |
boolean |
getDefaultBoolean(String name)
Returns the default value for the boolean-valued preference with the given name. |
double |
getDefaultDouble(String name)
Returns the default value for the double-valued preference with the given name. |
float |
getDefaultFloat(String name)
Returns the default value for the float-valued preference with the given name. |
int |
getDefaultInt(String name)
Returns the default value for the integer-valued preference with the given name. |
long |
getDefaultLong(String name)
Returns the default value for the long-valued preference with the given name. |
String |
getDefaultString(String name)
Returns the default value for the string-valued preference with the given name. |
double |
getDouble(String name)
Returns the current value of the double-valued preference with the given name. |
float |
getFloat(String name)
Returns the current value of the float-valued preference with the given name. |
int |
getInt(String name)
Returns the current value of the integer-valued preference with the given name. |
long |
getLong(String name)
Returns the current value of the long-valued preference with the given name. |
String |
getString(String name)
Returns the current value of the string-valued preference with the given name. |
boolean |
isDefault(String name)
Returns whether the current value of the preference with the given name has the default value. |
void |
setDefault(String name,
boolean value)
Sets the default value for the boolean-valued preference with the given name. |
void |
setDefault(String name,
double value)
Sets the default value for the double-valued preference with the given name. |
void |
setDefault(String name,
float value)
Sets the default value for the float-valued preference with the given name. |
void |
setDefault(String name,
int value)
Sets the default value for the integer-valued preference with the given name. |
void |
setDefault(String name,
long value)
Sets the default value for the long-valued preference with the given name. |
void |
setDefault(String name,
String defaultObject)
Sets the default value for the string-valued preference with the given name. |
void |
setToDefault(String name)
Sets the current value of the preference with the given name back to its default value. |
void |
setValue(String name,
boolean value)
Sets the current value of the boolean-valued preference with the given name. |
void |
setValue(String name,
double value)
Sets the current value of the double-valued preference with the given name. |
void |
setValue(String name,
float value)
Sets the current value of the float-valued preference with the given name. |
void |
setValue(String name,
int value)
Sets the current value of the integer-valued preference with the given name. |
void |
setValue(String name,
long value)
Sets the current value of the long-valued preference with the given name. |
void |
setValue(String name,
String value)
Sets the current value of the string-valued preference with the given name. |
Method Detail |
---|
boolean contains(String name)
name
- the name of the preference
true
if either a current value or a default
value is known for the named preference, and false
otherwiseboolean getBoolean(String name)
false
) if there
is no preference with the given name, or if the current value
cannot be treated as a boolean.
name
- the name of the preference
boolean getDefaultBoolean(String name)
false
) if there
is no default preference with the given name, or if the default
value cannot be treated as a boolean.
name
- the name of the preference
double getDefaultDouble(String name)
0.0
) if there
is no default preference with the given name, or if the default
value cannot be treated as a double.
name
- the name of the preference
float getDefaultFloat(String name)
0.0f
) if there
is no default preference with the given name, or if the default
value cannot be treated as a float.
name
- the name of the preference
int getDefaultInt(String name)
0
) if there
is no default preference with the given name, or if the default
value cannot be treated as an integer.
name
- the name of the preference
long getDefaultLong(String name)
0L
) if there
is no default preference with the given name, or if the default
value cannot be treated as a long.
name
- the name of the preference
String getDefaultString(String name)
""
)
if there is no default preference with the given name, or if the default
value cannot be treated as a string.
name
- the name of the preference
double getDouble(String name)
0.0
) if there
is no preference with the given name, or if the current value
cannot be treated as a double.
name
- the name of the preference
float getFloat(String name)
0.0f
) if there
is no preference with the given name, or if the current value
cannot be treated as a float.
name
- the name of the preference
int getInt(String name)
0
) if there
is no preference with the given name, or if the current value
cannot be treated as an integter.
name
- the name of the preference
long getLong(String name)
0L
) if there
is no preference with the given name, or if the current value
cannot be treated as a long.
name
- the name of the preference
String getString(String name)
""
)
if there is no preference with the given name, or if the current value
cannot be treated as a string.
name
- the name of the preference
boolean isDefault(String name)
name
- the name of the preference
true
if the preference has a known default value
and its current value is the same, and false
otherwise
(including the case where the preference is unknown to this store)void setDefault(String name, double value)
Note that the current value of the preference is affected if the preference's current value was its old default value, in which case it changes to the new default value. If the preference's current is different from its old default value, its current value is unaffected.
name
- the name of the preferencevalue
- the new default value for the preferencevoid setDefault(String name, float value)
Note that the current value of the preference is affected if the preference's current value was its old default value, in which case it changes to the new default value. If the preference's current is different from its old default value, its current value is unaffected.
name
- the name of the preferencevalue
- the new default value for the preferencevoid setDefault(String name, int value)
Note that the current value of the preference is affected if the preference's current value was its old default value, in which case it changes to the new default value. If the preference's current is different from its old default value, its current value is unaffected.
name
- the name of the preferencevalue
- the new default value for the preferencevoid setDefault(String name, long value)
Note that the current value of the preference is affected if the preference's current value was its old default value, in which case it changes to the new default value. If the preference's current is different from its old default value, its current value is unaffected.
name
- the name of the preferencevalue
- the new default value for the preferencevoid setDefault(String name, String defaultObject)
Note that the current value of the preference is affected if the preference's current value was its old default value, in which case it changes to the new default value. If the preference's current is different from its old default value, its current value is unaffected.
name
- the name of the preferencedefaultObject
- the new default value for the preferencevoid setDefault(String name, boolean value)
Note that the current value of the preference is affected if the preference's current value was its old default value, in which case it changes to the new default value. If the preference's current is different from its old default value, its current value is unaffected.
name
- the name of the preferencevalue
- the new default value for the preferencevoid setToDefault(String name)
Note that the preferred way of re-initializing a preference to the
appropriate default value is to call setToDefault
.
This is implemented by removing the named value from the store,
thereby exposing the default value.
name
- the name of the preferencevoid setValue(String name, double value)
Note that the preferred way of re-initializing a preference to its
default value is to call setToDefault
.
name
- the name of the preferencevalue
- the new current value of the preferencevoid setValue(String name, float value)
Note that the preferred way of re-initializing a preference to its
default value is to call setToDefault
.
name
- the name of the preferencevalue
- the new current value of the preferencevoid setValue(String name, int value)
Note that the preferred way of re-initializing a preference to its
default value is to call setToDefault
.
name
- the name of the preferencevalue
- the new current value of the preferencevoid setValue(String name, long value)
Note that the preferred way of re-initializing a preference to its
default value is to call setToDefault
.
name
- the name of the preferencevalue
- the new current value of the preferencevoid setValue(String name, String value)
Note that the preferred way of re-initializing a preference to its
default value is to call setToDefault
.
name
- the name of the preferencevalue
- the new current value of the preferencevoid setValue(String name, boolean value)
Note that the preferred way of re-initializing a preference to its
default value is to call setToDefault
.
name
- the name of the preferencevalue
- the new current value of the preference
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |