com.edorasware.commons.core.entity

Class Property

java.lang.Object

com.edorasware.commons.core.entity.Property

All Implemented Interfaces:

NamedValue, NamedValueWithSource, Identifiable<PropertyId>

public final class Property
extends Object
implements NamedValueWithSource, Identifiable<PropertyId>

Represents a single property. A property consists of a name, a String value, and a source.

Constructor Summary

Constructors

Constructor and Description
Property(PropertyId id, String name, String value, EntityId source) Creates a new property with a mandatory id, name, optional value, and source.
Property(String name, String value) Creates a new property with a mandatory name and optional value.
Property(String name, String value, EntityId source) Creates a new property with a mandatory name, optional value, and source.

Method Summary

Modifier and Type	Method and Description
PropertyId	getId() Returns the id of the property.
String	getName() Returns the name of the property.
EntityId	getSource() Returns the source of the property.
String	getValue() Returns the value of the property.
<T> T	getValue(Class<T> expectedType) Convenience method for returning the value of the property cast to the expected type.
<S> S	getValue(com.google.common.reflect.TypeToken<S> expectedType) Convenience method for returning the value of the property cast to the expected type.
String	toString()
Property	withId(PropertyId id) Returns a new property with the given id and the current name, value, and source.
Property	withSource(EntityId source) Returns a new property 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

Property

public Property(String name,
                String value)

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

Parameters:

name - the name of the property

value - the value of the property

Property

public Property(String name,
                String value,
                EntityId source)

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

Parameters:

name - the name of the property

value - the value of the property

source - the source of the property

Property

public Property(PropertyId id,
                String name,
                String value,
                EntityId source)

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

Parameters:

id - the id of the property

name - the name of the property

value - the value of the property

source - the source of the property

Method Detail

getId

public PropertyId getId()

Returns the id of the property.

Specified by:

getId in interface Identifiable<PropertyId>

Returns:

the property id

getName

public String getName()

Returns the name of the property.

Specified by:

getName in interface NamedValue

Returns:

the property name

getValue

public String getValue()

Returns the value of the property.

Specified by:

getValue in interface NamedValue

Returns:

the property value

getValue

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

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

Specified by:

getValue in interface NamedValue

Type Parameters:

T - the type of the value

Parameters:

expectedType - the expected type of the property value

Returns:

the property 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 property cast to the expected type. If the property 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 property value

Returns:

the property value

Throws:

IllegalArgumentException - thrown if the cast is not possible

getSource

public EntityId getSource()

Returns the source of the property.

Specified by:

getSource in interface NamedValueWithSource

Returns:

the source of the property

withId

public Property withId(PropertyId id)

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

Parameters:

id - the new id of the property

Returns:

the new property

withSource

public Property withSource(EntityId source)

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

Parameters:

source - the new source of the property

Returns:

the new property

toString

public String toString()

Overrides:

toString in class Object