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 - A type of the items within an array that can this implementation of preference hold and manage its storing/retrieving.

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

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

Author:

Martin Albedinsky

See Also:

ListPreference

Nested Class Summary

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

SharedPreference.PreferenceChangeCallback<PreferenceType>

Constructor Summary

Constructors

Constructor and Description
ArrayPreference(int keyResId, T defValue) Creates a new instance of universum.studios.android.preference.ArrayPreference.
ArrayPreference(String key, T defValue) Creates a new instance of universum.studios.android.preference.ArrayPreference.

Method Summary

Modifier and Type	Method and Description
static <A> A	getFromPreferences(android.content.SharedPreferences preferences, String key, Object defValue) Returns an array mapped in the given shared preferences under the specified key.
protected 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 save the actual value into the given shared preferences.
static boolean	putIntoPreferences(android.content.SharedPreferences preferences, String key, Object array) Saves the given array 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

ArrayPreference

public ArrayPreference(String key,
                       T defValue)

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

Throws:

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

See Also:

SharedPreference.SharedPreference(String, Object)

ArrayPreference

public ArrayPreference(int keyResId,
                       T defValue)

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

Throws:

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

See Also:

SharedPreference.SharedPreference(int, Object)

Method Detail

onPutIntoPreferences

protected boolean onPutIntoPreferences(android.content.SharedPreferences preferences)

Description copied from class: SharedPreference

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

Returns:

True if saving operation succeed, false otherwise.

See Also:

putIntoPreferences(SharedPreferences, String, Object)

putIntoPreferences

public static boolean putIntoPreferences(android.content.SharedPreferences preferences,
                                         String key,
                                         Object array)

Saves the given array into the given shared preferences.

Parameters:

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

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

array - Array to save into preferences.

Returns:

True if saving succeeded, false otherwise.

Throws:

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

onGetFromPreferences

protected T onGetFromPreferences(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<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

public static <A> A getFromPreferences(android.content.SharedPreferences preferences,
                                       String key,
                                       Object defValue)

Returns an array mapped in the given shared preferences under the specified key.

Type Parameters:

A - The type of an array to obtain.

Parameters:

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

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

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

Returns:

An instance of the requested array 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.

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

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