universum.studios.android.preference

Class StringPreference

java.lang.Object

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

universum.studios.android.preference.StringPreference

public final class StringPreference
extends SharedPreference<String>

A SharedPreference implementation that may be used to persist a String value via SharedPreferences.

Since:

1.0

Author:

Martin Albedinsky

See Also:

BooleanPreference, IntegerPreference, LongPreference, FloatPreference, EnumPreference

Nested Class Summary

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

SharedPreference.PreferenceChangeCallback<P>

Constructor Summary

Constructors

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

Method Summary

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

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

StringPreference

public StringPreference(@NonNull
                        String key,
                        @Nullable
                        String defValue)

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

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

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.

onGetFromPreferences

@Nullable
protected String 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<String>

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.