me.devnatan.inventoryframework.state

Interface StateValueHost

All Known Subinterfaces:

IFCloseContext, IFConfinedContext, IFContext, IFOpenContext, IFRenderContext, IFSlotClickContext, IFSlotContext, IFSlotRenderContext

public interface StateValueHost

StateHost is an entity capable of storing current data from multiple states.

Method Summary

Modifier and Type	Method and Description
StateValue	getInternalStateValue(State<?> state) This is an internal inventory-framework API that should not be used from outside of this library.
java.lang.Object	getRawStateValue(State<?> state) Returns the internal value of a state.
@UnmodifiableView java.util.Map<java.lang.Long,StateValue>	getStateValues() This is an internal inventory-framework API that should not be used from outside of this library.
StateValue	getUninitializedStateValue(long stateId) This is an internal inventory-framework API that should not be used from outside of this library.
void	initializeState(long id, @NotNull StateValue value) Initializes the value of a state in this value host.
void	updateState(long id, java.lang.Object value) Updates the value of an initialized state in this value host.
void	watchState(long id, StateWatcher listener)

Method Detail

getStateValues

@UnmodifiableView java.util.Map<java.lang.Long,StateValue> getStateValues()

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

getUninitializedStateValue

@ApiStatus.Internal
StateValue getUninitializedStateValue(long stateId)

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

getRawStateValue

@ApiStatus.Internal
java.lang.Object getRawStateValue(State<?> state)

Returns the internal value of a state.

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

Parameters:

state - The target state.

Returns:

Raw value from the state with the specified id.

getInternalStateValue

@ApiStatus.Internal
StateValue getInternalStateValue(State<?> state)

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

initializeState

@ApiStatus.Internal
void initializeState(long id,
                                         @NotNull
                                         @NotNull StateValue value)

Initializes the value of a state in this value host.

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

Parameters:

id - The state id.

value - The initial state value.

updateState

@ApiStatus.Internal
void updateState(long id,
                                     java.lang.Object value)

Updates the value of an initialized state in this value host.

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

Parameters:

id - The state id.

value - The new state value.

watchState

@ApiStatus.Internal
void watchState(long id,
                                    StateWatcher listener)