Package net.minestom.server.command.builder.arguments.minecraft

Class ArgumentComponent

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<net.kyori.adventure.text.Component>

net.minestom.server.command.builder.arguments.minecraft.ArgumentComponent

public class ArgumentComponent
extends Argument<net.kyori.adventure.text.Component>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_JSON_ERROR

Fields inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, CONTAINER, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentComponent(@NotNull String id)

Method Summary

Modifier and Type	Method	Description
@NotNull net.kyori.adventure.text.Component	parse(@NotNull CommandSender sender, @NotNull String input)	Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T
String	parser()
String	toString()

Methods inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, equals, filter, getCallback, getDefaultValue, getId, getSuggestionCallback, hasErrorCallback, hashCode, hasSuggestion, isOptional, map, map, nodeProperties, parse, setCallback, setDefaultValue, setDefaultValue, setDefaultValue, setSuggestionCallback, suggestionType, useRemaining

Methods inherited from class java.lang.Object

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

Field Details

INVALID_JSON_ERROR

public static final int INVALID_JSON_ERROR

See Also:

• Constant Field Values

Constructor Details

ArgumentComponent

public ArgumentComponent(@NotNull
 @NotNull String id)

Method Details

parse

@NotNull
public @NotNull net.kyori.adventure.text.Component parse(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String input)
                                                  throws ArgumentSyntaxException

Description copied from class: Argument

Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T

Specified by:

parse in class Argument<net.kyori.adventure.text.Component>

Parameters:

input - the argument to parse

Returns:

the parsed argument

Throws:

ArgumentSyntaxException - if value is not valid

parser

public String parser()

Specified by:

parser in class Argument<net.kyori.adventure.text.Component>

toString

public String toString()

Overrides:

toString in class Object