com.github.jmatsu.multipreference

Interface DataStore

public interface DataStore

Method Summary

Modifier and Type	Method and Description
void	beginTransaction() Begin a transaction.
void	cancelTransaction() Drop modifications which are applied in the current transaction.
void	clear() clear all.
boolean	contains(java.lang.String key) Returns if this data store has a value which is associated to a given key
void	destroySelf() destroy a file.
boolean	finishTransaction(boolean commit) Finish the current transaction successfully
java.util.Map<java.lang.String,?>	getAll() Returns all pairs of key and value which are stored.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Obtain a boolean String value from this data store.
float	getFloat(java.lang.String key, float defaultValue) Obtain a float value from this data store.
int	getInt(java.lang.String key, int defaultValue) Obtain an int value from this data store.
long	getLong(java.lang.String key, long defaultValue) Obtain a long value from this data store.
java.lang.String	getNonNullString(java.lang.String key, java.lang.String defaultValue) Obtain a non-null String value from this data store.
java.util.Set<java.lang.String>	getNonNullStringSet(java.lang.String key, java.util.Set<java.lang.String> defaultValue) Obtain a nonnull Set of String value from this data store.
java.lang.String	getNullableString(java.lang.String key, java.lang.String defaultValue) Obtain a nullable String value from this data store.
java.util.Set<java.lang.String>	getNullableStringSet(java.lang.String key, java.util.Set<java.lang.String> defaultValue) Obtain a nullable Set of String value from this data store.
boolean	isDestroyed() whether or not destroySelf() is called.
boolean	isInTransaction() Whether or not this data store is in a transaction
void	setBoolean(java.lang.String key, boolean value) Set a boolean value to this data store immediately.
void	setFloat(java.lang.String key, float value) Set a float value to this data store immediately.
void	setInt(java.lang.String key, int value) Set an int value to this data store immediately.
void	setLong(java.lang.String key, long value) Set a long value to this data store immediately.
void	setNonNullString(java.lang.String key, java.lang.String value) Set a nonnull String value to this data store immediately.
void	setNonNullStringSet(java.lang.String key, java.util.Set<java.lang.String> value) Set a nullable Set of String value to this data store immediately.
void	setNullableString(java.lang.String key, java.lang.String value) Set a nullable String value to this data store immediately.
void	setNullableStringSet(java.lang.String key, java.util.Set<java.lang.String> value) Set a nullable Set of String value to this data store immediately.

Method Detail

getAll

@NonNull
java.util.Map<java.lang.String,?> getAll()

Returns all pairs of key and value which are stored.

Returns:

a map of all keys and values. This map is not modifiable.

See Also:

SharedPreferences.getAll()

contains

boolean contains(@NonNull
                 java.lang.String key)

Returns if this data store has a value which is associated to a given key

Parameters:

key - a name of this data store to obtain

Returns:

whether or not a key has a non-null value.

See Also:

SharedPreferences.contains(String)

getNullableString

@Nullable
java.lang.String getNullableString(@NonNull
                                             java.lang.String key,
                                             @Nullable
                                             java.lang.String defaultValue)

Obtain a nullable String value from this data store. This may throw ClassCastException if an associated value is not an instance of String except null

Parameters:

key - a name of this data store to obtain

defaultValue - to be returned if a key doesn't have a non-null value.

Returns:

a value which is associated with a key, or defaultValue.

getNonNullString

@NonNull
java.lang.String getNonNullString(@NonNull
                                           java.lang.String key,
                                           @NonNull
                                           java.lang.String defaultValue)

Obtain a non-null String value from this data store. This may throw ClassCastException if an associated value is not an instance of String except null

Parameters:

key - a name of this data store to obtain

defaultValue - to be returned if a key doesn't have a non-null value.

Returns:

a value which is associated with a key, or defaultValue.

getNullableStringSet

@Nullable
java.util.Set<java.lang.String> getNullableStringSet(@NonNull
                                                               java.lang.String key,
                                                               @Nullable
                                                               java.util.Set<java.lang.String> defaultValue)

Obtain a nullable Set of String value from this data store. This may throw ClassCastException if an associated value is not an instance of Set<String> except null

Parameters:

key - a name of this data store to obtain

defaultValue - to be returned if a key doesn't have a non-null value.

Returns:

a value which is associated with a key, or defaultValue.

getNonNullStringSet

