Package dev.jorel.commandapi.arguments.parser

Interface Parser<T>

Type Parameters:

T - The type of object that parse(StringReader) returns.

All Known Subinterfaces:

ParserArgument<T>, ParserLiteral

All Known Implementing Classes:

ParserArgument.WithSuggestions, ParserLiteral.WithSuggestions

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Parser<T>

A FunctionalInterface that reads input from a StringReader and interprets it as an object.

Use parse(StringReader) or listSuggestions(CommandContext, SuggestionsBuilder) to process input.

Parsers can be directly defined by implementing the abstract method getResult(StringReader) method. They may also be defined with a slightly different interface by implementing ParserArgument.parse(StringReader) or parse(StringReader). If you are trying to define one of these using a lambda and Java needs extra hints to infer the lambda signature, you can use one of the following static methods:

• parse(Parser)
• argument(ParserArgument)
• read(ParserLiteral)

Method Summary

Modifier and Type	Method	Description
static <T> ParserArgument<T>	argument(ParserArgument<T> parser)	Directly returns the ParserArgument given.
Result<T>	getResult(com.mojang.brigadier.StringReader reader)	Parses the given input.
default <S> CompletableFuture<com.mojang.brigadier.suggestion.Suggestions>	listSuggestions(com.mojang.brigadier.context.CommandContext<S> context, com.mojang.brigadier.suggestion.SuggestionsBuilder builder)	Attempts to suggest how the remaining input could be completed or fixed to produce valid input for this parser.
default T	parse(com.mojang.brigadier.StringReader reader)	Parses the given input and either returns the corresponding object or throws an exception explaining why the input could not be interpreted.
static <T> Parser<T>	parse(Parser<T> parser)	Directly returns the Parser given.
static ParserLiteral	read(ParserLiteral reader)	Directly returns the ParserLiteral given.

Method Details

getResult

Result<T> getResult(com.mojang.brigadier.StringReader reader)

Parses the given input. The returned Result must either have a value or an exception.

Parameters:

reader - The StringReader that holds the input to parse.

Returns:

A Result object holding information about the parse.

parse

default T parse(com.mojang.brigadier.StringReader reader)
         throws com.mojang.brigadier.exceptions.CommandSyntaxException

Parses the given input and either returns the corresponding object or throws an exception explaining why the input could not be interpreted.

Parameters:

reader - The StringReader that holds the input to parse.

Returns:

The object represented by the given input.

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException - If the input is malformed.

listSuggestions

default <S>
CompletableFuture<com.mojang.brigadier.suggestion.Suggestions> listSuggestions(com.mojang.brigadier.context.CommandContext<S> context,
 com.mojang.brigadier.suggestion.SuggestionsBuilder builder)

Attempts to suggest how the remaining input could be completed or fixed to produce valid input for this parser.

Type Parameters:

S - The type of object returned by CommandContext.getSource().

Parameters:

context - The CommandContext that holds information about the command that needs suggestions.

builder - The SuggestionsBuilder that holds the input and position where suggestions should be given.

Returns:

A CompletableFuture that holds the resulting Suggestions.

parse

static <T> Parser<T> parse(Parser<T> parser)

Directly returns the Parser given. This method can help Java infer the lambda signature of (StringReader) -> Result<T>.

Type Parameters:

T - The type of object that parse(StringReader) returns.

Parameters:

parser - The Parser lambda.

Returns:

The Parser object.

argument

static <T> ParserArgument<T> argument(ParserArgument<T> parser)

Directly returns the ParserArgument given. This method can help Java infer the lambda signature of (StringReader) -> T throws CommandSyntaxException.

Type Parameters:

T - The type of object that parse(StringReader) returns.

Parameters:

parser - The ParserArgument lambda.

Returns:

The ParserArgument object.

read

static ParserLiteral read(ParserLiteral reader)

Directly returns the ParserLiteral given. This method can help Java infer the lambda signature of (StringReader) -> void throws CommandSyntaxException.

Parameters:

reader - The ParserLiteral lambda.

Returns:

The ParserLiteral object.