com.edorasware.api.value

Class ValueMap

java.lang.Object

com.edorasware.api.value.ValueMap

public final class ValueMap
extends Object

Manages a collection of named values as persisted in a work object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValueMap.Builder Builder for a ValueMap instance.

Method Summary

Modifier and Type	Method and Description
static ValueMap.Builder	builder() Creates a builder for a new value map instance.
static ValueMap.Builder	builder(ValueMap template) Creates a builder for a new value map instance from the given template map.
ValueMap	filter(Predicate<Map.Entry<String,Object>> predicate) Filers values in the instance based on the input predicate
<T> T	getValue(String name, Class<T> requiredType) Returns the value with the given name, cast to the expected type.
<V> V	getValue(ValueAccessor<V> valueAccessor) Returns the de-serialized value referenced by the given value accessor.
static ValueMap	of() Creates an empty value map.
static ValueMap	of(Map<String,Object> values) Creates a value map from the given serialized values.
static ValueMap	of(String name, Object value) Creates a new value map from the given name/value pair.
static ValueMap	of(String name1, Object value1, String name2, Object value2) Creates a new value map from the given name/value pairs.
static ValueMap	of(String name1, Object value1, String name2, Object value2, String name3, Object value3) Creates a new value map from the given name/value pairs.
static <V> ValueMap	of(ValueAccessor<V> valueAccessor, V value) Creates a new value map from the given name/value pair.
static <V1,V2> ValueMap	of(ValueAccessor<V1> accessor1, V1 value1, ValueAccessor<V2> accessor2, V2 value2) Creates a new value map from the given name/value pairs.
static <V1,V2,V3> ValueMap	of(ValueAccessor<V1> accessor1, V1 value1, ValueAccessor<V2> accessor2, V2 value2, ValueAccessor<V3> accessor3, V3 value3) Creates a new value map from the given name/value pairs.
Map<String,Object>	toMap() Returns the serialized value data represented as a plain map with key/value pairs.

Methods inherited from class java.lang.Object

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

Method Detail

toMap

public Map<String,Object> toMap()

Returns the serialized value data represented as a plain map with key/value pairs.

Returns:

the serialized values

getValue

public <V> V getValue(ValueAccessor<V> valueAccessor)

Returns the de-serialized value referenced by the given value accessor.

Type Parameters:

V - the value type

Parameters:

valueAccessor - the value accessor

Returns:

the value

getValue

public <T> T getValue(String name,
                      Class<T> requiredType)

Returns the value with the given name, cast to the expected type.

Only values from this work object will be considered. Values inherited from parent work objects are ignored.

Type Parameters:

T - the required type

Parameters:

name - the name of the value whose value to return

requiredType - the required class of the value value

Returns:

the requested local value

Throws:

IllegalArgumentException - if the value does not have the required type

of

public static ValueMap of()

Creates an empty value map.

Returns:

the value map

of

public static ValueMap of(Map<String,Object> values)

Creates a value map from the given serialized values.

Parameters:

values - the map of serialized values to add

Returns:

the value map

of

public static <V> ValueMap of(ValueAccessor<V> valueAccessor,
                              V value)

Creates a new value map from the given name/value pair.

Type Parameters:

V - the expected transient type of the value

Parameters:

valueAccessor - the value name

value - the value

Returns:

the value map

of

public static <V1,V2> ValueMap of(ValueAccessor<V1> accessor1,
                                  V1 value1,
                                  ValueAccessor<V2> accessor2,
                                  V2 value2)

Creates a new value map from the given name/value pairs.

Type Parameters:

V1 - the expected transient type of the first value

V2 - the expected transient type of the second value

Parameters:

accessor1 - the first value name

value1 - the first value

accessor2 - the second value name

value2 - the second value

Returns:

the value map

of

public static <V1,V2,V3> ValueMap of(ValueAccessor<V1> accessor1,
                                     V1 value1,
                                     ValueAccessor<V2> accessor2,
                                     V2 value2,
                                     ValueAccessor<V3> accessor3,
                                     V3 value3)

Creates a new value map from the given name/value pairs.

Type Parameters:

V1 - the expected transient type of the first value

V2 - the expected transient type of the second value

V3 - the expected transient type of the third value

Parameters:

accessor1 - the first value name

value1 - the first value

accessor2 - the second value name

value2 - the second value

accessor3 - the third value name

value3 - the third value

Returns:

the value map

of

public static ValueMap of(String name,
                          Object value)

Creates a new value map from the given name/value pair.

Parameters:

name - the value name

value - the serialized value

Returns:

the value map

of

public static ValueMap of(String name1,
                          Object value1,
                          String name2,
                          Object value2)

Creates a new value map from the given name/value pairs.

Parameters:

name1 - the first value name

value1 - the first serialized value

name2 - the second value name

value2 - the second serialized value

Returns:

the value map

of

public static ValueMap of(String name1,
                          Object value1,
                          String name2,
                          Object value2,
                          String name3,
                          Object value3)

Creates a new value map from the given name/value pairs.

Parameters:

name1 - the first value name

value1 - the first serialized value

name2 - the second value name

value2 - the second serialized value

name3 - the third value name

value3 - the third serialized value

Returns:

the value map

builder

public static ValueMap.Builder builder()

Creates a builder for a new value map instance.

Returns:

the builder

builder

public static ValueMap.Builder builder(ValueMap template)

Creates a builder for a new value map instance from the given template map.

Parameters:

template - the template value map

Returns:

the builder

filter

public ValueMap filter(Predicate<Map.Entry<String,Object>> predicate)

Filers values in the instance based on the input predicate

Parameters:

predicate - which filters values

Returns:

new ValueMap instance with the filtered values