universum.studios.android.preference

Class FloatPreference

java.lang.Object

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

universum.studios.android.preference.FloatPreference

public final class FloatPreference
extends SharedPreference<Float>

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

Author:

Martin Albedinsky

See Also:

BooleanPreference, IntegerPreference, LongPreference, StringPreference, EnumPreference

Nested Class Summary

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

SharedPreference.PreferenceChangeCallback<PreferenceType>

Constructor Summary

Constructors

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

Method Summary

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

FloatPreference

public FloatPreference(@NonNull
                       String key,
                       @NonNull
                       Float defValue)

Creates a new instance of FloatPreference.

See Also:

SharedPreference.SharedPreference(String, Object)

FloatPreference

public FloatPreference(@StringRes
                       int keyResId,
                       @NonNull
                       Float defValue)

Creates a new instance of FloatPreference.

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

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

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.