org.osgl.util

Interface AdaptiveMap<T extends AdaptiveMap>

public interface AdaptiveMap<T extends AdaptiveMap>

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns a Map typed object backed by this active record
boolean	containsKey(String key) Check if the active records has a value associated with key specified
Set<Map.Entry<String,Object>>	entrySet() Returns a set of entries stored in the active record
Set<Map.Entry<String,Object>>	entrySet(Lang.Function<BeanInfo,Boolean> fieldFilter) Returns a set of entries stored in the active record.
<T> T	getValue(String key) Get value from the active record by key specified
Map<String,Object>	internalMap()
Set<String>	keySet() Returns a set of keys that has value stored in the active record
T	mergeValue(String key, Object val) Merge a key/val pair in the active record.
T	mergeValues(Map<String,Object> kvMap) Merge all key/val pairs from specified kv map into this active record
T	putValue(String key, Object val) Add or replace a key/val pair into the active record
T	putValues(Map<String,Object> kvMap) Add all key/val pairs from specified kv map into this active record
int	size() Get the size of the data stored in the active record
Map<String,Object>	toMap() Export the key/val pairs from this active record into a map

Method Detail

internalMap

Map<String,Object> internalMap()

putValue

T putValue(String key,
           Object val)

Add or replace a key/val pair into the active record

Parameters:

key - the key

val - the value

Returns:

the active record instance

mergeValue

T mergeValue(String key,
             Object val)

Merge a key/val pair in the active record.

If the key specified does not exists then insert the key/val pair into the record.

If there are existing key/val pair then merge it with the new one:

1. if the val is simple type or cannot be merged, then replace the existing value with new value
2. if the val can be merged, e.g. it is a POJO or another adaptive record, then merge the new value into the old value. Merge shall happen recursively

Parameters:

key - the key

val - the value

Returns:

the active record instance

putValues

T putValues(Map<String,Object> kvMap)

Add all key/val pairs from specified kv map into this active record

Parameters:

kvMap - the key/value pairs

Returns:

this active record instance

mergeValues

T mergeValues(Map<String,Object> kvMap)

Merge all key/val pairs from specified kv map into this active record

Parameters:

kvMap - the key/value pairs

Returns:

this active record instance

See Also:

mergeValue(String, Object)

getValue

<T> T getValue(String key)

Get value from the active record by key specified

Type Parameters:

T - the generic type of the value

Parameters:

key - the key

Returns:

the value or null if not found

toMap

Map<String,Object> toMap()

Export the key/val pairs from this active record into a map

Returns:

the exported map contains all key/val pairs stored in this active record

size

int size()

Get the size of the data stored in the active record

Returns:

the active record size

containsKey

boolean containsKey(String key)

Check if the active records has a value associated with key specified

Parameters:

key - the key

Returns:

true if there is value associated with the key in the record, or false otherwise

keySet

Set<String> keySet()

Returns a set of keys that has value stored in the active record

Returns:

the key set

entrySet

Set<Map.Entry<String,Object>> entrySet()

Returns a set of entries stored in the active record

Returns:

the entry set

entrySet

Set<Map.Entry<String,Object>> entrySet(Lang.Function<BeanInfo,Boolean> fieldFilter)

Returns a set of entries stored in the active record. For field entries, use the field filter specified to check if it needs to be added into the return set

Parameters:

fieldFilter - the function that returns true or false for bean spec of a certain field declared in the class

Returns:

the entry set with field filter applied

asMap

Map<String,Object> asMap()

Returns a Map typed object backed by this active record

Returns:

a Map backed by this active record