Package cloud.commandframework.annotations.parsers

Class 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 java.lang.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 java.util.function.BiFunction<cloud.commandframework.context.CommandContext<C>,​java.lang.String,​java.util.List<java.lang.String>> suggestionProvider, @NonNull java.lang.Object instance, @NonNull java.lang.reflect.Method method)
      Create a new parser

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @NonNull cloud.commandframework.arguments.parser.ArgumentParseResult<@NonNull T> parse​(@NonNull cloud.commandframework.context.CommandContext<@NonNull C> commandContext, @NonNull java.util.Queue<@NonNull java.lang.String> inputQueue)  
      @NonNull java.util.List<@NonNull java.lang.String> suggestions​(@NonNull cloud.commandframework.context.CommandContext<C> commandContext, @NonNull java.lang.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

    • Constructor Detail

      • MethodArgumentParser

        public MethodArgumentParser​(@NonNull java.util.function.BiFunction<cloud.commandframework.context.CommandContext<C>,​java.lang.String,​java.util.List<java.lang.String>> suggestionProvider,
                            @NonNull java.lang.Object instance,
                            @NonNull java.lang.reflect.Method method)
                     throws java.lang.Exception
        Create a new parser
        Parameters:
        suggestionProvider - Suggestion provider
        instance - Instance that owns the method
        method - The annotated method
        Throws:
        java.lang.Exception - If the method lookup fails

    • Method Detail

      • parse

        public @NonNull cloud.commandframework.arguments.parser.ArgumentParseResult<@NonNull T> parse​(@NonNull cloud.commandframework.context.CommandContext<@NonNull C> commandContext,
                                                                                              @NonNull java.util.Queue<@NonNull java.lang.String> inputQueue)
        Specified by:
        parse in interface cloud.commandframework.arguments.parser.ArgumentParser<C,​T>

      • suggestions

        public @NonNull java.util.List<@NonNull java.lang.String> suggestions​(@NonNull cloud.commandframework.context.CommandContext<C> commandContext,
                                                                      @NonNull java.lang.String input)
        Specified by:
        suggestions in interface cloud.commandframework.arguments.parser.ArgumentParser<C,​T>