me.devnatan.inventoryframework.state

Interface StateValue

All Known Subinterfaces:

Pagination

All Known Implementing Classes:

AbstractStateValue

@ApiStatus.Internal
public interface StateValue

Wrapper of the value of a State for a single StateValueHost.

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

Method Summary

Modifier and Type	Method and Description
@UnknownNullability java.lang.Object	get() The current state value.
long	getId() The id of this state on its current host.
State<?>	getState() The state who holds this value.
void	set(java.lang.Object value) Sets the new state value.

Method Detail

getId

long getId()

The id of this state on its current host.

Returns:

The state id.

getState

State<?> getState()

The state who holds this value.

Returns:

The state who holds this value.

get

@UnknownNullability java.lang.Object get()

The current state value.

The value returned and consistency with values returned by the same earlier is unknown as this is implementation defined.

Returns:

The current state value.

set

void set(java.lang.Object value)

Sets the new state value.

Parameters:

value - The new value.

Throws:

StateException - If this value can't be set.