textbender.g.util.prefs
Class BooleanPreference

java.lang.Object
  extended by Preference
      extended by BooleanPreference
Direct Known Subclasses:
BooleanPreferenceDC

public class BooleanPreference
extends Preference

A boolean in a preference node.


Field Summary
 
Fields inherited from class Preference
key, preferences
 
Constructor Summary
BooleanPreference(Preferences preferences, String key, boolean def)
          Creates a BooleanPreference.
 
Method Summary
 boolean get()
          Retrieves the value of this preference from storage.
 boolean getDefault()
          Returns the default value of this preference.
 void put(boolean value)
          Stores a new value for the preference.
 void setDefault(boolean newDefault)
          Sets the default value, per getDefault().
 
Methods inherited from class Preference
key, preferences, remove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BooleanPreference

public BooleanPreference(Preferences preferences,
                         String key,
                         boolean def)
Creates a BooleanPreference.

Parameters:
preferences - per preferences()
key - per key()
def - default per getDefault()
Method Detail

get

public boolean get()
Retrieves the value of this preference from storage. Equivalent to preferences.getBoolean(key,default)

Returns:
value if any was stored; else the default

getDefault

public boolean getDefault()
Returns the default value of this preference.


setDefault

public void setDefault(boolean newDefault)
Sets the default value, per getDefault().


put

public void put(boolean value)
Stores a new value for the preference. Equivalent to preferences.putBoolean(key,value).

Parameters:
value - new value of the preference