|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.biotools.meerkat.util.Preferences
public class Preferences
Handles the storage and retrieval of program preferences Note. '=' is a reserved character and may not be used to name preferences or within their values.
Constructor Summary | |
---|---|
Preferences()
|
|
Preferences(java.io.File f)
Create a new set of Preferences from a given file. |
|
Preferences(Preferences p)
|
|
Preferences(java.lang.String fname)
Create a new set of Preferences from a given file. |
|
Preferences(java.lang.String prefstr,
java.lang.String delimiter)
Load preferences fresh from disk |
Method Summary | |
---|---|
void |
addPreferenceChangeListener(PreferenceChangeListener l)
|
void |
clearAll()
|
boolean |
empty()
|
void |
firePreferenceChangeEvent(java.lang.String key,
java.lang.String val)
|
java.lang.String |
get(java.lang.String name,
java.lang.String def)
|
boolean |
getBoolean(java.lang.String name,
boolean bool)
|
boolean |
getBooleanPreference(java.lang.String name)
given a key preference name, obtain its value as a boolean value. |
boolean |
getBooleanPreference(java.lang.String name,
boolean def)
given a key preference name, obtain its value as a boolean value. |
double |
getDouble(java.lang.String name,
double d)
|
double |
getDoublePreference(java.lang.String name)
given a key preference name, obtain its value as an int. |
double |
getDoublePreference(java.lang.String name,
double def)
given a key preference name, obtain its value as an int. |
java.io.File |
getFile()
|
java.lang.String |
getFileName()
|
int |
getInt(java.lang.String name,
int i)
|
int |
getIntPreference(java.lang.String name)
given a key preference name, obtain its value as an int. |
int |
getIntPreference(java.lang.String name,
int def)
given a key preference name, obtain its value as an int. |
long |
getLong(java.lang.String name,
long d)
|
long |
getLongPreference(java.lang.String name,
long def)
given a key preference name, obtain its value as an int. |
java.lang.String |
getPreference(java.lang.String name)
given a key preference name, obtain its value. |
java.lang.String |
getPreference(java.lang.String name,
java.lang.String def)
given a key preference name, obtain its value. |
boolean |
hasPreference(java.lang.String key)
See if a preference is set or not |
boolean |
isDirty()
|
java.lang.String[] |
keys()
|
void |
loadPreferences(java.io.File file)
Load preferences fresh from disk |
static java.lang.String |
munkString(java.lang.String s)
convert a string so that it fits all on one line (required for a valid preference string) |
void |
put(java.lang.String key,
java.lang.String val)
|
void |
putBoolean(java.lang.String key,
boolean val)
|
void |
putDouble(java.lang.String key,
double val)
|
void |
putInt(java.lang.String key,
int val)
|
void |
putLong(java.lang.String key,
long val)
|
void |
removePreference(java.lang.String name)
|
void |
removePreferenceChangeListener(PreferenceChangeListener l)
|
void |
savePreferences()
Flush current preferences to disk. |
void |
savePreferences(java.lang.String fName)
Flush current preferences to disk. |
void |
saveSortedPreferences()
Flush current preferences to disk, sorted by key |
void |
setDirty(boolean val)
|
void |
setPreference(java.lang.String name,
boolean val)
Set a preference. |
void |
setPreference(java.lang.String name,
double val)
Set a preference. |
void |
setPreference(java.lang.String name,
int val)
Set a preference. |
void |
setPreference(java.lang.String name,
long val)
Set a preference. |
void |
setPreference(java.lang.String name,
java.lang.String val)
Set a preference. |
java.lang.String |
toString()
|
java.lang.String |
toString(char separator)
|
static java.lang.String |
unmunkString(java.lang.String s)
Take a munked-up string and fix it. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Preferences()
public Preferences(Preferences p)
public Preferences(java.io.File f)
f
- the file name storing preferencespublic Preferences(java.lang.String fname)
fname
- the file name storing preferencespublic Preferences(java.lang.String prefstr, java.lang.String delimiter)
Method Detail |
---|
public boolean empty()
public void clearAll()
public java.lang.String[] keys()
public java.lang.String getPreference(java.lang.String name, java.lang.String def)
name
- the name of the preference.def
- the default to return if value is not present
public java.lang.String getPreference(java.lang.String name)
name
- the name of the preference.
public int getIntPreference(java.lang.String name)
name
- the name of the preference.
public int getIntPreference(java.lang.String name, int def)
name
- the name of the preference.
public long getLongPreference(java.lang.String name, long def)
name
- the name of the preference.
public double getDoublePreference(java.lang.String name, double def)
name
- the name of the preference.def
- the default value to return if it is not present
public double getDoublePreference(java.lang.String name)
name
- the name of the preference.
public boolean getBooleanPreference(java.lang.String name)
name
- the name of the preference.
public boolean getBoolean(java.lang.String name, boolean bool)
public int getInt(java.lang.String name, int i)
public double getDouble(java.lang.String name, double d)
public long getLong(java.lang.String name, long d)
public java.lang.String get(java.lang.String name, java.lang.String def)
public void put(java.lang.String key, java.lang.String val)
public void putDouble(java.lang.String key, double val)
public void putInt(java.lang.String key, int val)
public void putBoolean(java.lang.String key, boolean val)
public void putLong(java.lang.String key, long val)
public boolean getBooleanPreference(java.lang.String name, boolean def)
name
- the name of the preference.def
- the default value to return if it is not present
public void setPreference(java.lang.String name, java.lang.String val)
name
- name of the preference to setval
- value of the preference to setpublic void setPreference(java.lang.String name, int val)
name
- name of the preference to setval
- value of the preference to setpublic void setPreference(java.lang.String name, long val)
name
- name of the preference to setval
- value of the preference to setpublic void setPreference(java.lang.String name, boolean val)
name
- name of the preference to setval
- value of the preference to setpublic void setPreference(java.lang.String name, double val)
name
- name of the preference to setval
- value of the preference to setpublic void savePreferences(java.lang.String fName)
public void savePreferences()
public void saveSortedPreferences()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(char separator)
public void loadPreferences(java.io.File file)
public static java.lang.String munkString(java.lang.String s)
public static java.lang.String unmunkString(java.lang.String s)
public java.lang.String getFileName()
public java.io.File getFile()
public void removePreference(java.lang.String name)
public boolean isDirty()
public void setDirty(boolean val)
public void addPreferenceChangeListener(PreferenceChangeListener l)
public void removePreferenceChangeListener(PreferenceChangeListener l)
public void firePreferenceChangeEvent(java.lang.String key, java.lang.String val)
public boolean hasPreference(java.lang.String key)
key
- the preference key
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |