universum.studios.android.preference

Class CollectionPreference<T>

java.lang.Object

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

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

Type Parameters:

T - Type of items within a collection of which values should be persisted by CollectionPreference.

public final class CollectionPreference<T>
extends SharedPreference<Collection<T>>

A SharedPreference implementation that may be used to persist a Collection of values via SharedPreferences.

Since:

1.0

Author:

Martin Albedinsky

See Also:

ArrayPreference

Nested Class Summary

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

SharedPreference.PreferenceChangeCallback<P>

Constructor Summary

Constructors

Constructor and Description
CollectionPreference(String key, Class<T> componentType, Collection<T> defValue) Creates a new instance of ListPreference with the specified key and defValue.

Method Summary

Modifier and Type	Method and Description
static <T> Collection<T>	getFromPreferences(android.content.SharedPreferences preferences, String key, Collection<T> defValue) Obtains the array persisted within the given shared preferences for the specified key.
protected Collection<T>	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.
static <T> boolean	putIntoPreferences(android.content.SharedPreferences preferences, String key, Collection<T> value, Class<T> componentType) Persists the given collection value for the specified key 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

CollectionPreference

public CollectionPreference(@NonNull
                            String key,
                            @NonNull
                            Class<T> componentType,
                            @Nullable
                            Collection<T> defValue)

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

Parameters:

componentType - Class of components that can be presented within a collection that is to by persisted by the new collection preference.

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

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.

See Also:

putIntoPreferences(SharedPreferences, String, Collection, Class)

putIntoPreferences

@CheckResult
public static <T> boolean putIntoPreferences(@NonNull
                                                          android.content.SharedPreferences preferences,
                                                          @NonNull
                                                          String key,
                                                          @Nullable
                                                          Collection<T> value,
                                                          @NonNull
                                                          Class<T> componentType)

Persists the given collection value for the specified key into the given shared preferences.

Type Parameters:

T - Type of the component.

Parameters:

preferences - The instance of shared preferences into which should be the given collection persisted.

key - The key for which should be the collection mapped in the shared preferences.

value - The desired collection value to be persisted.

componentType - Class of components presented within the given collection.

Returns:

True if put has been successful, false otherwise.

onGetFromPreferences

@Nullable
protected Collection<T> 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<Collection<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, Collection)

getFromPreferences

public static <T> Collection<T> getFromPreferences(@NonNull
                                                   android.content.SharedPreferences preferences,
                                                   @NonNull
                                                   String key,
                                                   @Nullable
                                                   Collection<T> defValue)

Obtains the array persisted within the given shared preferences for the specified key.

Type Parameters:

T - Type of items of the collection to obtain.

Parameters:

preferences - The instance of shared preferences where is the desired collection persisted.

key - The key for which is the desired collection mapped in the shared preferences.

defValue - Default collection value to return in case when there is no collection value persisted for the specified key yet.

Returns:

Instance of the requested collection or defValue if there is no mapping for the specified key.

Throws:

ClassCastException - If value stored for the specified key does not represent a collection (more specifically an array).

IllegalArgumentException - If type of items of the requested collection is not supported by this library.

IllegalStateException - If the requested collection was not stored by means of this library.