@NonNull
java.util.Set<java.lang.String> getNonNullStringSet(@NonNull
                                                             java.lang.String key,
                                                             @NonNull
                                                             java.util.Set<java.lang.String> defaultValue)

Obtain a nonnull Set of String value from this data store. This may throw ClassCastException if an associated value is not an instance of Set<String> except null

Parameters:

key - a name of this data store to obtain

defaultValue - to be returned if a key doesn't have a non-null value.

Returns:

a value which is associated with a key, or defaultValue.

getInt

int getInt(@NonNull
           java.lang.String key,
           int defaultValue)

Obtain an int value from this data store. This may throw ClassCastException if an associated value is not an instance of int

Parameters:

key - a name of this data store to obtain

defaultValue - to be returned if a key doesn't have a non-null value.

Returns:

a value which is associated with a key, or defaultValue.

getLong

long getLong(@NonNull
             java.lang.String key,
             long defaultValue)

Obtain a long value from this data store. This may throw ClassCastException if an associated value is not an instance of long

Parameters:

key - a name of this data store to obtain

defaultValue - to be returned if a key doesn't have a non-null value.

Returns:

a value which is associated with a key, or defaultValue.

getFloat

float getFloat(@NonNull
               java.lang.String key,
               float defaultValue)

Obtain a float value from this data store. This may throw ClassCastException if an associated value is not an instance of float

Parameters:

key - a name of this data store to obtain

defaultValue - to be returned if a key doesn't have a non-null value.

Returns:

a value which is associated with a key, or defaultValue.

getBoolean

boolean getBoolean(@NonNull
                   java.lang.String key,
                   boolean defaultValue)

Obtain a boolean String value from this data store. This may throw ClassCastException if an associated value is not an instance of boolean

Parameters:

key - a name of this data store to obtain

defaultValue - to be returned if a key doesn't have a non-null value.

Returns:

a value which is associated with a key, or defaultValue.

setNullableString

void setNullableString(@NonNull
                       java.lang.String key,
                       @Nullable
                       java.lang.String value)

Set a nullable String value to this data store immediately.

Parameters:

key - a name of this data store to obtain

value - to be set

setNonNullString

void setNonNullString(@NonNull
                      java.lang.String key,
                      @NonNull
                      java.lang.String value)

Set a nonnull String value to this data store immediately.

Parameters:

key - a name of this data store to obtain

value - to be set

setNullableStringSet

void setNullableStringSet(@NonNull
                          java.lang.String key,
                          @Nullable
                          java.util.Set<java.lang.String> value)

Set a nullable Set of String value to this data store immediately.

Parameters:

key - a name of this data store to obtain

value - to be set

setNonNullStringSet

void setNonNullStringSet(@NonNull
                         java.lang.String key,
                         @NonNull
                         java.util.Set<java.lang.String> value)

Set a nullable Set of String value to this data store immediately.

Parameters:

key - a name of this data store to obtain

value - to be set

setInt

void setInt(@NonNull
            java.lang.String key,
            int value)

Set an int value to this data store immediately.

Parameters:

key - a name of this data store to obtain

value - to be set

setLong

void setLong(@NonNull
             java.lang.String key,
             long value)

Set a long value to this data store immediately.

Parameters:

key - a name of this data store to obtain

value - to be set

setFloat

void setFloat(@NonNull
              java.lang.String key,
              float value)

Set a float value to this data store immediately.

Parameters:

key - a name of this data store to obtain

value - to be set

setBoolean

void setBoolean(@NonNull
                java.lang.String key,
                boolean value)

Set a boolean value to this data store immediately.

Parameters:

key - a name of this data store to obtain

value - to be set

beginTransaction

void beginTransaction()

Begin a transaction.

See Also:

finishTransaction(boolean), cancelTransaction()

finishTransaction

boolean finishTransaction(boolean commit)

Finish the current transaction successfully

Parameters:

commit - whether do use SharedPreferences.Editor#commit() or not

Returns:

committed or applied successfully.

cancelTransaction

void cancelTransaction()

Drop modifications which are applied in the current transaction.

isInTransaction

boolean isInTransaction()

Whether or not this data store is in a transaction

Returns:

If this data store is in a transaction, this returns true. Otherwise, false.

clear

void clear()

clear all. This will ignore transaction.

destroySelf

void destroySelf()

destroy a file. Destroyed datastore cannot be used anymore.

isDestroyed

boolean isDestroyed()

whether or not destroySelf() is called.