universum.studios.android.preference

Interface SharedPreferencesCache

public interface SharedPreferencesCache

Interface that specifies a layer for caches that may be used to store values of SharedPreferences in a memory.

Since:

2.0

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SharedPreferencesCache.NotInCacheException An exception that may be used by implementations of SharedPreferencesCache to indicate that they have no value stored for a requested key.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String key) Checks whether there is stored value for the specified key in this cache.
boolean	evict(String key) Evicts a value for the specified key stored in this cache.
int	evictAll() Evicts all values stored in this cache.
boolean	getBoolean(String key) Retrieves the boolean value for the specified key stored in this cache.
float	getFloat(String key) Retrieves the float value for the specified key stored in this cache.
int	getInt(String key) Retrieves the integer value for the specified key stored in this cache.
long	getLong(String key) Retrieves the long value for the specified key stored in this cache.
String	getString(String key) Retrieves the string value for the specified key stored in this cache.
Set<String>	getStringSet(String key) Retrieves the set of string values for the specified key stored in this cache.
boolean	isEmpty() Checks whether this cache is empty or not.
boolean	putBoolean(String key, boolean value) Puts the given boolean value for the specified key into this cache.
boolean	putFloat(String key, float value) Puts the given float value for the specified key into this cache.
boolean	putInt(String key, int value) Puts the given integer value for the specified key into this cache.
boolean	putLong(String key, long value) Puts the given long value for the specified key into this cache.
boolean	putString(String key, String value) Puts the given string value for the specified key into this cache.
boolean	putStringSet(String key, Set<String> values) Puts the given set of string values for the specified key into this cache.

Method Detail

isEmpty

boolean isEmpty()

Checks whether this cache is empty or not.

Returns:

True if this cache does not have any values stored, false if there is at least one value stored.

contains

boolean contains(@NonNull
                 String key)

Checks whether there is stored value for the specified key in this cache.

Parameters:

key - The key of which value presence to check.

Returns:

True if there is value presented for the specified key, false otherwise.

putString

boolean putString(@NonNull
                  String key,
                  @Nullable
                  String value)

Puts the given string value for the specified key into this cache.

If there is already stored value for the specified key in this cache it will be replaced by the new one.

Parameters:

key - The key for which to put the value into cache.

value - The desired value to put into cache.

Returns:

True if put has been successful, false otherwise.

getString

@Nullable
String getString(@NonNull
                           String key)

Retrieves the string value for the specified key stored in this cache.

Parameters:

key - The key for which to retrieve its associated value.

Returns:

The value associated with the key.

Throws:

SharedPreferencesCache.NotInCacheException - If there is no value stored in this cache for the requested key.

See Also:

contains(String)

putStringSet

boolean putStringSet(@NonNull
                     String key,
                     @Nullable
                     Set<String> values)

Puts the given set of string values for the specified key into this cache.

If there is already stored value for the specified key in this cache it will be replaced by the new one.

Parameters:

key - The key for which to put the value into cache.

values - The desired set of values to put into cache.

Returns:

True if put has been successful, false otherwise.

getStringSet

@Nullable
Set<String> getStringSet(@NonNull
                                   String key)

Retrieves the set of string values for the specified key stored in this cache.

Parameters:

key - The key for which to retrieve its associated value.

Returns:

The set of values associated with the key.

Throws:

SharedPreferencesCache.NotInCacheException - If there is no value stored in this cache for the requested key.

See Also:

contains(String)

putInt

boolean putInt(@NonNull
               String key,
               int value)

Puts the given integer value for the specified key into this cache.

If there is already stored value for the specified key in this cache it will be replaced by the new one.

Parameters:

key - The key for which to put the value into cache.

value - The desired value to put into cache.

Returns:

True if put has been successful, false otherwise.

getInt

int getInt(@NonNull
           String key)

Retrieves the integer value for the specified key stored in this cache.

Parameters:

key - The key for which to retrieve its associated value.

Returns:

The value associated with the key.

Throws:

SharedPreferencesCache.NotInCacheException - If there is no value stored in this cache for the requested key.

See Also:

contains(String)

putFloat

boolean putFloat(@NonNull
                 String key,
                 float value)

Puts the given float value for the specified key into this cache.

If there is already stored value for the specified key in this cache it will be replaced by the new one.

Parameters:

key - The key for which to put the value into cache.

value - The desired value to put into cache.

Returns:

True if put has been successful, false otherwise.

getFloat

float getFloat(@NonNull
               String key)

Retrieves the float value for the specified key stored in this cache.

Parameters:

key - The key for which to retrieve its associated value.

Returns:

The value associated with the key.

Throws:

SharedPreferencesCache.NotInCacheException - If there is no value stored in this cache for the requested key.

See Also:

contains(String)

putLong

boolean putLong(@NonNull
                String key,
                long value)

Puts the given long value for the specified key into this cache.

If there is already stored value for the specified key in this cache it will be replaced by the new one.

Parameters:

key - The key for which to put the value into cache.

value - The desired value to put into cache.

Returns:

True if put has been successful, false otherwise.

getLong

long getLong(@NonNull
             String key)

Retrieves the long value for the specified key stored in this cache.

Parameters:

key - The key for which to retrieve its associated value.

Returns:

The value associated with the key.

Throws:

SharedPreferencesCache.NotInCacheException - If there is no value stored in this cache for the requested key.

See Also:

contains(String)

putBoolean

boolean putBoolean(@NonNull
                   String key,
                   boolean value)

Puts the given boolean value for the specified key into this cache.

If there is already stored value for the specified key in this cache it will be replaced by the new one.

Parameters:

key - The key for which to put the value into cache.

value - The desired value to put into cache.

Returns:

True if put has been successful, false otherwise.

getBoolean

boolean getBoolean(@NonNull
                   String key)

Retrieves the boolean value for the specified key stored in this cache.

Parameters:

key - The key for which to retrieve its associated value.

Returns:

The value associated with the key.

Throws:

SharedPreferencesCache.NotInCacheException - If there is no value stored in this cache for the requested key.

See Also:

contains(String)

evict

boolean evict(@NonNull
              String key)

Evicts a value for the specified key stored in this cache.

Parameters:

key - The key for which to evict its associated value.

Returns:

True if value associated with the key has been evicted, false if there was no value stored in this cache for the specified key.

evictAll

int evictAll()

Evicts all values stored in this cache.

Returns:

The number of values that has been evicted. May be 0 if this cache is empty.