io.github.fablabsmc.fablabs.api.fiber.v1.tree

Interface PropertyMirror<T>

Type Parameters:

T - the type of value this property mirrors

All Superinterfaces:

HasValue<T>, Property<T>

All Known Implementing Classes:

PropertyMirrorImpl

public interface PropertyMirror<T>
extends 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();
 

Method Summary

Modifier and Type	Method and Description
static <T> PropertyMirror<T>	create(ConfigType<T,?,?> converter) Creates a new PropertyMirror that can mirror values of the given ConfigType.
Property<?>	getMirrored() Returns the mirrored property.
ConfigType<T,?,?>	getMirroredType() Returns the ConfigType of the mirrored property.
void	mirror(Property<?> delegate) Sets a property to mirror.

Methods inherited from interface io.github.fablabsmc.fablabs.api.fiber.v1.tree.Property

accepts, setValue

Methods inherited from interface io.github.fablabsmc.fablabs.api.fiber.v1.tree.HasValue

getType, getValue

Method Detail

create

static <T> PropertyMirror<T> create(ConfigType<T,?,?> converter)

Creates a new PropertyMirror that can mirror values of the given ConfigType.

Type Parameters:

T - The type of the mirrored values.

Parameters:

converter - The ConfigType of the mirrored values.

mirror

void mirror(Property<?> 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

getMirrored

Property<?> getMirrored()

Returns the mirrored property.

getMirroredType

ConfigType<T,?,?> getMirroredType()

Returns the ConfigType of the mirrored property.