universum.studios.android.preference

Class EnumPreference<E extends Enum>

java.lang.Object

universum.studios.android.preference.SharedPreference<E>

universum.studios.android.preference.EnumPreference<E>

Type Parameters:

E - Type of the enum implementation of which value should be persisted.

public final class EnumPreference<E extends Enum>
extends SharedPreference<E>

A SharedPreference implementation that may be used to persist an Enum value via SharedPreferences.

Since:

1.0

Author:

Martin Albedinsky

See Also:

BooleanPreference, IntegerPreference, LongPreference, StringPreference, FloatPreference

Nested Class Summary

Nested classes/interfaces inherited from class universum.studios.android.preference.SharedPreference

SharedPreference.PreferenceChangeCallback<P>

Constructor Summary

Constructors

Constructor and Description
EnumPreference(String key, E defValue) Creates a new instance of EnumPreference with the specified key and defValue.

Method Summary

Modifier and Type	Method and Description
protected E	onGetFromPreferences(android.content.SharedPreferences preferences) Invoked to retrieve the actual value of this preference from the given shared preferences.
protected boolean	onPutIntoPreferences(android.content.SharedPreferences preferences) Invoked to persist the actual value into the given shared preferences.

Methods inherited from class universum.studios.android.preference.SharedPreference

createOnChangeListener, getDefaultValue, getKey, getValue, putIntoPreferences, updateValue

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumPreference

public EnumPreference(@NonNull
                      String key,
                      @NonNull
                      E defValue)

Creates a new instance of EnumPreference with the specified key and defValue.

See Also:

SharedPreference.SharedPreference(String, Object)

Method Detail

onPutIntoPreferences

@CheckResult
protected boolean onPutIntoPreferences(@NonNull
                                                    android.content.SharedPreferences preferences)

Description copied from class: SharedPreference

Invoked to persist the actual value into the given shared preferences.

Specified by:

onPutIntoPreferences in class SharedPreference<E extends Enum>

Parameters:

preferences - The instance of shared preferences into which should be the current value of this preference persisted.

Returns:

True if put has been successful, false otherwise.

onGetFromPreferences

@Nullable
protected E onGetFromPreferences(@NonNull
                                           android.content.SharedPreferences preferences)

Description copied from class: SharedPreference

Invoked to retrieve the actual value of this preference from the given shared preferences.

Specified by:

onGetFromPreferences in class SharedPreference<E extends Enum>

Parameters:

preferences - The instance of shared preferences into which was the value of this preference before saved.

Returns:

The actual value of this preference from the given shared preferences.