Package org.spongepowered.api.command.parameter

Interface Parameter.SequenceBuilder

All Superinterfaces:

AbstractBuilder<Parameter.Multi>, Buildable.Builder<Parameter.Multi>, Builder<Parameter.Multi,Parameter.SequenceBuilder>, ResettableBuilder<Parameter.Multi,Parameter.SequenceBuilder>

Enclosing interface:

Parameter

public static interface Parameter.SequenceBuilder
extends Builder<Parameter.Multi,Parameter.SequenceBuilder>

Specifies a builder for creating a Parameter that returns a parameter that concatenates all parameters into a single parameter to be executed one by one.

Method Summary

Modifier and Type	Method	Description
Parameter.Multi	build()	Creates a Parameter from the builder.
Parameter.SequenceBuilder	optional()	Sets that this parameter is weak optional and will be ignored if it cannot parse the next element(s).
Parameter.SequenceBuilder	terminal()	Sets that this sequence of parameters is optional, and will be ignored if it isn't specified - but will throw an error if this is passed something to parse that it cannot parse.
default Parameter.SequenceBuilder	then(@NonNull java.lang.Iterable<Parameter> parameters)	Adds a set of Parameters to this builder.
Parameter.SequenceBuilder	then(Parameter parameter)	Defines the next parameter in the parameter sequence.
default Parameter.SequenceBuilder	then(Parameter @NonNull ... parameters)	Adds a set of Parameters to this builder.

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

reset

Method Detail

terminal

Parameter.SequenceBuilder terminal()

Sets that this sequence of parameters is optional, and will be ignored if it isn't specified - but will throw an error if this is passed something to parse that it cannot parse.

Returns:

This builder, for chaining

optional

Parameter.SequenceBuilder optional()

Sets that this parameter is weak optional and will be ignored if it cannot parse the next element(s).

Returns:

This builder, for chaining

then

Parameter.SequenceBuilder then(Parameter parameter)

Defines the next parameter in the parameter sequence.

Parameters:

parameter - The parameter

Returns:

This builder, for chaining

then

default Parameter.SequenceBuilder then(Parameter @NonNull ... parameters)

Adds a set of Parameters to this builder.

The parameters will be parsed in the provided order.

Parameters:

parameters - The parameters to add

Returns:

This builder, for chaining

then

default Parameter.SequenceBuilder then(@NonNull java.lang.Iterable<Parameter> parameters)

Adds a set of Parameters to this builder.

The parameters will be parsed in the provided order.

Parameters:

parameters - The parameters to add

Returns:

This builder, for chaining

build

Parameter.Multi build()

Creates a Parameter from the builder.

Specified by:

build in interface AbstractBuilder<Parameter.Multi>

Specified by:

build in interface Buildable.Builder<Parameter.Multi>

Returns:

The Parameter