net.lenni0451.commandlib.types

Class EnumType<E,T extends java.lang.Enum<T>>

java.lang.Object

net.lenni0451.commandlib.types.EnumType<E,T>

Type Parameters:

E - The type of the executor

T - The enum type

All Implemented Interfaces:

ArgumentType<E,T>

public class EnumType<E,T extends java.lang.Enum<T>>
extends java.lang.Object
implements ArgumentType<E,T>

The enum type parses an enum value from the string reader.

Method Summary

Modifier and Type	Method and Description
int	getWeight()
static <E,T extends java.lang.Enum<T>> EnumType<E,T>	of(java.lang.Class<T> enumClass) Create a new enum type.
void	parseCompletions(java.util.Set<java.lang.String> completions, ExecutionContext<E> executionContext, StringReader stringReader) Provide the completions of this argument.
T	parseValue(ExecutionContext<E> executionContext, StringReader stringReader) Parses the value of the argument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static <E,T extends java.lang.Enum<T>> EnumType<E,T> of(java.lang.Class<T> enumClass)

Create a new enum type.

Type Parameters:

E - The type of the executor

T - The enum type

Parameters:

enumClass - The enum class

Returns:

The new enum type

getWeight

public int getWeight()

Specified by:

getWeight in interface ArgumentType<E,T extends java.lang.Enum<T>>

Returns:

The weight of this type. The higher the weight the more important it is.

parseValue

@Nonnull
public T parseValue(ExecutionContext<E> executionContext,
                              StringReader stringReader)
                       throws ArgumentParseException,
                              java.lang.RuntimeException

Description copied from interface: ArgumentType

Parses the value of the argument.

Specified by:

parseValue in interface ArgumentType<E,T extends java.lang.Enum<T>>

Parameters:

executionContext - The execution context

stringReader - The string reader

Returns:

The parsed value

Throws:

ArgumentParseException - If the value could not be parsed

java.lang.RuntimeException - If an unexpected error occurred

parseCompletions

public void parseCompletions(java.util.Set<java.lang.String> completions,
                             ExecutionContext<E> executionContext,
                             StringReader stringReader)

Description copied from interface: ArgumentType

Provide the completions of this argument.

Specified by:

parseCompletions in interface ArgumentType<E,T extends java.lang.Enum<T>>

Parameters:

completions - The set of completions

executionContext - The execution context

stringReader - The string reader