com.edorasware.commons.core.entity

Class VariableName<V,W>

java.lang.Object

com.edorasware.commons.core.entity.VariableName<V,W>

All Implemented Interfaces:

NamedValueAccessor<V,W>

public final class VariableName<V,W>
extends Object
implements NamedValueAccessor<V,W>

Supports type-aware creation of Variable instances, and access of Variable instances from DomainObjects. For each VariableName instance, a custom value converter can be set that knows how to serialize/deserialize a given variable value.

Method Summary

Modifier and Type	Method and Description
static <V> VariableName<V,V>	create(String name, Class<V> serializedAndDeserializedValueType) Creates a new VariableName instance.
static <V,W> VariableName<V,W>	create(String name, Class<W> serializedValueType, ValueConverter<V,W> valueConverter) Creates a new VariableName instance, configured with the given value converter.
static <V> VariableName<V,V>	create(String name, com.google.common.reflect.TypeToken<V> serializedAndDeserializedValueType) Creates a new VariableName instance.
static <V,W> VariableName<V,W>	create(String name, com.google.common.reflect.TypeToken<W> serializedValueType, ValueConverter<V,W> valueConverter) Creates a new VariableName instance, configured with the given value converter.
V	deserialize(W value) Deserializes the given value to its transient representation.
String	getName() Returns the named value's name.
com.google.common.reflect.TypeToken<W>	getSerializedValueType() Returns the named value's type of the serialized value.
W	serialize(V value) Serializes the given variable value to its persistent representation.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Description copied from interface: NamedValueAccessor

Returns the named value's name.

Specified by:

getName in interface NamedValueAccessor<V,W>

Returns:

the name

getSerializedValueType

public com.google.common.reflect.TypeToken<W> getSerializedValueType()

Description copied from interface: NamedValueAccessor

Returns the named value's type of the serialized value.

Specified by:

getSerializedValueType in interface NamedValueAccessor<V,W>

Returns:

the type of the serialized value

deserialize

public V deserialize(W value)

Description copied from interface: NamedValueAccessor

Deserializes the given value to its transient representation.

Specified by:

deserialize in interface NamedValueAccessor<V,W>

Parameters:

value - the value to deserialize

Returns:

the deserialized value

serialize

public W serialize(V value)

Serializes the given variable value to its persistent representation.

Parameters:

value - the variable value to serialize

Returns:

the serialized variable value

create

public static <V> VariableName<V,V> create(String name,
                                           Class<V> serializedAndDeserializedValueType)

Creates a new VariableName instance. No value conversion takes place between transient and persisted value.

Type Parameters:

V - the expected transient and persisted type of the variable value

Parameters:

name - the name of the variable

serializedAndDeserializedValueType - the expected transient and persisted type of the variable value

Returns:

the new instance

create

public static <V,W> VariableName<V,W> create(String name,
                                             Class<W> serializedValueType,
                                             ValueConverter<V,W> valueConverter)

Creates a new VariableName instance, configured with the given value converter.

Type Parameters:

V - the expected transient type of the variable

W - the expected persisted type of the variable

Parameters:

name - the name of the variable

serializedValueType - the expected persisted type of the variable value

valueConverter - the value converter

Returns:

the new instance

create

public static <V> VariableName<V,V> create(String name,
                                           com.google.common.reflect.TypeToken<V> serializedAndDeserializedValueType)

Creates a new VariableName instance. No value conversion takes place between transient and persisted value.

Note: using this TypeToken based API is useful when working with parameterized values.

Type Parameters:

V - the expected transient and persisted type of the variable value

Parameters:

name - the name of the variable

serializedAndDeserializedValueType - the expected transient and persisted type of the variable value

Returns:

the new instance

create

public static <V,W> VariableName<V,W> create(String name,
                                             com.google.common.reflect.TypeToken<W> serializedValueType,
                                             ValueConverter<V,W> valueConverter)

Creates a new VariableName instance, configured with the given value converter.

Note: using this TypeToken based API is useful when working with parameterized values.

Type Parameters:

V - the expected transient type of the variable

W - the expected persisted type of the variable

Parameters:

name - the name of the variable

serializedValueType - the expected persisted type of the variable value

valueConverter - the value converter

Returns:

the new instance