org.jminor.common

Class Values

java.lang.Object

org.jminor.common.Values

public final class Values
extends java.lang.Object

A factory class for Value objects

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Values.AbstractObservableValue<V> A base Value implementation handling the ValueObserver for a Value.
static class	Values.AbstractValue<V> A base Value implementation handling everything except the value itself.

Method Summary

Modifier and Type	Method and Description
static <V> void	link(Value<V> originalValue, Value<V> linkedValue) Links the two values together so that changes in one are reflected in the other
static <V> void	link(Value<V> originalValue, Value<V> linkedValue, boolean oneWay) Links the two values together so that changes in one are reflected in the other
static <V> Value<V>	propertyValue(java.lang.Object owner, java.lang.String propertyName, java.lang.Class<V> valueClass, EventObserver<V> valueChangeEvent) Instantiates a new Value based on a class property
static Value<java.lang.Boolean>	stateValue(State state) Instantiates a boolean Value based on a State.
static <V> Value<V>	value() Instantiates a new Value instance wrapping a null initial value
static <V> Value<V>	value(V initialValue) Instantiates a new Value
static <V> Value<V>	value(V initialValue, V nullValue) Instantiates a new Value
static <V> ValueObserver<V>	valueObserver(Value<V> value) Instantiates a new ValueObserver for the given value.
static State	valueState(Value<java.lang.Boolean> booleanValue) Instantiates a State linked to the given boolean value.

Methods inherited from class java.lang.Object

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

Method Detail

value

public static <V> Value<V> value()

Instantiates a new Value instance wrapping a null initial value

Type Parameters:

V - type to wrap

Returns:

a Value for the given type

value

public static <V> Value<V> value(V initialValue)

Instantiates a new Value

Type Parameters:

V - type to wrap

Parameters:

initialValue - the initial value

Returns:

a Value for the given type with the given initial value

value

public static <V> Value<V> value(V initialValue,
                                 V nullValue)

Instantiates a new Value

Type Parameters:

V - type to wrap

Parameters:

initialValue - the initial value

nullValue - the actual value to use when the value is set to null

Returns:

a Value for the given type with the given initial value

propertyValue

public static <V> Value<V> propertyValue(java.lang.Object owner,
                                         java.lang.String propertyName,
                                         java.lang.Class<V> valueClass,
                                         EventObserver<V> valueChangeEvent)

Instantiates a new Value based on a class property

Type Parameters:

V - type to wrap

Parameters:

owner - the property owner

propertyName - the name of the property

valueClass - the value class

valueChangeEvent - an event which fires each time the value changes

Returns:

a Value for the given property

stateValue

public static Value<java.lang.Boolean> stateValue(State state)

Instantiates a boolean Value based on a State. Null values are translated to 'false'.

Parameters:

state - the state to base the value on

Returns:

a boolean state based on the given value

valueState

public static State valueState(Value<java.lang.Boolean> booleanValue)

Instantiates a State linked to the given boolean value. Null values are translated to 'false'.

Parameters:

booleanValue - the boolean value to link to the state

Returns:

a State linked to the given value

valueObserver

public static <V> ValueObserver<V> valueObserver(Value<V> value)

Instantiates a new ValueObserver for the given value.

Type Parameters:

V - the value type

Parameters:

value - the value to observe

Returns:

a ValueObserver for the given value

link

public static <V> void link(Value<V> originalValue,
                            Value<V> linkedValue)

Links the two values together so that changes in one are reflected in the other

Type Parameters:

V - the value type

Parameters:

originalValue - the original value

linkedValue - the linked value

link

public static <V> void link(Value<V> originalValue,
                            Value<V> linkedValue,
                            boolean oneWay)

Links the two values together so that changes in one are reflected in the other

Type Parameters:

V - the value type

Parameters:

originalValue - the original value

linkedValue - the linked value

oneWay - if true the original value is not updated if the linked value changes