Package org.spongepowered.api.state

Interface StateMatcher.Builder<S extends State<S>,T extends StateContainer<S>>

All Superinterfaces:

AbstractBuilder<StateMatcher<S>>, Builder<StateMatcher<S>,StateMatcher.Builder<S,T>>, CopyableBuilder<StateMatcher<S>,StateMatcher.Builder<S,T>>, ResettableBuilder<StateMatcher<S>,StateMatcher.Builder<S,T>>

Enclosing interface:

StateMatcher<S extends State<S>>

public static interface StateMatcher.Builder<S extends State<S>,T extends StateContainer<S>>
extends Builder<StateMatcher<S>,StateMatcher.Builder<S,T>>, CopyableBuilder<StateMatcher<S>,StateMatcher.Builder<S,T>>

A builder for StateMatchers.

Method Summary

Modifier and Type	Method	Description
StateMatcher<S>	build()	Builds a StateMatcher.
StateMatcher.Builder<S,T>	matcher(KeyValueMatcher<?> matcher)	Adds a KeyValueMatcher that the State needs to match with.
default <V extends Comparable<V>> StateMatcher.Builder<S,T>	stateProperty(Supplier<? extends StateProperty<V>> stateProperty, V value)	Adds a StateProperty and value that needs to match on a State to match.
<V extends Comparable<V>> StateMatcher.Builder<S,T>	stateProperty(StateProperty<V> stateProperty, V value)	Adds a StateProperty and value that needs to match on a State to match.
default StateMatcher.Builder<S,T>	supportsStateProperty(Supplier<? extends StateProperty<@NonNull ?>> stateProperty)	Adds a StateProperty that needs to be present on a State to match.
StateMatcher.Builder<S,T>	supportsStateProperty(StateProperty<@NonNull ?> stateProperty)	Adds a StateProperty that needs to be present on a State to match.
default StateMatcher.Builder<S,T>	type(Supplier<? extends T> type)	Sets the root StateContainer for the StateMatcher.
StateMatcher.Builder<S,T>	type(T type)	Sets the root StateContainer for the StateMatcher.

Methods inherited from interface org.spongepowered.api.util.Builder

reset

Methods inherited from interface org.spongepowered.api.util.CopyableBuilder

from

Method Details

type

default StateMatcher.Builder<S,T> type(Supplier<? extends T> type)

Sets the root StateContainer for the StateMatcher.

Parameters:

type - The StateContainer to use

Returns:

This builder, for chaining

type

StateMatcher.Builder<S,T> type(T type)

Sets the root StateContainer for the StateMatcher.

Parameters:

type - The StateContainer to use

Returns:

This builder, for chaining

supportsStateProperty

StateMatcher.Builder<S,T> supportsStateProperty(StateProperty<@NonNull ?> stateProperty)

Adds a StateProperty that needs to be present on a State to match.

type(StateContainer) or type(Supplier) must be called before this is called as supported state properties are specific to the type

Parameters:

stateProperty - The state property

Returns:

This builder, for chaining

supportsStateProperty

default StateMatcher.Builder<S,T> supportsStateProperty(Supplier<? extends StateProperty<@NonNull ?>> stateProperty)

Adds a StateProperty that needs to be present on a State to match.

type(StateContainer) or type(Supplier) must be called before this is called as supported state properties are specific to the type

Parameters:

stateProperty - The state property

Returns:

This builder, for chaining

stateProperty

<V extends Comparable<V>> StateMatcher.Builder<S,T> stateProperty(StateProperty<V> stateProperty,
 V value)

Adds a StateProperty and value that needs to match on a State to match.

type(StateContainer) or type(Supplier) must be called before this is called as supported state properties are specific to the type

Type Parameters:

V - The value type

Parameters:

stateProperty - The state property

value - The value to match

Returns:

This builder, for chaining

stateProperty

default <V extends Comparable<V>>
StateMatcher.Builder<S,T> stateProperty(Supplier<? extends StateProperty<V>> stateProperty,
 V value)

Adds a StateProperty and value that needs to match on a State to match.

Type Parameters:

V - The value type

Parameters:

stateProperty - The state property

value - The value to match

Returns:

This builder, for chaining

matcher

StateMatcher.Builder<S,T> matcher(KeyValueMatcher<?> matcher)

Adds a KeyValueMatcher that the State needs to match with.

Parameters:

matcher - The matcher

Returns:

This builder, for chaining

build

StateMatcher<S> build()

Builds a StateMatcher.

Specified by:

build in interface AbstractBuilder<S extends State<S>>

Returns:

The built state matcher