me.devnatan.inventoryframework.state

Interface State<T>

Type Parameters:

T - The state value type.

All Known Subinterfaces:

MutableIntState, MutableState<T>

public interface State<T>

States are just intermediate interfaces to a StateValueHost and a StateValue.

A state has a unique id that's passed on to any value defined from it, a state does not keep any data other than its id, who keeps it is the state value. A state id is needed to access a state value within a value host.

See Also:

MutableState

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.concurrent.atomic.AtomicLong	ids

Method Summary

Modifier and Type	Method and Description
StateValueFactory	factory() The value factory of this state.
T	get(@NotNull StateValueHost host) Gets the current value for this state defined in the specified host.
long	internalId() Returns the internal unique id of this state.
static long	next() Generates a new state id.

Field Detail

ids

static final java.util.concurrent.atomic.AtomicLong ids

Method Detail

get

T get(@NotNull
      @NotNull StateValueHost host)

Gets the current value for this state defined in the specified host.

Parameters:

host - The state host.

Returns:

The current state value.

factory

@ApiStatus.Internal
StateValueFactory factory()

The value factory of this state.

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

Returns:

The internal value factory for this state.

internalId

@ApiStatus.Internal
long internalId()

Returns the internal unique id of this state.

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

Returns:

The state id.

next

static long next()

Generates a new state id.

Returns:

A new unique state id.