org.spongepowered.api.block

Class BlockState.StateMatcher

java.lang.Object

org.spongepowered.api.block.BlockState.StateMatcher

All Implemented Interfaces:

Predicate<BlockState>

Enclosing interface:

BlockState

public static final class BlockState.StateMatcher
extends Object
implements Predicate<BlockState>

A BlockState matcher that will match various block states according to a pre-built list of BlockTraits and their values, such that not all BlockTraits contained in a BlockState must be matched. (Such as if a block state that contains 4 traits, and only 2 are wanting to be matched, then the other two traits may be variable).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<BlockState>	getCompatibleStates() Gets a List of compatible BlockStates.
int	hashCode()
boolean	matches(BlockState state) Gets a true return value if the provided BlockState sufficiently matches this matcher, such that the BlockType matches, and the pre-defined BlockTrait values match.
boolean	test(BlockState blockState)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Method Detail

matches

public boolean matches(BlockState state)

Gets a true return value if the provided BlockState sufficiently matches this matcher, such that the BlockType matches, and the pre-defined BlockTrait values match.

Parameters:

state - The block state in question

Returns:

True if the state sufficiently matches

test

public boolean test(BlockState blockState)

Specified by:

test in interface Predicate<BlockState>

getCompatibleStates

public List<BlockState> getCompatibleStates()

Gets a List of compatible BlockStates. Since all BlockStates are known in the initialization of a BlockType, the states are already deterministic and cannot change themselves.

Returns:

The list of compatible block states

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object