com.biotools.meerkat.util
Class Preferences

java.lang.Object
  extended by com.biotools.meerkat.util.Preferences
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
SafePreferences

public class Preferences
extends java.lang.Object
implements java.io.Serializable

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.

See Also:
Serialized Form

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

Preferences

public Preferences()

Preferences

public Preferences(Preferences p)

Preferences

public Preferences(java.io.File f)
Create a new set of Preferences from a given file.

Parameters:
f - the file name storing preferences

Preferences

public Preferences(java.lang.String fname)
Create a new set of Preferences from a given file.

Parameters:
fname - the file name storing preferences

Preferences

public Preferences(java.lang.String prefstr,
                   java.lang.String delimiter)
Load preferences fresh from disk

Method Detail

empty

public boolean empty()

clearAll

public void clearAll()

keys

public java.lang.String[] keys()

getPreference

public java.lang.String getPreference(java.lang.String name,
                                      java.lang.String def)
given a key preference name, obtain its value.

Parameters:
name - the name of the preference.
def - the default to return if value is not present
Returns:
the value of the preference

getPreference

public java.lang.String getPreference(java.lang.String name)
given a key preference name, obtain its value.

Parameters:
name - the name of the preference.
Returns:
the value of the preference

getIntPreference

public int getIntPreference(java.lang.String name)
given a key preference name, obtain its value as an int.

Parameters:
name - the name of the preference.
Returns:
the value of the preference

getIntPreference

public int getIntPreference(java.lang.String name,
                            int def)
given a key preference name, obtain its value as an int.

Parameters:
name - the name of the preference.
Returns:
the value of the preference

getLongPreference

public long getLongPreference(java.lang.String name,
                              long def)
given a key preference name, obtain its value as an int.

Parameters:
name - the name of the preference.
Returns:
the value of the preference

getDoublePreference

public double getDoublePreference(java.lang.String name,
                                  double def)
given a key preference name, obtain its value as an int.

Parameters:
name - the name of the preference.
def - the default value to return if it is not present
Returns:
the value of the preference

getDoublePreference

public double getDoublePreference(java.lang.String name)
given a key preference name, obtain its value as an int.

Parameters:
name - the name of the preference.
Returns:
the value of the preference

getBooleanPreference

public boolean getBooleanPreference(java.lang.String name)
given a key preference name, obtain its value as a boolean value.

Parameters:
name - the name of the preference.
Returns:
the value of the preference

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean bool)

getInt

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

getDouble

public double getDouble(java.lang.String name,
                        double d)

getLong

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

get

public java.lang.String get(java.lang.String name,
                            java.lang.String def)

put

public void put(java.lang.String key,
                java.lang.String val)

putDouble

public void putDouble(java.lang.String key,
                      double val)

putInt

public void putInt(java.lang.String key,
                   int val)

putBoolean

public void putBoolean(java.lang.String key,
                       boolean val)

putLong

public void putLong(java.lang.String key,
                    long val)

getBooleanPreference

public boolean getBooleanPreference(java.lang.String name,
                                    boolean def)
given a key preference name, obtain its value as a boolean value.

Parameters:
name - the name of the preference.
def - the default value to return if it is not present
Returns:
the value of the preference

setPreference

public void setPreference(java.lang.String name,
                          java.lang.String val)
Set a preference.

Parameters:
name - name of the preference to set
val - value of the preference to set

setPreference

public void setPreference(java.lang.String name,
                          int val)
Set a preference.

Parameters:
name - name of the preference to set
val - value of the preference to set

setPreference

public void setPreference(java.lang.String name,
                          long val)
Set a preference.

Parameters:
name - name of the preference to set
val - value of the preference to set

setPreference

public void setPreference(java.lang.String name,
                          boolean val)
Set a preference.

Parameters:
name - name of the preference to set
val - value of the preference to set

setPreference

public void setPreference(java.lang.String name,
                          double val)
Set a preference.

Parameters:
name - name of the preference to set
val - value of the preference to set

savePreferences

public void savePreferences(java.lang.String fName)
Flush current preferences to disk.


savePreferences

public void savePreferences()
Flush current preferences to disk.


saveSortedPreferences

public void saveSortedPreferences()
Flush current preferences to disk, sorted by key


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toString

public java.lang.String toString(char separator)

loadPreferences

public void loadPreferences(java.io.File file)
Load preferences fresh from disk


munkString

public 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)


unmunkString

public static java.lang.String unmunkString(java.lang.String s)
Take a munked-up string and fix it.


getFileName

public java.lang.String getFileName()

getFile

public java.io.File getFile()

removePreference

public void removePreference(java.lang.String name)

isDirty

public boolean isDirty()

setDirty

public void setDirty(boolean val)

addPreferenceChangeListener

public void addPreferenceChangeListener(PreferenceChangeListener l)

removePreferenceChangeListener

public void removePreferenceChangeListener(PreferenceChangeListener l)

firePreferenceChangeEvent

public void firePreferenceChangeEvent(java.lang.String key,
                                      java.lang.String val)

hasPreference

public boolean hasPreference(java.lang.String key)
See if a preference is set or not

Parameters:
key - the preference key
Returns:
true if the preference exists