me.zeroeightsix.fiber.api.tree

Class PropertyMirror<T>

java.lang.Object

me.zeroeightsix.fiber.api.tree.PropertyMirror<T>

Type Parameters:

T - the type of value this property mirrors

All Implemented Interfaces:

HasValue<T>, Property<T>

public class PropertyMirror<T>
extends java.lang.Object
implements Property<T>

A Property that delegates all operations to another.

This can be used in conjunction with config builders to easily setup a configuration without reflection. For example:

 public final PropertyMirror<Integer> diamondsDropped = new PropertyMirror<>();

 private final Node config = ConfigNode.builder()
     .beginValue("diamondsDropped", Integer.class)
      .beginConstraints().atLeast(1).finishConstraints()
     .finishValue(diamondsDropped::mirror)
     .build();
 

Field Summary

Fields

Modifier and Type	Field and Description
protected Property<T>	delegate

Constructor Summary

Constructors

Constructor and Description
PropertyMirror()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(T value) Returns true if this property can be set to the given value.
java.lang.Class<T>	getType() Returns the class of the type of the value being held
T	getValue() Returns the value being held
void	mirror(Property<T> delegate) Sets a property to mirror.
boolean	setValue(T value) Sets the value of this property.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected Property<T> delegate

Constructor Detail

PropertyMirror

public PropertyMirror()

Method Detail

mirror

public void mirror(Property<T> delegate)

Sets a property to mirror.

After calling this method with a valid delegate, every property method will redirect to delegate.

Parameters:

delegate - a property to mirror

setValue

public boolean setValue(T value)

Description copied from interface: Property

Sets the value of this property.

This can fail and return false if, for example, the value did not satisfy the constraints of the property.

Specified by:

setValue in interface Property<T>

Parameters:

value - the new value this property should receive

Returns:

true if this property changed as a result of the call

See Also:

Property.accepts(Object)

accepts

public boolean accepts(T value)

Description copied from interface: Property

Returns true if this property can be set to the given value.

Specified by:

accepts in interface Property<T>

Parameters:

value - the value to check

Returns:

true if this property accepts the given value, false otherwise.

See Also:

Property.setValue(Object)

getValue

public T getValue()

Description copied from interface: HasValue

Returns the value being held

Specified by:

getValue in interface HasValue<T>

Returns:

the value

getType

public java.lang.Class<T> getType()

Description copied from interface: HasValue

Returns the class of the type of the value being held

Specified by:

getType in interface HasValue<T>

Returns:

the class of the type of the value