de.carne.util.prefs

Class BooleanPreference

java.lang.Object

de.carne.util.prefs.Preference<java.lang.Boolean>

de.carne.util.prefs.BooleanPreference

public class BooleanPreference
extends Preference<java.lang.Boolean>

Utility class providing access to a Boolean preference.

Constructor Summary

Constructors

Constructor and Description
BooleanPreference(java.util.prefs.Preferences preferences, java.lang.String key) Construct BooleanPreference.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	fromValue(java.lang.Boolean value) Convert the preference value to it's string representation.
boolean	getBoolean(boolean defaultValue) Get the preference value.
void	putBoolean(boolean value) Set the preference value.
protected java.lang.Boolean	toValue(java.lang.String valueString) Convert the preference's string representation to it's value.

Methods inherited from class de.carne.util.prefs.Preference

get, get, key, preferences, put, remove, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BooleanPreference

public BooleanPreference(java.util.prefs.Preferences preferences,
                         java.lang.String key)

Construct BooleanPreference.

Parameters:

preferences - The Preferences object storing this preference.

key - The preference key.

Method Detail

getBoolean

public boolean getBoolean(boolean defaultValue)

Get the preference value.

Parameters:

defaultValue - The default preference value to return in case the preference is undefined.

Returns:

The preference value.

putBoolean

public void putBoolean(boolean value)

Set the preference value.

Parameters:

value - The value to set.

toValue

protected java.lang.Boolean toValue(java.lang.String valueString)

Description copied from class: Preference

Convert the preference's string representation to it's value.

Specified by:

toValue in class Preference<java.lang.Boolean>

Parameters:

valueString - The string to convert.

Returns:

The converted preference value.

fromValue

protected java.lang.String fromValue(java.lang.Boolean value)

Description copied from class: Preference

Convert the preference value to it's string representation.

Specified by:

fromValue in class Preference<java.lang.Boolean>

Parameters:

value - The value to convert.

Returns:

The converted preference value.