Package dev.jorel.commandapi.arguments.parser

Interface ParserArgument<T>

Type Parameters:

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

All Superinterfaces:

Parser<T>

All Known Implementing Classes:

ParserArgument.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 ParserArgument<T>
extends Parser<T>

A FunctionalInterface with abstract method parse(StringReader). This extends Parser<T>.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ParserArgument.WithSuggestions<T>	A ParserArgument that also places suggestions at the cursor of the StringReader when invoked.

Method Summary

Modifier and Type	Method	Description
default Result<T>	getResult(com.mojang.brigadier.StringReader reader)	Parses the given input.
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.
default ParserArgument.WithSuggestions<T>	suggests(SuggestionProvider suggestions)	Adds suggestions to the Result of this ParserArgument.

Methods inherited from interface dev.jorel.commandapi.arguments.parser.Parser

listSuggestions

Method Details

parse

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

Description copied from interface: Parser

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

Specified by:

parse in interface Parser<T>

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.

getResult

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

Description copied from interface: Parser

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

Specified by:

getResult in interface Parser<T>

Parameters:

reader - The StringReader that holds the input to parse.

Returns:

A Result object holding information about the parse.

suggests

default ParserArgument.WithSuggestions<T> suggests(SuggestionProvider suggestions)

Adds suggestions to the Result of this ParserArgument. The suggestions will be placed where the cursor of the StringReader was when the parser was invoked.

Parameters:

suggestions - The SuggestionProvider object that will generate the suggestions.

Returns:

A ParserArgument.WithSuggestions object to continue the building process with.