me.vaperion.blade.argument

Interface ArgumentProvider<T>

Type Parameters:

T - the type

All Known Implementing Classes:

BooleanArgument, ByteArgument, DoubleArgument, EnumArgument, FloatArgument, IntArgument, LongArgument, ShortArgument, StringArgument, UUIDArgument

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ArgumentProvider<T>

A provider that converts the given InputArgument into a specific type.

Method Summary

Modifier and Type	Method and Description
default boolean	alwaysParseQuotes() Whether this provider wants to always parse quotes from the input.
default @Nullable java.lang.String	defaultArgName(@NotNull java.lang.reflect.AnnotatedElement element) Provides a default argument name for this provider.
default boolean	handlesNullInputArguments() Whether this provider should be called when the argument is null.
T	provide(@NotNull Context ctx, @NotNull InputArgument arg) Converts the given InputArgument into the specific type.
default void	suggest(@NotNull Context ctx, @NotNull InputArgument arg, @NotNull SuggestionsBuilder suggestions) Suggests possible completions for the given InputArgument.
default void	suggestRich(@NotNull Context ctx, @NotNull InputArgument arg, @NotNull RichSuggestionsBuilder suggestions) Suggests possible completions for the given InputArgument.

Method Detail

handlesNullInputArguments

default boolean handlesNullInputArguments()

Whether this provider should be called when the argument is null.

This is useful for providers that want to implement logic for optional arguments, like handling Opt.Type#SENDER.

Returns:

true if the provider should be called with a null argument, false otherwise

provide

@Nullable
T provide(@NotNull
                    @NotNull Context ctx,
                    @NotNull
                    @NotNull InputArgument arg)
             throws BladeParseError

Converts the given InputArgument into the specific type.

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

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

Suggests possible completions for the given InputArgument.

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).)

suggestRich

default void suggestRich(@NotNull
                         @NotNull Context ctx,
                         @NotNull
                         @NotNull InputArgument arg,
                         @NotNull
                         @NotNull RichSuggestionsBuilder suggestions)
                  throws BladeParseError

Suggests possible completions for the given InputArgument.

This overload supports richer suggestion metadata, such as tooltips and numeric suggestions, for Brigadier-based platforms.

Parameters:

ctx - the command context

arg - the input argument

suggestions - the rich suggestions builder

Throws:

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

defaultArgName

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

Provides a default argument name for this provider.

Parameters:

element - the annotated element (parameter)

Returns:

the default argument name, or null if none

See Also:

Name

alwaysParseQuotes

default boolean alwaysParseQuotes()

Whether this provider wants to always parse quotes from the input.

If true, the input argument will have quotes parsed even if the command method or parameter is not annotated with Quoted.

Returns:

true if quotes should always be parsed, false otherwise