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

Class ArgumentCommand

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<CommandResult>

net.minestom.server.command.builder.arguments.ArgumentCommand

public class ArgumentCommand
extends Argument<CommandResult>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_COMMAND_ERROR

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

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentCommand(@NotNull String id)

Method Summary

Modifier and Type	Method	Description
@NotNull String	getShortcut()
boolean	isOnlyCorrect()
@NotNull CommandResult	parse(@NotNull CommandSender sender, @NotNull String input)	Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T
ArgumentParserType	parser()
ArgumentCommand	setOnlyCorrect(boolean onlyCorrect)
ArgumentCommand	setShortcut(@NotNull String shortcut)
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_COMMAND_ERROR

public static final int INVALID_COMMAND_ERROR

See Also:

• Constant Field Values

Constructor Details

ArgumentCommand

public ArgumentCommand(@NotNull
 @NotNull String id)

Method Details

parse

@NotNull
public @NotNull CommandResult 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<CommandResult>

Parameters:

input - the argument to parse

Returns:

the parsed argument

Throws:

ArgumentSyntaxException - if value is not valid

parser

public ArgumentParserType parser()

Specified by:

parser in class Argument<CommandResult>

isOnlyCorrect

public boolean isOnlyCorrect()

setOnlyCorrect

public ArgumentCommand setOnlyCorrect(boolean onlyCorrect)

getShortcut

@NotNull
public @NotNull String getShortcut()

setShortcut

@Experimental
public ArgumentCommand setShortcut(@NotNull
 @NotNull String shortcut)

toString

public String toString()

Overrides:

toString in class Object