Package io.github.mqzn.commands.arguments

Class ArgumentEnum<E extends Enum<E>>

java.lang.Object

io.github.mqzn.commands.arguments.AbstractArgument<E>

io.github.mqzn.commands.arguments.ArgumentEnum<E>

All Implemented Interfaces:

Argument<E>

public final class ArgumentEnum<E extends Enum<E>>
extends AbstractArgument<E>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ArgumentEnum.Format

Field Summary

Fields inherited from class io.github.mqzn.commands.arguments.AbstractArgument

suggestions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<String>	entries()
<S> E	parse(S sender, @NotNull String command, @NotNull String input)	Parses the raw input into it's argument type The argument type must be registered and defined by the user
ArgumentEnum<E>	setFormat(@NotNull ArgumentEnum.Format format)
String	toString(E obj)	changes the type of argument's object to a string

Methods inherited from class io.github.mqzn.commands.arguments.AbstractArgument

asOptional, defaultValue, description, description, equals, hashCode, id, isOptional, setDefaultValue, setOptional, suggest, suggest, suggestions, toString, type, useRemainingSpace

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mqzn.commands.arguments.Argument

alternativeTypes, isSuggestionDynamic

Constructor Details

ArgumentEnum

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

ArgumentEnum

public ArgumentEnum(@NotNull
 @NotNull ArgumentData data,
 Class<E> enumClass)

Method Details

setFormat

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

parse

@NotNull
public <S> E parse(@NotNull
 S sender,
 @NotNull
 @NotNull String command,
 @NotNull
 @NotNull String input)
            throws ArgumentParseException

Description copied from interface: Argument

Parses the raw input into it's argument type The argument type must be registered and defined by the user

Type Parameters:

S - the sender type

Parameters:

sender - the sender of the command

command - the command

input - the raw argument

Returns:

the parsed object from raw

Throws:

ArgumentParseException - when it fails to parse the raw argument

entries

public List<String> entries()

toString

public String toString(E obj)

Description copied from class: AbstractArgument

changes the type of argument's object to a string

Specified by:

toString in interface Argument<E extends Enum<E>>

Overrides:

toString in class AbstractArgument<E extends Enum<E>>

Parameters:

obj - the object type of the argument

Returns:

object as string