universum.studios.android.preference

Class ArrayPreference<T>

java.lang.Object

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

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

Type Parameters:

T - Type of items within an array of which values should be persisted by ArrayPreference.

public final class ArrayPreference<T>
extends SharedPreference<T>

A SharedPreference implementation that may be used to persist an array of values via SharedPreferences.

Author:

Martin Albedinsky

See Also:

CollectionPreference

Nested Class Summary

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

SharedPreference.PreferenceChangeCallback<P>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static <A> A	getFromPreferences(SharedPreferences preferences, String key, Object defValue) Obtains the array persisted within the given shared preferences for the specified key.
protected 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 persist the actual value into the given shared preferences.
static boolean	putIntoPreferences(SharedPreferences preferences, String key, Object value) Persists the given array 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

ArrayPreference

public ArrayPreference(@NonNull
                       String key,
                       @Nullable
                       T defValue)

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

Throws:

IllegalArgumentException - If the given defValue is not actually an array.

See Also:

SharedPreference.SharedPreference(String, Object)

Method Detail

onPutIntoPreferences

@CheckResult
protected boolean onPutIntoPreferences(@NonNull
                                                     SharedPreferences preferences)

Description copied from class: SharedPreference

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

Specified by:

onPutIntoPreferences in class SharedPreference<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, Object)

putIntoPreferences

@CheckResult
public static boolean putIntoPreferences(@NonNull
                                                       SharedPreferences preferences,
                                                       @NonNull
                                                       String key,
                                                       @Nullable
                                                       Object value)

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

Parameters:

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

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

value - The desired array value to be persisted.

Returns:

True if put has been successful, false otherwise.

Throws:

IllegalArgumentException - If the given value is not actually an array.

onGetFromPreferences

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

getFromPreferences

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

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

Type Parameters:

A - Type of the array to obtain.

Parameters:

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

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

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

Returns:

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

Throws:

ClassCastException - If value stored for the specified key does not represent an array.

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

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