Class ArgumentString

java.lang.Object

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

net.minestom.server.command.builder.arguments.ArgumentString

public class ArgumentString
extends Argument<String>

Argument which will take a quoted string.

Example: "Hey I am a string"

Field Summary

Fields

Modifier and Type	Field	Description
static final int	QUOTE_ERROR

Fields inherited from class Argument

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentString(String id)

Method Summary

Modifier and Type	Method	Description
byte @Nullable []	nodeProperties()
String	parse(CommandSender sender, String input)	Parses the given input, and throw an ArgumentSyntaxException if the input cannot be converted to T
ArgumentParserType	parser()
static String	staticParse(String input)	Deprecated. use Argument.parse(CommandSender, Argument)
String	toString()

Methods inherited from class Argument

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

Methods inherited from class Object

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

Field Details

QUOTE_ERROR

public static final int QUOTE_ERROR

See Also:

• Constant Field Values

Constructor Details

ArgumentString

public ArgumentString(String id)

Method Details

parse

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

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

nodeProperties

public byte @Nullable [] nodeProperties()

Overrides:

nodeProperties in class Argument<String>

staticParse

@Deprecated
public static String staticParse(String input)
                          throws ArgumentSyntaxException

Deprecated.

use Argument.parse(CommandSender, Argument)

Throws:

ArgumentSyntaxException

toString

public String toString()

Overrides:

toString in class Object