org.spongepowered.api.block

Class BlockState.MatcherBuilder

java.lang.Object

org.spongepowered.api.block.BlockState.MatcherBuilder

All Implemented Interfaces:

ResettableBuilder<BlockState.StateMatcher,BlockState.MatcherBuilder>

Enclosing interface:

BlockState

public static final class BlockState.MatcherBuilder
extends Object
implements ResettableBuilder<BlockState.StateMatcher,BlockState.MatcherBuilder>

A builder for building BlockState.StateMatchers.

Method Summary

Modifier and Type	Method and Description
BlockState.StateMatcher	build() Creates a new BlockState.StateMatcher.
BlockState.MatcherBuilder	from(BlockState.StateMatcher value) Resets this builder to the values of the given built object.
BlockState.MatcherBuilder	reset() Resets this builder to a "default" state such that there is no remaining data to set.
<T extends Comparable<T>> BlockState.MatcherBuilder	trait(BlockTrait<T> trait, T value) Adds the desired BlockTrait and {code value} to this builder, if the desired BlockTrait does not belong to the original BlockType as provided by type(BlockType), an exception is thrown.
BlockState.MatcherBuilder	type(BlockType type) Sets the root BlockType for the BlockState.StateMatcher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

type

public BlockState.MatcherBuilder type(BlockType type)

Sets the root BlockType for the BlockState.StateMatcher.

Note that the type must be set prior to setting various traits and their values.

Parameters:

type - The block type to use

Returns:

This builder, for chaining

trait

public <T extends Comparable<T>> BlockState.MatcherBuilder trait(BlockTrait<T> trait,
                                                                 T value)
                                                          throws IllegalArgumentException

Adds the desired BlockTrait and {code value} to this builder, if the desired BlockTrait does not belong to the original BlockType as provided by type(BlockType), an exception is thrown. Likewise, if a value is not within the possible values for the desired trait of the desired type, an exception is thrown.

Type Parameters:

T - The type of comparable

Parameters:

trait - The desired block trait

value - the desired value

Returns:

This builder

Throws:

IllegalArgumentException - If the block trait does not match the block type, or if the value does not belong to the trait with the desired block type

build

public BlockState.StateMatcher build()
                              throws IllegalStateException

Creates a new BlockState.StateMatcher.

Returns:

The new state matcher

Throws:

IllegalStateException - If there is no block type

from

public BlockState.MatcherBuilder from(BlockState.StateMatcher value)

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface ResettableBuilder<BlockState.StateMatcher,BlockState.MatcherBuilder>

Parameters:

value - The built object

Returns:

This builder, for chaining

reset

public BlockState.MatcherBuilder reset()

Description copied from interface: ResettableBuilder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface ResettableBuilder<BlockState.StateMatcher,BlockState.MatcherBuilder>

Returns:

This builder, for chaining