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

Class ArgumentEnum<E extends Enum>

java.lang.Object

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

net.minestom.server.command.builder.arguments.ArgumentEnum<E>

public class ArgumentEnum<E extends Enum>
extends Argument<E>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ArgumentEnum.Format

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NOT_ENUM_VALUE_ERROR

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

allowSpace, suggestionType, useRemaining

Constructor Summary

Constructors

Constructor	Description
ArgumentEnum(@NotNull String id, Class<E> enumClass)

Method Summary

Modifier and Type	Method	Description
List<String>	entries()
E	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()
ArgumentEnum<E>	setFormat(@NotNull ArgumentEnum.Format format)
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

NOT_ENUM_VALUE_ERROR

public static final int NOT_ENUM_VALUE_ERROR

See Also:

• Constant Field Values

Constructor Details

ArgumentEnum

public ArgumentEnum(@NotNull
 @NotNull String id,
 Class<E> enumClass)

Method Details

setFormat

public ArgumentEnum<E> setFormat(@NotNull
 @NotNull ArgumentEnum.Format format)

parse

@NotNull
public E 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<E extends Enum>

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<E extends Enum>

entries

public List<String> entries()

toString

public String toString()

Overrides:

toString in class Object