Package dev.jorel.commandapi.arguments.parser

Interface ParserLiteral

All Superinterfaces:

Parser<Result.Void>

All Known Implementing Classes:

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 ParserLiteral
extends Parser<Result.Void>

A FunctionalInterface with abstract method read(StringReader). This extends Parser<Result.Void>, so it only reads from the input StringReader and doesn't return any specific object when successful.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
default Result<Result.Void>	getResult(com.mojang.brigadier.StringReader reader)	Parses the given input.
void	read(com.mojang.brigadier.StringReader reader)	Reads from the given input and either returns successfully or throws an exception explaining why the input could not be interpreted.
default ParserLiteral.WithSuggestions	suggests(SuggestionProvider suggestions)	Adds suggestions to the Result of this ParserLiteral.

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

listSuggestions, parse

Method Details

read

void read(com.mojang.brigadier.StringReader reader)
   throws com.mojang.brigadier.exceptions.CommandSyntaxException

Reads from the given input and either returns successfully or throws an exception explaining why the input could not be interpreted.

Parameters:

reader - The StringReader that holds the input to parse.

Throws:

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

getResult

default Result<Result.Void> 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<Result.Void>

Parameters:

reader - The StringReader that holds the input to parse.

Returns:

A Result object holding information about the parse.

suggests

default ParserLiteral.WithSuggestions suggests(SuggestionProvider suggestions)

Adds suggestions to the Result of this ParserLiteral. 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 ParserLiteral.WithSuggestions object to continue the building process with.