org.spongepowered.api.block.trait

Interface BlockTrait<T extends Comparable<T>>

All Superinterfaces:

CatalogType

All Known Subinterfaces:

BooleanTrait, EnumTrait<E>, IntegerTrait

public interface BlockTrait<T extends Comparable<T>>
extends CatalogType

Represents a possible trait in a BlockTypes BlockState.

A BlockState can include zero or more BlockTraits. Each BlockTrait within a BlockState is mapped to a value which represents the current value at the time the BlockState was taken.

For example, a BlockTypes.BED contains three possible BlockTraits :

• EnumTraits.BED_FACING
• BooleanTraits.BED_OCCUPIED
• EnumTraits.BED_PART

If you query a BlockTypes.BED's BlockTrait you have two possible outcomes for each BlockTrait. The BooleanTraits.BED_OCCUPIED has the following possible values :

• true
• false

As 'OCCUPIED' is a BooleanTrait, it can only be true or false. The EnumTraits.BED_PART has the following possible values :

• HEAD
• FOOT

To determine the current value of a BlockTrait, you would call BlockState.getTraitValue(BlockTrait). To determine all possible values of a BlockTrait, you would call BlockType.getTraits().

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

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the name of this BlockTrait.
Collection<T>	getPossibleValues() Gets all possible values for a specific BlockTrait.
Predicate<T>	getPredicate() Gets the Predicate used to determine valid values for this.
Class<T>	getValueClass() Gets the class type of the BlockTrait's values.
Optional<T>	parseValue(String value) Attempts to parse the provided value as a value dictated possible by this trait or Optional.empty() otherwise.

Methods inherited from interface org.spongepowered.api.CatalogType

getId

Method Detail

getName

String getName()

Gets the name of this BlockTrait.

Specified by:

getName in interface CatalogType

Returns:

The trait name

getPossibleValues

Collection<T> getPossibleValues()

Gets all possible values for a specific BlockTrait. The included values may not be in any particular order. The returned Collection should be considered immutable.

Returns:

All possible values

getValueClass

Class<T> getValueClass()

Gets the class type of the BlockTrait's values.

Returns:

The value class

getPredicate

Predicate<T> getPredicate()

Gets the Predicate used to determine valid values for this. BlockTrait. Any "value" that returns true when Predicate.test(Object) is called is valid. The Predicate is specific to this trait.

Returns:

The predicate

parseValue

Optional<T> parseValue(String value)

Attempts to parse the provided value as a value dictated possible by this trait or Optional.empty() otherwise.

Parameters:

value - The value to parse

Returns:

The actual value