Record Class CommandSuggestionHolder

java.lang.Object

java.lang.Record

net.minestom.server.command.builder.parser.CommandSuggestionHolder

public record CommandSuggestionHolder(CommandSyntax syntax, ArgumentSyntaxException argumentSyntaxException, int argIndex)
extends Record

Holds the data of an invalidated syntax.

Constructor Summary

Constructors

Constructor	Description
CommandSuggestionHolder(CommandSyntax syntax, ArgumentSyntaxException argumentSyntaxException, int argIndex)	Creates an instance of a CommandSuggestionHolder record class.

Method Summary

Modifier and Type	Method	Description
int	argIndex()	Returns the value of the argIndex record component.
ArgumentSyntaxException	argumentSyntaxException()	Returns the value of the argumentSyntaxException record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
CommandSyntax	syntax()	Returns the value of the syntax record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

CommandSuggestionHolder

public CommandSuggestionHolder(CommandSyntax syntax,
 ArgumentSyntaxException argumentSyntaxException,
 int argIndex)

Creates an instance of a CommandSuggestionHolder record class.

Parameters:

syntax - the value for the syntax record component

argumentSyntaxException - the value for the argumentSyntaxException record component

argIndex - the value for the argIndex record component

Method Details

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

syntax

public CommandSyntax syntax()

Returns the value of the syntax record component.

Returns:

the value of the syntax record component

argumentSyntaxException

public ArgumentSyntaxException argumentSyntaxException()

Returns the value of the argumentSyntaxException record component.

Returns:

the value of the argumentSyntaxException record component

argIndex

public int argIndex()

Returns the value of the argIndex record component.

Returns:

the value of the argIndex record component