universum.studios.android.preference.crypto

Class CryptoSharedPreferences.Builder

java.lang.Object

universum.studios.android.preference.crypto.CryptoSharedPreferences.Builder

Enclosing class:

CryptoSharedPreferences

public static final class CryptoSharedPreferences.Builder
extends Object

Builder that may be used to create instances of CryptoSharedPreferences with a desired configuration.

Required parameters

Parameters specified below are required in order to create a new instance of CryptoSharedPreferences via build() successfully.

• #Builder(SharedPreferences)
• valueCrypto(Crypto)

Since:

2.0

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
Builder(SharedPreferences preferences) Creates a new instance of Builder with the given shared preferences instance.

Method Summary

Modifier and Type	Method and Description
CryptoSharedPreferences	build() Builds a new instance of CryptoSharedPreferences with the configuration specified for this builder.
CryptoSharedPreferences.Builder	keyCrypto(Crypto crypto) Specifies an implementation of Crypto that should be used by CryptoSharedPreferences for encryption and decryption of preference keys for which are values persisted in preferences specified via #Builder(SharedPreferences).
CryptoSharedPreferences.Builder	valueCache(SharedPreferencesCache cache) Specifies a cache that should be used by CryptoSharedPreferences to store already decrypted preference values in order to speed up obtaining process of such values from shared preferences.
CryptoSharedPreferences.Builder	valueCrypto(Crypto crypto) Specifies an implementation of Crypto that should be used by CryptoSharedPreferences for encryption and decryption of preference values persisted in preferences specified via #Builder(SharedPreferences).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NonNull
               SharedPreferences preferences)

Creates a new instance of Builder with the given shared preferences instance.

Parameters:

preferences - The preferences instance that will be used by CryptoSharedPreferences for persistence of encrypted values.

Method Detail

keyCrypto

public CryptoSharedPreferences.Builder keyCrypto(@Nullable
                                                 Crypto crypto)

Specifies an implementation of Crypto that should be used by CryptoSharedPreferences for encryption and decryption of preference keys for which are values persisted in preferences specified via #Builder(SharedPreferences).

Note, that when key crypto is specified all OnSharedPreferenceChangeListener listeners that are registered via SharedPreferences.registerOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener) will be notified with already decrypted key of the changed preference. However any change listener that is registered directly on the encrypted preferences instance will be notified with encrypted key of the changed preference. It is recommended to use registration method of CryptoSharedPreferences so the listeners do not need to deal with decryption of the preference keys nor values.

See Keys Encryption section in description of CryptoSharedPreferences for more information.

Parameters:

crypto - The desired crypto implementation. May be null to not encrypt nor decrypt preference keys.

Returns:

This builder to allow methods chaining.

See Also:

valueCrypto(Crypto)

valueCrypto

public CryptoSharedPreferences.Builder valueCrypto(@NonNull
                                                   Crypto crypto)

Specifies an implementation of Crypto that should be used by CryptoSharedPreferences for encryption and decryption of preference values persisted in preferences specified via #Builder(SharedPreferences).

If encryption and decryption of preference values shows up as a time consuming operation that slows up putting and obtaining of those values from shared preferences a cache may be specified via valueCache(SharedPreferencesCache). This cache will be then used by CryptoSharedPreferences for storing of already decrypted preference values so such values may be obtained in a much faster fashion.

See Values Encryption section in description of CryptoSharedPreferences for more information.

Parameters:

crypto - The desired crypto implementation to be used for values encryption/decryption.

Returns:

This builder to allow methods chaining.

See Also:

keyCrypto(Crypto)

valueCache

public CryptoSharedPreferences.Builder valueCache(@Nullable
                                                  SharedPreferencesCache cache)

Specifies a cache that should be used by CryptoSharedPreferences to store already decrypted preference values in order to speed up obtaining process of such values from shared preferences.

See Caching section in description of CryptoSharedPreferences for more information.

Parameters:

cache - The desired cache for decrypted preference values. May be null to not cache decrypted values.

Returns:

This builder to allow methods chaining.

See Also:

valueCrypto(Crypto)

build

@NonNull
public CryptoSharedPreferences build()

Builds a new instance of CryptoSharedPreferences with the configuration specified for this builder.

Returns:

Instance of preferences with encryption and decryption support ready to be used.

Throws:

IllegalArgumentException - If some of the required parameters is missing.