Package org.spongepowered.api.state

Interface State<S extends State<S>>

All Superinterfaces:

CopyableDataHolder, DataHolder, DataHolder.Immutable<S>, DataSerializable, SerializableDataHolder, SerializableDataHolder.Immutable<S>, ValueContainer

All Known Subinterfaces:

BlockState, FluidState

public interface State<S extends State<S>>
extends SerializableDataHolder.Immutable<S>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	State.Builder<S extends State<S>,B extends State.Builder<S,B>>

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Nested classes/interfaces inherited from interface org.spongepowered.api.data.SerializableDataHolder

SerializableDataHolder.Immutable<I extends SerializableDataHolder.Immutable<I>>, SerializableDataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
default <T extends Comparable<T>> Optional<S>	cycleStateProperty(Supplier<? extends StateProperty<T>> stateProperty)	Cycles to the next possible value of the StateProperty and returns the new State.
<T extends Comparable<T>> Optional<S>	cycleStateProperty(StateProperty<T> stateProperty)	Cycles to the next possible value of the StateProperty and returns the new State.
default <T extends Cycleable<T>> Optional<S>	cycleValue(Supplier<? extends Key<? extends Value<T>>> key)	Cycles to the next possible value of the Key and returns the new State.
<T extends Cycleable<T>> Optional<S>	cycleValue(Key<? extends Value<T>> key)	Cycles to the next possible value of the Key and returns the new State.
Optional<StateProperty<?>>	findStateProperty(String name)	Attempts to retrieve the StateProperty instance associated with this States StateContainer by name.
Collection<StateProperty<?>>	stateProperties()	Gets an immutable Collection of all applicable StatePropertys for this State.
default <T extends Comparable<T>> Optional<T>	stateProperty(Supplier<? extends StateProperty<T>> stateProperty)	Gets the Comparable value for the specific StateProperty such that if the State does not support the StateProperty, Optional.empty() is returned.
<T extends Comparable<T>> Optional<T>	stateProperty(StateProperty<T> stateProperty)	Gets the Comparable value for the specific StateProperty such that if the State does not support the StateProperty, Optional.empty() is returned.
Map<StateProperty<?>,?>	statePropertyMap()	Gets an immutable or unmodifiable Map of the known StatePropertys to their current values for this State.
Collection<?>	statePropertyValues()	Gets an immutable Collection of all the values for all StatePropertys for this State.
String	toString()	The String representation of this State can be considered to be equal to the representation of this state as a serialized form.
default <T extends Comparable<T>,V extends T> Optional<S>	withStateProperty(Supplier<? extends StateProperty<T>> stateProperty, V value)	Gets the State with the appropriate value for the given StateProperty.
<T extends Comparable<T>,V extends T> Optional<S>	withStateProperty(StateProperty<T> stateProperty, V value)	Gets the State with the appropriate value for the given StateProperty.

Methods inherited from interface org.spongepowered.api.data.DataHolder.Immutable

mergeWith, mergeWith, transform, transform, with, with, with, without, without, without

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder

validateRawData

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder.Immutable

copy, withRawData

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Detail

stateProperty

<T extends Comparable<T>> Optional<T> stateProperty(StateProperty<T> stateProperty)

Gets the Comparable value for the specific StateProperty such that if the State does not support the StateProperty, Optional.empty() is returned.

Type Parameters:

T - The generic type of state property

Parameters:

stateProperty - The state property

Returns:

The comparable value, if available and compatible

stateProperty

default <T extends Comparable<T>> Optional<T> stateProperty(Supplier<? extends StateProperty<T>> stateProperty)

Gets the Comparable value for the specific StateProperty such that if the State does not support the StateProperty, Optional.empty() is returned.

Type Parameters:

T - The generic type of state property

Parameters:

stateProperty - The state property

Returns:

The comparable value, if available and compatible

findStateProperty

Optional<StateProperty<?>> findStateProperty(String name)

Attempts to retrieve the StateProperty instance associated with this States StateContainer by name. If there is no StateProperty available, Optional.empty() is returned.

Parameters:

name - The state property name

Returns:

The state property, if available

withStateProperty

<T extends Comparable<T>,V extends T> Optional<S> withStateProperty(StateProperty<T> stateProperty,
                                                                          V value)

Gets the State with the appropriate value for the given StateProperty. If the StateProperty is not supported, Optional.empty() is returned. If the object is not either an instance contained in StateProperty.possibleValues() or an instance Object.toString(), Optional.empty() may be returned.

Type Parameters:

T - The type of cycleable value

V - The type of extended value

Parameters:

stateProperty - The state property

value - The value

Returns:

The state, if the state property and value are supported

withStateProperty

default <T extends Comparable<T>,V extends T> Optional<S> withStateProperty(Supplier<? extends StateProperty<T>> stateProperty,
                                                                                  V value)

Gets the State with the appropriate value for the given StateProperty. If the StateProperty is not supported, Optional.empty() is returned. If the object is not either an instance contained in StateProperty.possibleValues() or an instance Object.toString(), Optional.empty() may be returned.

Type Parameters:

T - The type of cycleable value

V - The type of extended value

Parameters:

stateProperty - The state property

value - The value

Returns:

The state, if the state property and value are supported

cycleStateProperty

<T extends Comparable<T>> Optional<S> cycleStateProperty(StateProperty<T> stateProperty)

Cycles to the next possible value of the StateProperty and returns the new State. Returns Optional.empty() if the state property or the value isn't supported.

Type Parameters:

T - The type of cycleable value

Parameters:

stateProperty - The state property

Returns:

The cycled state if successful

cycleStateProperty

default <T extends Comparable<T>> Optional<S> cycleStateProperty(Supplier<? extends StateProperty<T>> stateProperty)

Cycles to the next possible value of the StateProperty and returns the new State. Returns Optional.empty() if the state property or the value isn't supported.

Type Parameters:

T - The type of cycleable value

Parameters:

stateProperty - The state property

Returns:

The cycled state if successful

cycleValue

<T extends Cycleable<T>> Optional<S> cycleValue(Key<? extends Value<T>> key)

Cycles to the next possible value of the Key and returns the new State. Returns Optional.empty() if the key or the value isn't supported.

Type Parameters:

T - The type of cycleable value

Parameters:

key - The key

Returns:

The cycled state if successful

cycleValue

default <T extends Cycleable<T>> Optional<S> cycleValue(Supplier<? extends Key<? extends Value<T>>> key)

Cycles to the next possible value of the Key and returns the new State. Returns Optional.empty() if the key or the value isn't supported.

Type Parameters:

T - The type of cycleable value

Parameters:

key - The key

Returns:

The cycled state if successful

stateProperties

Collection<StateProperty<?>> stateProperties()

Gets an immutable Collection of all applicable StatePropertys for this State.

Returns:

An immutable collection of all applicable state properties

statePropertyValues

Collection<?> statePropertyValues()

Gets an immutable Collection of all the values for all StatePropertys for this State.

Returns:

An immutable collection of all the values for all applicable properties

statePropertyMap

Map<StateProperty<?>,?> statePropertyMap()

Gets an immutable or unmodifiable Map of the known StatePropertys to their current values for this State.

Returns:

The immutable map of state properties to their values representing this state

toString

String toString()

The String representation of this State can be considered to be equal to the representation of this state as a serialized form.

Overrides:

toString in class Object

Returns:

The serialized string