de.carne.util.prefs

Class Preference<T>

java.lang.Object

de.carne.util.prefs.Preference<T>

Type Parameters:

T - The preference type.

Direct Known Subclasses:

BooleanPreference, IntPreference, LongPreference, PathPreference, StringPreference

public abstract class Preference<T>
extends java.lang.Object

Generic base class for preference access.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	fromValue(T value) Convert the preference value to it's string representation.
T	get() Get the preference value.
T	get(T defaultValue) Get the preference value.
java.lang.String	key() Get the preference key.
java.util.prefs.Preferences	preferences() Get the Preferences object storing this preference.
void	put(T value) Set the preference value.
void	remove() Remove the preference value.
java.lang.String	toString()
protected abstract T	toValue(java.lang.String valueString) Convert the preference's string representation to it's value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Preference

protected Preference(java.util.prefs.Preferences preferences,
                     java.lang.String key)

Construct Preference.

Parameters:

preferences - The Preferences object storing this preference.

key - The preference key.

Method Detail

preferences

public java.util.prefs.Preferences preferences()

Get the Preferences object storing this preference.

Returns:

The Preferences object storing this preference.

key

public java.lang.String key()

Get the preference key.

Returns:

The preference key.

get

@Nullable
public T get()

Get the preference value.

Returns:

The found preference value, or null if the preference is undefined.

get

public T get(T defaultValue)

Get the preference value.

Parameters:

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

Returns:

The found preference value.

put

public void put(@Nullable
                T value)

Set the preference value.

Parameters:

value - The value to set. If null the preference is removed.

remove

public void remove()

Remove the preference value.

toValue

@Nullable
protected abstract T toValue(java.lang.String valueString)

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

Parameters:

valueString - The string to convert.

Returns:

The converted preference value.

fromValue

protected abstract java.lang.String fromValue(T value)

Convert the preference value to it's string representation.

Parameters:

value - The value to convert.

Returns:

The converted preference value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object