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 - A type of the enum implementation of which value will this preference manage.

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

A SharedPreference implementation that may be used to manage (store/retrieve) an Enum preference value within SharedPreferences.

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<PreferenceType>

Constructor Summary

Constructors

Constructor and Description
EnumPreference(int keyResId, E defValue) Creates a new instance of EnumPreference.
EnumPreference(String key, E defValue) Creates a new instance of EnumPreference.

Method Summary

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

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

attachKey, createOnChangeListener, getDefaultValue, getKey, getKeyRes, getValue, retrieve, save, 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,
                      @Nullable
                      E defValue)

Creates a new instance of EnumPreference.

See Also:

SharedPreference.SharedPreference(String, Object)

EnumPreference

public EnumPreference(@StringRes
                      int keyResId,
                      @Nullable
                      E defValue)

Creates a new instance of EnumPreference.

See Also:

SharedPreference.SharedPreference(int, Object)

Method Detail

onPutIntoPreferences

@CheckResult
protected boolean onPutIntoPreferences(@NonNull
                                                     SharedPreferences preferences)

Description copied from class: SharedPreference

Invoked to save 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 saved.

Returns:

True if saving operation succeed, false otherwise.

onGetFromPreferences

@Nullable
protected E onGetFromPreferences(@NonNull
                                            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.