com.yoti.mobile.android.commons.util

Class DeprecatedSharedPreferencesBase

java.lang.Object

com.yoti.mobile.android.commons.util.SharedPreferencesBase

com.yoti.mobile.android.commons.util.DeprecatedSharedPreferencesBase

Deprecated.

All new SharedPreference implementations should instead use SharedPreferencesBase as to not have to deal with any migration from a non-versioned SharedPreferences to a versioned SharedPreferences.

@Deprecated
public abstract class DeprecatedSharedPreferencesBase
extends SharedPreferencesBase

Provides enhanced usability for persisting data to the default shared preferences file. Only use this implementation of the SharedPreferencesBase when you are dealing with legacy systems that require the preferences to be migrated to having a key prefix. For brand new implementations rather use the SharedPreferencesBase as you will not have to handle any migration code.

As SharedPreferences is just a basic key-value store, subclasses are expected to specify the prefix to be applied to the key to ensure that they are not inadvertently conflicting with other keys.

This DeprecatedSharedPreferencesBase is now versioned. On construction the currently stored version will be checked and if the version of the subclass is found to not be the same SharedPreferencesBase.updateStoreData(int) will be called, incrementally with the new version, until the stored version matches the implementation version.

Subclasses must implement the following methods:

• SharedPreferencesBase.getVersion()
• SharedPreferencesBase.updateStoreData(int)
• getDeprecatedPreferenceKeys()

SharedPreferencesBase.getVersion() must return the implementation version. This is the version that the SharedPreferences should be. If there is a breaking change to the information that is stored then this version should be incremented.

SharedPreferencesBase.updateStoreData(int) must be implemented to perform the necessary updates of the data. This method will be called for every version between the currently stored version and the new implementation version returned by SharedPreferencesBase.getVersion().

getDeprecatedPreferenceKeys() must be implemented to provide information during the migration as to what keys should are deprecated and should be migrated to have the new prefix. This method should ALWAYS return the keys that need to be migrated. An error will be thrown if this list is empty or null.

As of version 0.2.1 the keyPrefix is mandatory. When upgrading from a non-versioned implementation of the DeprecatedSharedPreferencesBase the old keys that did NOT have the keyPrefix will be removed and updated with the new keyPrefix.

Field Summary

Fields inherited from class com.yoti.mobile.android.commons.util.SharedPreferencesBase

DEFAULT_VERSION, mContext, mKeyPrefix, PREF_FILE

Constructor Summary

Constructors

Constructor and Description
DeprecatedSharedPreferencesBase(android.content.Context context, java.lang.String keyPrefix) Deprecated. Initialises a new instance of the DeprecatedSharedPreferencesBase.

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.List<java.lang.String>	getDeprecatedPreferenceKeys() Deprecated. To allow for the migration of the preferences with the deprecated keys we need to define which keys need to be migrated.
protected void	onPreCheckVersion() Deprecated. A hook to allow for subclasses to perform any tasks before the version is checked and any upgrades are done.

Methods inherited from class com.yoti.mobile.android.commons.util.SharedPreferencesBase

buildCompleteKey, contains, getBooleanPreference, getIntPreference, getLongPreference, getSharedEditor, getSharedPreferences, getSharedPreferencesName, getStoredVersion, getStringPreference, getStringSetPreference, getVersion, removePreference, setBooleanPreference, setIntPreference, setLongPreference, setStoredVersion, setStringPreference, setStringSetPreference, updateStoreData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeprecatedSharedPreferencesBase

public DeprecatedSharedPreferencesBase(@NonNull
                                       android.content.Context context,
                                       @NonNull
                                       java.lang.String keyPrefix)

Deprecated.

Initialises a new instance of the DeprecatedSharedPreferencesBase.

On construction the version will be check and if found to be out of date the incremental update will be executed. Keys returned by getDeprecatedPreferenceKeys() will be migrated to use the new key prefix.

Parameters:

context - The Android Context

keyPrefix - The prefix to be used for all keys.

Method Detail

getDeprecatedPreferenceKeys

@NonNull
protected abstract java.util.List<java.lang.String> getDeprecatedPreferenceKeys()

Deprecated.

To allow for the migration of the preferences with the deprecated keys we need to define which keys need to be migrated. This list should be populated with all keys known to have been defined before version 0.2.1 of the DeprecatedSharedPreferencesBase.

Returns:

List of deprecated keys for preferences that need to be migrated. This should NOT be null as every implementation of the DeprecatedSharedPreferencesBase has to have keys with out a prefix that need to be migrated. If an implementation does not have any keys that need to be migrated then rather use SharedPreferencesBase.

onPreCheckVersion

protected final void onPreCheckVersion()

Deprecated.

Description copied from class: SharedPreferencesBase

A hook to allow for subclasses to perform any tasks before the version is checked and any upgrades are done. This is package protected as we don't actually want any implementations outside of this library to perform any checks.

Overrides:

onPreCheckVersion in class SharedPreferencesBase