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

Interface VariableValueParameters.LiteralBuilder<T>

All Superinterfaces:

AbstractBuilder<ValueParameter<T>>, Builder<ValueParameter<T>,VariableValueParameters.LiteralBuilder<T>>, ResettableBuilder<ValueParameter<T>,VariableValueParameters.LiteralBuilder<T>>

Enclosing class:

VariableValueParameters

public static interface VariableValueParameters.LiteralBuilder<T>
extends Builder<ValueParameter<T>,VariableValueParameters.LiteralBuilder<T>>

A builder that creates ValueParameters that requires a specific sequence of arguments.

Method Summary

Modifier and Type	Method	Description
ValueParameter<T>	build()	Tests for validity and creates this ValueParameter.
default VariableValueParameters.LiteralBuilder<T>	literal(Collection<String> literal)	Sets the sequence of strings that need to be matched at runtime.
VariableValueParameters.LiteralBuilder<T>	literal(Supplier<? extends Collection<String>> literalSupplier)	Sets a Supplier that provides the sequence of strings that need to be matched at runtime.
VariableValueParameters.LiteralBuilder<T>	returnValue(Supplier<T> returnValueSupplier)	Sets a Supplier that provides the object to return if this parameter parses correctly.
default VariableValueParameters.LiteralBuilder<T>	returnValue(T returnValue)	Sets the object to return if this parameter parses correctly.

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

reset

Method Details

literal

VariableValueParameters.LiteralBuilder<T> literal(Supplier<? extends Collection<String>> literalSupplier)

Sets a Supplier that provides the sequence of strings that need to be matched at runtime.

Consumers of the API should supply an ordered collection.

Parameters:

literalSupplier - The Supplier

Returns:

This builder, for chaining

literal

default VariableValueParameters.LiteralBuilder<T> literal(Collection<String> literal)

Sets the sequence of strings that need to be matched at runtime.

Consumers of the API should supply an ordered collection.

Parameters:

literal - The sequence of elements

Returns:

This builder, for chaining

returnValue

VariableValueParameters.LiteralBuilder<T> returnValue(Supplier<T> returnValueSupplier)

Sets a Supplier that provides the object to return if this parameter parses correctly.

Parameters:

returnValueSupplier - The Supplier

Returns:

This builder, for chaining

returnValue

default VariableValueParameters.LiteralBuilder<T> returnValue(T returnValue)

Sets the object to return if this parameter parses correctly.

Parameters:

returnValue - The Object

Returns:

This builder, for chaining

build

ValueParameter<T> build()

Tests for validity and creates this ValueParameter.

Specified by:

build in interface AbstractBuilder<T>

Returns:

The ValueParameter

Throws:

IllegalStateException - if the literal and the return object have not been specified