universum.studios.android.preference

Class ListPreference<T>

java.lang.Object

universum.studios.android.preference.SharedPreference<List<T>>

universum.studios.android.preference.ListPreference<T>

Type Parameters:

T - A type of the items within a list that can this implementation of preference hold and manage its storing/retrieving.

public final class ListPreference<T>
extends SharedPreference<List<T>>

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

Author:

Martin Albedinsky

See Also:

ArrayPreference

Nested Class Summary

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

SharedPreference.PreferenceChangeCallback<PreferenceType>

Constructor Summary

Constructors

Constructor and Description
ListPreference(int keyResId, Class<T> componentType, List<T> defValue) Creates a new instance of universum.studios.android.preference.ListPreference.
ListPreference(String key, Class<T> componentType, List<T> defValue) Creates a new instance of universum.studios.android.preference.ListPreference.

Method Summary

Modifier and Type	Method and Description
static <T> List<T>	getFromPreferences(SharedPreferences preferences, String key, List<T> defValue) Returns a List mapped in the given shared preferences under the specified key.
protected List<T>	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.
static <T> boolean	putIntoPreferences(SharedPreferences preferences, String key, List<T> list, Class<T> componentType) Saves the given list 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

ListPreference

public ListPreference(@NonNull
                      String key,
                      @NonNull
                      Class<T> componentType,
                      @Nullable
                      List<T> defValue)

Creates a new instance of universum.studios.android.preference.ListPreference.

Parameters:

componentType - Class of components that will be presented within a list managed by the new list preference.

See Also:

SharedPreference.SharedPreference(String, Object)

ListPreference

public ListPreference(@StringRes
                      int keyResId,
                      @NonNull
                      Class<T> componentType,
                      @Nullable
                      List<T> defValue)

Creates a new instance of universum.studios.android.preference.ListPreference.

Parameters:

componentType - Class of components that will be presented within a list managed by the new list preference.

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<List<T>>

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.

See Also:

putIntoPreferences(SharedPreferences, String, List, Class)

putIntoPreferences

@CheckResult
public static <T> boolean putIntoPreferences(@NonNull
                                                           SharedPreferences preferences,
                                                           @NonNull
                                                           String key,
                                                           @Nullable
                                                           List<T> list,
                                                           @NonNull
                                                           Class<T> componentType)

Saves the given list into the given shared preferences.

Type Parameters:

T - Type of items which are presented within the given list.

Parameters:

preferences - The instance of shared preferences into which will be the given list saved.

key - The key under which will be the saved list mapped in the shared preferences.

list - List to save into preferences.

componentType - Class of components presented within the given list.

Returns:

True if saving has succeeded, false otherwise.

onGetFromPreferences

@Nullable
protected List<T> 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<List<T>>

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.

See Also:

getFromPreferences(SharedPreferences, String, List)

getFromPreferences

public static <T> List<T> getFromPreferences(@NonNull
                                             SharedPreferences preferences,
                                             @NonNull
                                             String key,
                                             @Nullable
                                             List<T> defValue)

Returns a List mapped in the given shared preferences under the specified key.

Type Parameters:

T - Type of an items which should be presented within the obtained list.

Parameters:

preferences - The instance of shared preferences into which was the requested list before saved.

key - The key under which is the saved list mapped in the shared preferences.

defValue - Default list to return if there is no mapping for the specified key yet.

Returns:

An instance of the requested list or defValue if there is no mapping for the specified key.

Throws:

ClassCastException - If value stored under the specified key does not represents an array/a list.

IllegalArgumentException - If type of the requested list is not supported by the Preferences library.

IllegalStateException - If the requested list was not stored by the Preferences library.