Package org.spongepowered.api.command.parameter.managed.standard

Interface VariableValueParameters.TextBuilder

All Superinterfaces:

Buildable.Builder<ValueParameter<Component>>, Builder<ValueParameter<Component>,VariableValueParameters.TextBuilder>, ResettableBuilder<ValueParameter<Component>,VariableValueParameters.TextBuilder>

Enclosing class:

VariableValueParameters

public static interface VariableValueParameters.TextBuilder
extends Builder<ValueParameter<Component>,VariableValueParameters.TextBuilder>

A builder that creates a parameter that serializes strings into Component.

Method Summary

Modifier and Type	Method	Description
ValueParameter<Component>	build()	Tests for validity and creates this ValueParameter.
VariableValueParameters.TextBuilder	consumeAllArguments(boolean allArguments)	Sets whether the parameter will use all the arguments left in the chain, or whether it will just consume one.
VariableValueParameters.TextBuilder	serializer(ComponentSerializer<Component,? extends Component,String> serializer)	Sets the ComponentSerializer for use by the element.
VariableValueParameters.TextBuilder	serializerSupplier(Supplier<ComponentSerializer<Component,? extends Component,String>> serializerSupplier)	Sets the ComponentSerializer for use by the element, though the use of a Supplier.

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

reset

Method Detail

serializer

VariableValueParameters.TextBuilder serializer(ComponentSerializer<Component,? extends Component,String> serializer)

Sets the ComponentSerializer for use by the element.

Setting this will replace any ComponentSerializers or Suppliers that has already been set on this builder.

Parameters:

serializer - A ComponentSerializer

Returns:

This builder, for chaining

serializerSupplier

VariableValueParameters.TextBuilder serializerSupplier(Supplier<ComponentSerializer<Component,? extends Component,String>> serializerSupplier)

Sets the ComponentSerializer for use by the element, though the use of a Supplier.

Setting this will replace any ComponentSerializers or Suppliers that has already been set on this builder.

Parameters:

serializerSupplier - A Supplier that will supply a ComponentSerializer

Returns:

This builder, for chaining

consumeAllArguments

VariableValueParameters.TextBuilder consumeAllArguments(boolean allArguments)

Sets whether the parameter will use all the arguments left in the chain, or whether it will just consume one.

Parameters:

allArguments - Whether all arguments will be consumed

Returns:

This builder, for chaining

build

ValueParameter<Component> build()
                         throws IllegalStateException

Tests for validity and creates this ValueParameter.

Specified by:

build in interface Buildable.Builder<ValueParameter<Component>>

Returns:

The ValueParameter

Throws:

IllegalStateException - if the ComponentSerializer has not been specified