com.amazonaws.internal.keyvaluestore

Class AWSKeyValueStore

java.lang.Object

com.amazonaws.internal.keyvaluestore.AWSKeyValueStore

public class AWSKeyValueStore
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AWSKeyValueStore(android.content.Context context, java.lang.String sharedPreferencesName, boolean isPersistenceEnabled) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all the data stored in this key-value store.
boolean	contains(java.lang.String dataKey) Check if there is a key-value pair for the key passed in.
java.lang.String	get(java.lang.String dataKey) Retrieve the value for the given key from the key-value store.
void	put(java.lang.String dataKey, java.lang.String value) Store the key-value pair in the key-value store.
void	remove(java.lang.String dataKey) Remove the key-value pair identified by the key from the key-value store.
void	setPersistenceEnabled(boolean isPersistenceEnabled) Enable or disable persistence.

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSKeyValueStore

public AWSKeyValueStore(android.content.Context context,
                        java.lang.String sharedPreferencesName,
                        boolean isPersistenceEnabled)

Constructor.

Parameters:

context - the Android application context

sharedPreferencesName - the name of the preferences that namespaces the information to be stored

isPersistenceEnabled - flag if disabled does not store the data in SharedPreferences. enabled (set to true) by default

Method Detail

setPersistenceEnabled

public void setPersistenceEnabled(boolean isPersistenceEnabled)

Enable or disable persistence. Setting isPersistenceEnabled to false will clear the data persisted on SharedPreferences.

Parameters:

isPersistenceEnabled - flag that indicates persistence

contains

public boolean contains(java.lang.String dataKey)

Check if there is a key-value pair for the key passed in.

Parameters:

dataKey - that identifies the key-value pair.

Returns:

true if a key-value pair exists for the key passed in.

get

public java.lang.String get(java.lang.String dataKey)

Retrieve the value for the given key from the key-value store. First, retrieve the data from in-memory cache always. Only if the in-memory cache does not contain the data, go to the persistent store, read the data and return.

Parameters:

dataKey - key that identifies the value to be retrieved.

Returns:

the value corresponding to the key.

put

public void put(java.lang.String dataKey,
                java.lang.String value)

Store the key-value pair in the key-value store. First, store it in-memory. If isPersistenceEnabled is true, store it in the persistent store. In cases of error while persisting to disk, th subsequent read will get null.

Parameters:

dataKey - key that identifies the value

value - data that needs to be stored

remove

public void remove(java.lang.String dataKey)

Remove the key-value pair identified by the key from the key-value store. remove(key) will remove from in-memory and the persistent store if isPersistenceEnabled is true.

Parameters:

dataKey - identifies the key-value pair to be removed

clear

public void clear()

Clears all the data stored in this key-value store. Clears in-memory. If isPersistenceEnabled is true, clears the data persisted on disk.