com.edorasware.commons.core.entity

Class VariableMap

java.lang.Object

com.edorasware.commons.core.entity.VariableMap

public final class VariableMap
extends Object

Holds variables represented as key/value pairs of type String/Object. The APIs are targeted towards the usage of VariableNames as input parameters.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static VariableMap.Builder	builder() Creates a builder for a new VariableMap instance.
static VariableMap.Builder	builder(VariableMap template) Creates a builder for a new VariableMap instance and applies the given template.
Map<String,Object>	getVariables() Returns the held variables represented as key/value pairs.
static VariableMap	of() Creates an empty VariableMap.
static VariableMap	of(Map<String,Object> variables) Creates a VariableMap based on the specified map of variables.
static VariableMap	of(String name, Object value) Creates a new VariableMap with a single entry based on the given name and value.
static VariableMap	of(String name1, Object value1, String name2, Object value2) Creates a new VariableMap with two entries based on the given sequence of name/value.
static VariableMap	of(String name1, Object value1, String name2, Object value2, String name3, Object value3) Creates a new VariableMap with three entries based on the given sequence of name/value.
static <V> VariableMap	of(VariableName<V,?> name, V value) Creates a new VariableMap with a single entry based on the given name and value.
static <V1,V2> VariableMap	of(VariableName<V1,?> name1, V1 value1, VariableName<V2,?> name2, V2 value2) Creates a new VariableMap with two entries based on the given sequence of name/value.
static <V1,V2,V3> VariableMap	of(VariableName<V1,?> name1, V1 value1, VariableName<V2,?> name2, V2 value2, VariableName<V3,?> name3, V3 value3) Creates a new VariableMap with three entries based on the given sequence of name/value.

Methods inherited from class java.lang.Object

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

Method Detail

getVariables

public Map<String,Object> getVariables()

Returns the held variables represented as key/value pairs.

Returns:

the variables

of

public static VariableMap of()

Creates an empty VariableMap.

Returns:

the VariableMap

of

public static VariableMap of(Map<String,Object> variables)

Creates a VariableMap based on the specified map of variables.

Parameters:

variables - the map of variables to add

Returns:

the VariableMap

of

public static <V> VariableMap of(VariableName<V,?> name,
                                 V value)

Creates a new VariableMap with a single entry based on the given name and value.

Type Parameters:

V - the expected transient type of the variable

Parameters:

name - the name of the variable

value - the value of the variable

Returns:

the VariableMap

of

public static <V1,V2> VariableMap of(VariableName<V1,?> name1,
                                     V1 value1,
                                     VariableName<V2,?> name2,
                                     V2 value2)

Creates a new VariableMap with two entries based on the given sequence of name/value.

Type Parameters:

V1 - the expected transient type of the first variable

V2 - the expected transient type of the second variable

Parameters:

name1 - the name of the first variable

value1 - the value of the first variable

name2 - the name of the second variable

value2 - the value of the second variable

Returns:

the VariableMap

of

public static <V1,V2,V3> VariableMap of(VariableName<V1,?> name1,
                                        V1 value1,
                                        VariableName<V2,?> name2,
                                        V2 value2,
                                        VariableName<V3,?> name3,
                                        V3 value3)

Creates a new VariableMap with three entries based on the given sequence of name/value.

Type Parameters:

V1 - the expected transient type of the first variable

V2 - the expected transient type of the second variable

V3 - the expected transient type of the third variable

Parameters:

name1 - the name of the first variable

value1 - the value of the first variable

name2 - the name of the second variable

value2 - the value of the second variable

name3 - the name of the third variable

value3 - the value of the third variable

Returns:

the VariableMap

of

public static VariableMap of(String name,
                             Object value)

Creates a new VariableMap with a single entry based on the given name and value.

Parameters:

name - the name of the variable

value - the value of the variable

Returns:

the VariableMap

of

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

Creates a new VariableMap with two entries based on the given sequence of name/value.

Parameters:

name1 - the name of the first variable

value1 - the value of the first variable

name2 - the name of the second variable

value2 - the value of the second variable

Returns:

the VariableMap

of

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

Creates a new VariableMap with three entries based on the given sequence of name/value.

Parameters:

name1 - the name of the first variable

value1 - the value of the first variable

name2 - the name of the second variable

value2 - the value of the second variable

name3 - the name of the third variable

value3 - the value of the third variable

Returns:

the VariableMap

builder

public static VariableMap.Builder builder()

Creates a builder for a new VariableMap instance.

Returns:

the builder

builder

public static VariableMap.Builder builder(VariableMap template)

Creates a builder for a new VariableMap instance and applies the given template.

Parameters:

template - the variable map template

Returns:

the builder