Package alexiil.mc.lib.attributes.misc

Interface Reference<T>

All Known Subinterfaces:

StackReference

All Known Implementing Classes:

CallableRef, DestroyableRef, Ref, SimulatableRef, SingleCopyingItemSlot, SingleFluidTank, SingleItemSlot, UnmodifiableRef

public interface Reference<T>

A reference to some object. The object can either be obtained from (get()), or changed with (set(Object)). Note that changing the object isn't always permitted, and so it may return false if no change happened.

Most users will only need to construct Ref instances to create a Reference, which is a simple reference that stores the object in a public modifiable field. However there are also 4 other basic implementations:

• UnmodifiableRef is a Reference which always returns the same object from get(), and returns false from set(Object) and isValid(Object). You can either construct instances directly or via the factory method unmodifiable(Object).
• CallableRef is a Reference which delegates to 3 objects: a Supplier for get(), a Consumer for set(Object), and a Predicate for isValid(Object). You can either construct instances directly, or use the factory method callable(Supplier, Consumer, Predicate).
• SimulatableRef is similar to CallableRef, but uses a single LimitedConsumer for both set(Object) and isValid(Object).
• DestroyableRef is a bit different from the others, as it wraps another Reference internally, and delegates all calls to it. However you can call DestroyableRef.destroy() to disallow any further modifications to the backing reference.

Method Summary

Modifier and Type	Method	Description
default DestroyableRef<T>	asDestroyable()
static <T> CallableRef<T>	callable(Supplier<T> getter, Consumer<T> setter, Predicate<T> filter)
static <T> DestroyableRef<T>	destroying(Reference<T> ref)
T	get()
boolean	isValid(T value)
boolean	set(T value)
default boolean	set(T value, Simulation simulation)	Delegates to set(Object) if the simulation is Simulation.ACTION, otherwise it delegates to isValid(Object).
static <T> SimulatableRef<T>	simulating(Supplier<T> getter, LimitedConsumer<T> setter)
static <T> UnmodifiableRef<T>	unmodifiable(T obj)

Method Details

get

T get()

Returns:

The object referenced. Note that you should generally not modify the returned value directly - instead copy it before passing it to set(Object) or isValid(Object) to see if your modifications are permitted.

set

boolean set(T value)

Returns:

True if the new value was accepted, false otherwise.

isValid

boolean isValid(T value)

Returns:

True if set(Object) was called with the same value.

set

default boolean set(T value,
 Simulation simulation)

Delegates to set(Object) if the simulation is Simulation.ACTION, otherwise it delegates to isValid(Object).

asDestroyable

default DestroyableRef<T> asDestroyable()

Returns:

A DestroyableRef that can be modified until DestroyableRef.destroy() is called, after which all calls to set(Object) and isValid(Object) will return false.

unmodifiable

static <T> UnmodifiableRef<T> unmodifiable(T obj)

Returns:

A new Reference that doesn't permit modifications to the given object.

callable

static <T> CallableRef<T> callable(Supplier<T> getter,
 Consumer<T> setter,
 Predicate<T> filter)

Parameters:

getter - The Supplier which is used for get().

setter - The Consumer which is used for set(Object) (after the filter).

filter - The Predicate which is used to test inputs for both set(Object) and isValid(Object).

Returns:

A new CallableRef that delegates to the getter, setter, and filter for all of the functions.

simulating

static <T> SimulatableRef<T> simulating(Supplier<T> getter,
 LimitedConsumer<T> setter)

Parameters:

getter - The Supplier which is used for get()

setter - The LimitedConsumer which is used for set(Object)and isValid(Object).

Returns:

A new SimulatableRef that delegates to the getter and setter for all of it's functions.

destroying

static <T> DestroyableRef<T> destroying(Reference<T> ref)

Returns:

A new DestroyableRef that delegates to the given reference for getting, although setting only succeeds until DestroyableRef.destroy() is called.