Package cloud.commandframework.annotations.parsers

Class MethodArgumentParser<C,T>

java.lang.Object

cloud.commandframework.annotations.parsers.MethodArgumentParser<C,T>

Type Parameters:

C - Command sender type

T - Argument type

All Implemented Interfaces:

cloud.commandframework.arguments.parser.ArgumentParser<C,T>

public final class MethodArgumentParser<C,T>
extends Object
implements cloud.commandframework.arguments.parser.ArgumentParser<C,T>

Represents a method annotated with Parser

Since:

1.3.0

Field Summary

Fields inherited from interface cloud.commandframework.arguments.parser.ArgumentParser

DEFAULT_ARGUMENT_COUNT

Constructor Summary

Constructors

Constructor	Description
MethodArgumentParser(@NonNull BiFunction<cloud.commandframework.context.CommandContext<C>,String,List<String>> suggestionProvider, @NonNull Object instance, @NonNull Method method)	Create a new parser

Method Summary

Modifier and Type	Method	Description
@NonNull cloud.commandframework.arguments.parser.ArgumentParseResult<@NonNull T>	parse(@NonNull cloud.commandframework.context.CommandContext<@NonNull C> commandContext, @NonNull Queue<@NonNull String> inputQueue)
@NonNull List<@NonNull String>	suggestions(@NonNull cloud.commandframework.context.CommandContext<C> commandContext, @NonNull String input)

Methods inherited from class java.lang.Object

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

Methods inherited from interface cloud.commandframework.arguments.parser.ArgumentParser

getRequestedArgumentCount, isContextFree, map

Constructor Details

MethodArgumentParser

public MethodArgumentParser(@NonNull BiFunction<cloud.commandframework.context.CommandContext<C>,String,List<String>> suggestionProvider,
 @NonNull Object instance,
 @NonNull Method method)
                     throws Exception

Create a new parser

Parameters:

suggestionProvider - Suggestion provider

instance - Instance that owns the method

method - The annotated method

Throws:

Exception - If the method lookup fails

Method Details

parse

public @NonNull cloud.commandframework.arguments.parser.ArgumentParseResult<@NonNull T> parse(@NonNull cloud.commandframework.context.CommandContext<@NonNull C> commandContext,
 @NonNull Queue<@NonNull String> inputQueue)

Specified by:

parse in interface cloud.commandframework.arguments.parser.ArgumentParser<C,T>

suggestions

public @NonNull List<@NonNull String> suggestions(@NonNull cloud.commandframework.context.CommandContext<C> commandContext,
 @NonNull String input)

Specified by:

suggestions in interface cloud.commandframework.arguments.parser.ArgumentParser<C,T>