com.edorasware.commons.core.entity

Class Variable

java.lang.Object

com.edorasware.commons.core.entity.Variable

All Implemented Interfaces:

NamedValue, NamedValueWithSource, Identifiable<VariableId>

public final class Variable
extends Object
implements NamedValueWithSource, Identifiable<VariableId>

Represents a single variable. A variable consists of a name, a value, and a source. The supported value types depend on the implementation of the variable persistence mechanism.

Constructor Summary

Constructors

Constructor and Description
Variable(String name, Object value) Creates a new variable with a mandatory name and optional value.
Variable(String name, Object value, EntityId source) Creates a new variable with a mandatory name, optional value, and source.
Variable(VariableId id, String name, Object value, EntityId source) Creates a new variable with a mandatory id, name, optional value, and source.

Method Summary

Modifier and Type	Method and Description
static Variable	findByName(String name, Collection<Variable> variables) Finds the variable with the given name among the given variables.
VariableId	getId() Returns the id of the variable.
String	getName() Returns the name of the variable.
EntityId	getSource() Returns the source of the variable.
Object	getValue() Returns the value of the variable.
<S> S	getValue(Class<S> expectedType) Convenience method for returning the value of the variable cast to the expected type.
<S> S	getValue(com.google.common.reflect.TypeToken<S> expectedType) Convenience method for returning the value of the variable cast to the expected type.
String	toString()
Variable	withId(VariableId id) Returns a new variable with the given id and the current name, value, and source.
Variable	withSource(EntityId source) Returns a new variable with the given source and the current id, name, and value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Variable

public Variable(String name,
                Object value)

Creates a new variable with a mandatory name and optional value.

Parameters:

name - the name of the variable

value - the value of the variable

Variable

public Variable(String name,
                Object value,
                EntityId source)

Creates a new variable with a mandatory name, optional value, and source.

Parameters:

name - the name of the variable

value - the value of the variable

source - the source of the variable

Variable

public Variable(VariableId id,
                String name,
                Object value,
                EntityId source)

Creates a new variable with a mandatory id, name, optional value, and source.

Parameters:

id - the id of the variable

name - the name of the variable

value - the value of the variable

source - the source of the variable

Method Detail

getId

public VariableId getId()

Returns the id of the variable.

Specified by:

getId in interface Identifiable<VariableId>

Returns:

the variable id

getName

public String getName()

Returns the name of the variable.

Specified by:

getName in interface NamedValue

Returns:

the variable name

getValue

public Object getValue()

Returns the value of the variable.

Specified by:

getValue in interface NamedValue

Returns:

the variable value

getValue

public <S> S getValue(Class<S> expectedType)

Convenience method for returning the value of the variable cast to the expected type. If the variable value is not of the expected type and not null, an IllegalArgumentException is thrown.

Specified by:

getValue in interface NamedValue

Type Parameters:

S - the type of the value

Parameters:

expectedType - the expected type of the variable value

Returns:

the variable value

Throws:

IllegalArgumentException - thrown if the cast is not possible

getValue

public <S> S getValue(com.google.common.reflect.TypeToken<S> expectedType)

Convenience method for returning the value of the variable cast to the expected type. If the variable value is not of the expected type and not null, an IllegalArgumentException is thrown.

Specified by:

getValue in interface NamedValue

Type Parameters:

S - the type of the value

Parameters:

expectedType - the expected type of the variable value

Returns:

the variable value

Throws:

IllegalArgumentException - thrown if the cast is not possible

getSource

public EntityId getSource()

Returns the source of the variable.

Specified by:

getSource in interface NamedValueWithSource

Returns:

the source of the variable

withId

public Variable withId(VariableId id)

Returns a new variable with the given id and the current name, value, and source.

Parameters:

id - the new id of the variable

Returns:

the new variable

withSource

public Variable withSource(EntityId source)

Returns a new variable with the given source and the current id, name, and value.

Parameters:

source - the source of the variable

Returns:

the new variable

toString

public String toString()

Overrides:

toString in class Object

findByName

public static Variable findByName(String name,
                                  Collection<Variable> variables)

Finds the variable with the given name among the given variables.

Parameters:

name - the name of the variable to find

variables - the variables to search

Returns:

the matching variable

Throws:

NoSuchElementException - thrown if there is no variable with the given name