org.osgl.util

Interface KV

All Superinterfaces:

Map<String,ValueObject>

All Known Implementing Classes:

KVStore

public interface KV
extends Map<String,ValueObject>

A instance of `KV` is a Map with ValueObject indexed with String

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
<T> T	getValue(String key) Returns a decoded value by key
KV	putValue(String key, Object val) Add an new pair (key, val) into the store.
KV	putValues(Map<String,Object> kvMap) Put all (key, value) pair from an normal map into this KV map.
Map<String,Object>	toMap() Returns a `Map` contains (key, value) pairs that stored in this `KV` map.

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

Method Detail

putValue

KV putValue(String key,
            Object val)

Add an new pair (key, val) into the store.

Parameters:

key - the key

val - the Object typed value (instead of encoded ValueObject type)

Returns:

this KV instance

getValue

<T> T getValue(String key)

Returns a decoded value by key

Type Parameters:

T - the generic type of the value

Parameters:

key - the key index the value object

Returns:

the decoded value

putValues

KV putValues(Map<String,Object> kvMap)

Put all (key, value) pair from an normal map into this KV map. Note the original map contains String typed key and Object typed value. After they have been put into this KV map. The original value will be encoded by ValueObject

Parameters:

kvMap - the original map

Returns:

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

toMap

Map<String,Object> toMap()

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

Returns:

the map of key and raw value stored in this store