com.edorasware.commons.core.entity

Class PropertyMap

java.lang.Object

com.edorasware.commons.core.entity.PropertyMap

public class PropertyMap
extends Object

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

getProperties

public Map<String,String> getProperties()

Returns the held properties represented as key/value pairs.

Returns:

the properties

of

public static PropertyMap of()

Creates an empty PropertyMap.

Returns:

the PropertyMap

of

public static <V> PropertyMap of(PropertyName<V> name,
                                 V value)

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

Type Parameters:

V - the expected transient type of the value

Parameters:

name - the name of the property

value - the value of the property

Returns:

the PropertyMap

of

public static <V1,V2> PropertyMap of(PropertyName<V1> name1,
                                     V1 value1,
                                     PropertyName<V2> name2,
                                     V2 value2)

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

Type Parameters:

V1 - the expected transient type of the first value

V2 - the expected transient type of the second value

Parameters:

name1 - the name of the first property

value1 - the value of the first property

name2 - the name of the second property

value2 - the value of the second property

Returns:

the PropertyMap

of

public static <V1,V2,V3> PropertyMap of(PropertyName<V1> name1,
                                        V1 value1,
                                        PropertyName<V2> name2,
                                        V2 value2,
                                        PropertyName<V3> name3,
                                        V3 value3)

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

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:

name1 - the name of the first property

value1 - the value of the first property

name2 - the name of the second property

value2 - the value of the second property

name3 - the name of the third property

value3 - the value of the third property

Returns:

the PropertyMap

builder

public static PropertyMap.Builder builder()

Creates a builder for a new PropertyMap instance.

Returns:

the builder

builder

public static PropertyMap.Builder builder(PropertyMap template)

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

Parameters:

template - the property map template

Returns:

the builder