de.carne.util.prefs

Class ObjectPreference<T>

java.lang.Object

de.carne.util.prefs.Preference

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

Type Parameters:

T - The preference type.

public final class ObjectPreference<T>
extends Preference

Utility class for managing a object preference.

Constructor Summary

Constructors

Constructor and Description
ObjectPreference(java.lang.String key, java.util.function.Function<java.lang.String,T> fromStringLambda) Construct ObjectPreference.
ObjectPreference(java.lang.String key, java.util.function.Function<java.lang.String,T> fromStringLambda, java.util.function.Function<T,java.lang.String> toStringLambda) Construct ObjectPreference.

Method Summary

Modifier and Type	Method and Description
T	get(java.util.prefs.Preferences preferences) Get the preference value:
T	get(java.util.prefs.Preferences preferences, T defaultValue) Get the preference value:
void	set(java.util.prefs.Preferences preferences, T value) Set the preference value.

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

key, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectPreference

public ObjectPreference(java.lang.String key,
                        java.util.function.Function<java.lang.String,T> fromStringLambda)

Construct ObjectPreference.

Parameters:

key - The preference key.

fromStringLambda - The lambda function to use for string to object conversion.

ObjectPreference

public ObjectPreference(java.lang.String key,
                        java.util.function.Function<java.lang.String,T> fromStringLambda,
                        java.util.function.Function<T,java.lang.String> toStringLambda)

Construct ObjectPreference.

Parameters:

key - The preference key.

fromStringLambda - The lambda function to use for string to object conversion.

toStringLambda - The lambda function to use for object to string conversion.

Method Detail

get

public T get(java.util.prefs.Preferences preferences)

Get the preference value:

Parameters:

preferences - The Preferences backing up this preference.

Returns:

The preference value or null if the preference is not set.

get

public T get(java.util.prefs.Preferences preferences,
             T defaultValue)

Get the preference value:

Parameters:

preferences - The Preferences backing up this preference.

defaultValue - The default value to return if the preference is not set.

Returns:

The preference value or the submitted default if the preference is not set.

set

public void set(java.util.prefs.Preferences preferences,
                T value)

Set the preference value.

Parameters:

preferences - The Preferences backing up this preference.

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