org.osgl.util

Class KVStore

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,ValueObject>

org.osgl.util.KVStore

All Implemented Interfaces:

Serializable, Cloneable, Map<String,ValueObject>, KV

public class KVStore
extends HashMap<String,ValueObject>
implements KV

A simple implementation of KV using HashMap

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
KVStore() Create an empty KVStore
KVStore(KVStore copy) Create a KVStore by coping another KVStore
KVStore(Map<String,Object> values) Create a KVStore with a (String, Object) map

Method Summary

Modifier and Type	Method and Description
<T> T	getValue(String key) Get value object value by key from the store.
KVStore	putValue(String key, Object val) Put a simple data into the store with a key.
KVStore	putValues(Map<String,Object> kvMap) Put a map of (key, value) pair into the store.
Map<String,Object>	toMap() Returns a `Map` contains (key, value) pairs that stored in this `KVStore`.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

KVStore

public KVStore()

Create an empty KVStore

KVStore

public KVStore(KVStore copy)

Create a KVStore by coping another KVStore

Parameters:

copy - the KVStore in which all (K,V) pairs will be copied into the new KVStore instance

KVStore

public KVStore(Map<String,Object> values)

Create a KVStore with a (String, Object) map

Parameters:

values - the map in which all entries will be stored into the new KVStore instance

Method Detail

putValue

public KVStore putValue(String key,
                        Object val)

Put a simple data into the store with a key. The type of simple data should be allowed by ValueObject

Specified by:

putValue in interface KV

Parameters:

key - the key

val - the value

Returns:

this store instance after the put operation finished

See Also:

ValueObject

getValue

public <T> T getValue(String key)

Get value object value by key from the store.

Specified by:

getValue in interface KV

Type Parameters:

T - the generic type of the return value

Parameters:

key - the key

Returns:

the value stored in the value object associated with the key

See Also:

ValueObject.value()

putValues

public KVStore putValues(Map<String,Object> kvMap)

Put a map of (key, value) pair into the store. The value could be any type that supported by ValueObject

Specified by:

putValues in interface KV

Parameters:

kvMap - a map of {key, value} pair

Returns:

this KV instance after all pairs has been put into this KV

toMap

public Map<String,Object> toMap()

Returns a `Map` contains (key, value) pairs that stored in this `KVStore`. The value in the pair should be the ValueObject.value() stored in the ValueObject in this `KVStore`

Specified by:

toMap in interface KV

Returns:

the map of key and raw value stored in this store