Package dev.jorel.commandapi.arguments.parser

Record Class ParserLiteral.WithSuggestions

java.lang.Object

java.lang.Record

dev.jorel.commandapi.arguments.parser.ParserLiteral.WithSuggestions

Record Components:

base - The ParserLiteral that defines the parsing behavior.

suggestions - The SuggestionProvider that will generate the suggestions.

All Implemented Interfaces:

Parser<Result.Void>, ParserLiteral

Enclosing interface:

ParserLiteral

public static record ParserLiteral.WithSuggestions(ParserLiteral base, SuggestionProvider suggestions)
extends Record
implements ParserLiteral

A ParserLiteral that also places suggestions at the cursor of the StringReader when invoked.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.jorel.commandapi.arguments.parser.ParserLiteral

ParserLiteral.WithSuggestions

Constructor Summary

Constructors

Constructor	Description
WithSuggestions(ParserLiteral base, SuggestionProvider suggestions)	Creates an instance of a WithSuggestions record class.

Method Summary

Modifier and Type	Method	Description
ParserLiteral	base()	Returns the value of the base record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Result<Result.Void>	getResult(com.mojang.brigadier.StringReader reader)	Parses the given input.
final int	hashCode()	Returns a hash code value for this object.
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.
SuggestionProvider	suggestions()	Returns the value of the suggestions record component.
ParserLiteral.WithSuggestions	suggests(SuggestionProvider suggestions)	Adds suggestions to the Result of this ParserLiteral.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

listSuggestions, parse

Constructor Details

WithSuggestions

public WithSuggestions(ParserLiteral base,
 SuggestionProvider suggestions)

Creates an instance of a WithSuggestions record class.

Parameters:

base - the value for the base record component

suggestions - the value for the suggestions record component

Method Details

read

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

Description copied from interface: ParserLiteral

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

Specified by:

read in interface ParserLiteral

Parameters:

reader - The StringReader that holds the input to parse.

Throws:

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

getResult

public 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>

Specified by:

getResult in interface ParserLiteral

Parameters:

reader - The StringReader that holds the input to parse.

Returns:

A Result object holding information about the parse.

suggests

public ParserLiteral.WithSuggestions suggests(SuggestionProvider suggestions)

Description copied from interface: ParserLiteral

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.

Specified by:

suggests in interface ParserLiteral

Parameters:

suggestions - The SuggestionProvider object that will generate the suggestions.

Returns:

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

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

base

public ParserLiteral base()

Returns the value of the base record component.

Returns:

the value of the base record component

suggestions

public SuggestionProvider suggestions()

Returns the value of the suggestions record component.

Returns:

the value of the suggestions record component