Package org.spongepowered.api.state

Interface StateMatcher<S extends State<S>>

All Superinterfaces:

Predicate<S>

public interface StateMatcher<S extends State<S>>
extends Predicate<S>

A StateMatcher that will match various States according to a pre-built list of StatePropertys and their values, such that not all StatePropertys contained in a State must be matched.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StateMatcher.Builder<S extends State<S>,T extends StateContainer<S>>	A builder for StateMatchers.
static interface	StateMatcher.Factory	Factories for generating builders.

Method Summary

Modifier and Type	Method	Description
static StateMatcher.Builder<BlockState,BlockType>	blockStateMatcherBuilder()	Creates a new StateMatcher.Builder for matching BlockStates.
List<S>	compatibleStates()	Gets a List of compatible States.
static StateMatcher.Builder<FluidState,FluidType>	fluidStateMatcherBuilder()	Creates a new StateMatcher.Builder for matching FluidStates.
boolean	matches(S state)	Gets a true return value if the provided State sufficiently matches the pre-defined StateProperty values and KeyValueMatchers.
default boolean	test(S state)

Methods inherited from interface java.util.function.Predicate

and, negate, or

Method Details

blockStateMatcherBuilder

static StateMatcher.Builder<BlockState,BlockType> blockStateMatcherBuilder()

Creates a new StateMatcher.Builder for matching BlockStates.

Returns:

The builder

fluidStateMatcherBuilder

static StateMatcher.Builder<FluidState,FluidType> fluidStateMatcherBuilder()

Creates a new StateMatcher.Builder for matching FluidStates.

Returns:

The builder

matches

boolean matches(S state)

Gets a true return value if the provided State sufficiently matches the pre-defined StateProperty values and KeyValueMatchers.

Parameters:

state - The state in question

Returns:

True if the state sufficiently matches

compatibleStates

List<S> compatibleStates()

Gets a List of compatible States.

Returns:

The list of compatible states

test

default boolean test(S state)

Specified by:

test in interface Predicate<S extends State<S>>