public class Setting
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
Setting.Group
This class manages a group of Settings.
|
static class |
Setting.RootGroup
This class manages a tree of Settings.
|
static class |
Setting.SettingChangeBatch |
Modifier | Constructor and Description |
---|---|
protected |
Setting(java.lang.String prefName,
java.lang.String prefGroup,
Setting.Group xmlGroup,
java.lang.String xmlName,
java.lang.String location,
java.lang.String description,
java.lang.Object factoryObj,
java.lang.String... trueMeaning)
Creates a new instance of Setting
|
Modifier and Type | Method and Description |
---|---|
boolean |
getBoolean()
Method to get the boolean value on this Setting object.
|
java.lang.String |
getDescription()
Method to return the description of this Meaning option.
|
double |
getDouble()
Method to get the double value on this Setting object.
|
double |
getDoubleFactoryValue()
Method to get the factory-default double value of this Pref object.
|
java.lang.Object |
getFactoryValue()
Method to get the factory-default value of this Pref object.
|
int |
getInt()
Method to get the integer value on this Setting object.
|
java.lang.String |
getLocation()
Method to return the user-command that can affect this Meaning option.
|
long |
getLong()
Method to get the long value on this Setting object.
|
java.lang.String |
getPrefName()
Method to get the name of this Setting object.
|
java.lang.String |
getPrefPath()
Method to get the pref name of this Setting object.
|
java.lang.String |
getString()
Method to get the string value on this Setting object.
|
java.lang.String[] |
getTrueMeaning()
Method to return an array of strings to be used for integer Meaning options.
|
java.lang.Object |
getValue()
Method to get the value of this Setting object as an Object.
|
java.lang.Object |
getValueFromPreferences(java.util.prefs.Preferences prefRoot) |
java.lang.String |
getXmlPath()
Method to get the xml name of this Setting object.
|
boolean |
isValidOption()
Method to tell whether this Meaning option is valid and should be reconciled.
|
static Setting.RootGroup |
read(IdReader reader)
Reads a Tree of Settings fro, IdManager reader
|
void |
saveToPreferences(java.util.prefs.Preferences prefRoot,
java.lang.Object v) |
void |
setValidOption(boolean valid)
Method to set whether this Meaning option is valid and should be reconciled.
|
java.lang.String |
toString() |
protected Setting(java.lang.String prefName, java.lang.String prefGroup, Setting.Group xmlGroup, java.lang.String xmlName, java.lang.String location, java.lang.String description, java.lang.Object factoryObj, java.lang.String... trueMeaning)
public static Setting.RootGroup read(IdReader reader) throws java.io.IOException
reader
- IdManager readerjava.io.IOException
- om reader errorpublic boolean getBoolean()
public int getInt()
public long getLong()
public double getDouble()
public java.lang.String getString()
public java.lang.Object getValue()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getXmlPath()
public java.lang.String getPrefName()
public java.lang.String getPrefPath()
public java.lang.String getLocation()
public java.lang.String getDescription()
public void setValidOption(boolean valid)
valid
- true if this Meaning option is valid and should be reconciled.public boolean isValidOption()
public java.lang.String[] getTrueMeaning()
public java.lang.Object getFactoryValue()
public double getDoubleFactoryValue()
public void saveToPreferences(java.util.prefs.Preferences prefRoot, java.lang.Object v)
public java.lang.Object getValueFromPreferences(java.util.prefs.Preferences prefRoot)