Package org.spongepowered.api.command.parameter

Interface Parameter.Value<T>

Type Parameters:

T - The type of value returned from the ValueParsers

All Superinterfaces:

Parameter

Enclosing interface:

Parameter

public static interface Parameter.Value<T>
extends Parameter

Represents a Parameter that attempts to parse an argument to obtain a value of type T.

This type of Parameter will attempt to parse an input using the ValueParsers in the order that they are returned in parsers(). If a ValueParser fails to parse an argument, the next in the list will be tried, if the final ValueParser cannot parse the argument, this element will throw a ArgumentParseException.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Parameter.Value.Builder<T>	Builds a Parameter from constituent components.

Nested classes/interfaces inherited from interface org.spongepowered.api.command.parameter.Parameter

Parameter.Factory, Parameter.FirstOfBuilder, Parameter.Key<T>, Parameter.Multi, Parameter.SequenceBuilder, Parameter.Subcommand, Parameter.Value<T>

Method Summary

Modifier and Type	Method	Description
List<CommandCompletion>	complete(@NonNull ArgumentReader.Immutable reader, @NonNull CommandContext context)	Returns potential completions of the current tokenized argument.
ValueCompleter	completer()	Gets the ValueCompleter associated with this Parameter.Value.
Parameter.Key<T>	key()	The key that a parameter result is stored under.
Optional<ValueParameterModifier<T>>	modifier()	Gets the ValueParameterModifier that affects this parameter, if any.
void	parse(@NonNull ArgumentReader.Mutable reader, @NonNull CommandContext.Builder context)	Parses the next element(s) in the CommandContext.
Collection<ValueParser<? extends T>>	parsers()	The ValueParsers to use when parsing an argument.
Predicate<CommandCause>	requirement()	Gets a Predicate that indicates whether a given Cause should parse this Parameter.
String	usage(CommandCause cause)	Gets the usage of this parameter.
Optional<ValueUsage>	valueUsage()	Gets the ValueUsage associated with this Parameter.Value, if any was set.
boolean	willConsumeAllRemaining()	If set, this parameter will repeat until the argument string has been parsed.

Methods inherited from interface org.spongepowered.api.command.parameter.Parameter

isOptional, isTerminal

Method Detail

key

Parameter.Key<T> key()

The key that a parameter result is stored under.

Returns:

The key.

parsers

Collection<ValueParser<? extends T>> parsers()

The ValueParsers to use when parsing an argument. They will be tried in this order.

There must always be at least one ValueParser. If this element is optional and has a default result, it will be the last element in the returned Collection.

Returns:

The parameters.

completer

ValueCompleter completer()

Gets the ValueCompleter associated with this Parameter.Value.

Returns:

The ValueCompleter.

modifier

Optional<ValueParameterModifier<T>> modifier()

Gets the ValueParameterModifier that affects this parameter, if any.

Returns:

The ValueParameterModifier, if set.

valueUsage

Optional<ValueUsage> valueUsage()

Gets the ValueUsage associated with this Parameter.Value, if any was set.

Returns:

The ValueUsage, if set.

requirement

Predicate<CommandCause> requirement()

Gets a Predicate that indicates whether a given Cause should parse this Parameter.

Returns:

the predicate

parse

void parse(@NonNull ArgumentReader.Mutable reader,
           @NonNull CommandContext.Builder context)
    throws ArgumentParseException

Parses the next element(s) in the CommandContext.

Parameters:

reader - The ArgumentReader.Mutable containing the strings that need to be parsed

context - The CommandContext.Builder that contains the current state of the execution

Throws:

ArgumentParseException - thrown if the parameter could not be parsed

complete

List<CommandCompletion> complete(@NonNull ArgumentReader.Immutable reader,
                                 @NonNull CommandContext context)
                          throws ArgumentParseException

Returns potential completions of the current tokenized argument. The completion will be based on ArgumentReader.remaining().

Parameters:

reader - The ArgumentReader containing the strings that need to be parsed

context - The CommandContext that contains the current state of the execution.

Returns:

The potential completions.

Throws:

ArgumentParseException - thrown if the parameter could not be parsed

usage

String usage(CommandCause cause)

Gets the usage of this parameter.

Parameters:

cause - The CommandCause that requested the usage

Returns:

The usage

willConsumeAllRemaining

boolean willConsumeAllRemaining()

If set, this parameter will repeat until the argument string has been parsed.

Returns:

if true, consumes all arguments