me.vaperion.blade.argument.impl

Class EnumArgument

java.lang.Object

me.vaperion.blade.argument.impl.EnumArgument

All Implemented Interfaces:

ArgumentProvider<java.lang.Enum>

public class EnumArgument
extends java.lang.Object
implements ArgumentProvider<java.lang.Enum>

Constructor Summary

Constructors

Constructor and Description
EnumArgument()

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.String	defaultArgName(@NotNull java.lang.reflect.AnnotatedElement element) Provides a default argument name for this provider.
@Nullable java.lang.Enum	provide(@NotNull Context ctx, @NotNull InputArgument arg) Converts the given InputArgument into the specific type.
void	suggest(@NotNull Context ctx, @NotNull InputArgument arg, @NotNull SuggestionsBuilder suggestions) Suggests possible completions for the given InputArgument.

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.vaperion.blade.argument.ArgumentProvider

alwaysParseQuotes, handlesNullInputArguments, suggestRich

Constructor Detail

EnumArgument

public EnumArgument()

Method Detail

provide

@Nullable
public @Nullable java.lang.Enum provide(@NotNull
                                                  @NotNull Context ctx,
                                                  @NotNull
                                                  @NotNull InputArgument arg)
                                           throws BladeParseError

Description copied from interface: ArgumentProvider

Converts the given InputArgument into the specific type.

Specified by:

provide in interface ArgumentProvider<java.lang.Enum>

Parameters:

ctx - the command context

arg - the input argument

Returns:

the converted value, or null if conversion failed

Throws:

BladeParseError - if an error occurs during conversion (use BladeParseError.fatal(String) or BladeParseError.recoverable(String).)

suggest

public void suggest(@NotNull
                    @NotNull Context ctx,
                    @NotNull
                    @NotNull InputArgument arg,
                    @NotNull
                    @NotNull SuggestionsBuilder suggestions)
             throws BladeParseError

Description copied from interface: ArgumentProvider

Suggests possible completions for the given InputArgument.

Specified by:

suggest in interface ArgumentProvider<java.lang.Enum>

Parameters:

ctx - the command context

arg - the input argument

suggestions - the suggestions builder

Throws:

BladeParseError - if an error occurs during suggestion generation (use BladeParseError.fatal(String) or BladeParseError.recoverable(String).)

defaultArgName

@Nullable
public @Nullable java.lang.String defaultArgName(@NotNull
                                                           @NotNull java.lang.reflect.AnnotatedElement element)

Description copied from interface: ArgumentProvider

Provides a default argument name for this provider.

Specified by:

defaultArgName in interface ArgumentProvider<java.lang.Enum>

Parameters:

element - the annotated element (parameter)

Returns:

the default argument name, or null if none

See Also:

Name