net.lenni0451.commandlib.types

Interface ArgumentType<E,T>

Type Parameters:

E - The type of the executor

T - The type of the argument

All Known Implementing Classes:

DynamicType, IntegerType, StringType

public interface ArgumentType<E,T>

The argument type is a simple wrapper interface to argument nodes.
It is used to parse the value of an argument and to provide completions for it.

Method Summary

Modifier and Type	Method and Description
default int	getWeight()
default void	parseCompletions(java.util.Set<java.lang.String> completions, ExecutionContext<E> executionContext, StringReader stringReader) Provide the completions of this argument.
T	parseValue(ExecutionContext<E> executionContext, StringReader stringReader) Parses the value of the argument.

Method Detail

getWeight

default int getWeight()

Returns:

The weight of this type. The higher the weight the more important it is.

parseValue

@Nonnull
T parseValue(ExecutionContext<E> executionContext,
                       StringReader stringReader)
                throws ArgumentParseException,
                       java.lang.RuntimeException

Parses the value of the argument.

Parameters:

executionContext - The execution context

stringReader - The string reader

Returns:

The parsed value

Throws:

ArgumentParseException - If the value could not be parsed

java.lang.RuntimeException - If an unexpected error occurred

parseCompletions

default void parseCompletions(java.util.Set<java.lang.String> completions,
                              ExecutionContext<E> executionContext,
                              StringReader stringReader)

Provide the completions of this argument.

Parameters:

completions - The set of completions

executionContext - The execution context

stringReader - The string reader