StateProperty (SpongeAPI 8.2.0-SNAPSHOT API)

All Superinterfaces:

Nameable

All Known Subinterfaces:

BooleanStateProperty, EnumStateProperty<E>, IntegerStateProperty
```
public interface StateProperty<T extends java.lang.Comparable<T>>
extends Nameable
```
Represents a possible state property in a StateContainers State.
A State can include zero or more StatePropertys. Each StateProperty within a State is mapped to a value which represents the current value at the time the State was taken.

For example, a BlockTypes.RED_BED contains three possible StatePropertys :
If you query a BlockTypes.RED_BED's StateProperty you have two possible outcomes for each StateProperty. The BooleanStateProperties.RED_BED_OCCUPIED has the following possible values:
- true
- false
As 'OCCUPIED' is a BooleanStateProperty, it can only be true or false. The EnumStateProperties.RED_BED_PART has the following possible values:
- HEAD
- FOOT
To determine the current value of a StateProperty, you would call State.stateProperty(StateProperty). To determine all possible values of a StateProperty, you would call State.stateProperties().

As stated above, a StateContainer may not always have one or more StatePropertys. An example of such a block is BlockTypes.BOOKSHELF.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.Optional<T>`	`parseValue(java.lang.String value)`	Attempts to parse the provided value as a value dictated possible by this state property or `Optional.empty()` otherwise.
`java.util.Collection<T>`	`possibleValues()`	Gets all possible values for a specific `StateProperty`.
`java.util.function.Predicate<T>`	`predicate()`	Gets the `Predicate` used to determine valid values for this.
`java.lang.Class<T>`	`valueClass()`	Gets the class type of the `StateProperty`'s values.

Methods inherited from interface org.spongepowered.api.util.Nameable
name

- Method Detail
  - possibleValues
```
java.util.Collection<T> possibleValues()
```
    Gets all possible values for a specific StateProperty. The included values may not be in any particular order. The returned Collection should be considered immutable.
    
    Returns:
    
    All possible values
  - valueClass
```
java.lang.Class<T> valueClass()
```
    Gets the class type of the StateProperty's values.
    
    Returns:
    
    The value class
  - predicate
```
java.util.function.Predicate<T> predicate()
```
    Gets the Predicate used to determine valid values for this. StateProperty. Any "value" that returns true when Predicate.test(Object) is called is valid. The Predicate is specific to this property.
    
    Returns:
    
    The predicate
  - parseValue
```
java.util.Optional<T> parseValue(java.lang.String value)
```
    Attempts to parse the provided value as a value dictated possible by this state property or Optional.empty() otherwise.
    
    Parameters:
    
    value - The value to parse
    
    Returns:
    
    The actual value