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 Argument

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentCommand(String id)

Method Summary

Modifier and Type	Method	Description
String	getShortcut()
boolean	isOnlyCorrect()
CommandResult	parse(CommandSender sender, 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(String shortcut)
String	toString()

Methods inherited from class 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 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(String id)

Method Details

parse

public CommandResult parse(CommandSender sender,
 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

public String getShortcut()

setShortcut

@Experimental
public ArgumentCommand setShortcut(String shortcut)

toString

public String toString()

Overrides:

toString in class Object