universum.studios.android.preference

Class BooleanPreference

java.lang.Object

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

universum.studios.android.preference.BooleanPreference

public final class BooleanPreference
extends SharedPreference<Boolean>

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

Author:

Martin Albedinsky

See Also:

StringPreference, IntegerPreference, LongPreference, FloatPreference, EnumPreference

Nested Class Summary

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

SharedPreference.PreferenceChangeCallback<PreferenceType>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Boolean	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

BooleanPreference

public BooleanPreference(@NonNull
                         String key,
                         @NonNull
                         Boolean defValue)

Creates a new instance of BooleanPreference.

See Also:

SharedPreference.SharedPreference(String, Object)

BooleanPreference

public BooleanPreference(@StringRes
                         int keyResId,
                         @NonNull
                         Boolean defValue)

Creates a new instance of BooleanPreference.

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

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

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.