Class SingleCommand<C>

  • Type Parameters:
    C - Command type

    public class SingleCommand<C>
    extends java.lang.Object
    Class for encapsulating and parsing single commands
    • Constructor Detail

    • Method Detail

      • singleCommand

        public static <C> SingleCommand<C> singleCommand​(java.lang.Class<C> command)
        Creates a new single command
        Type Parameters:
        C - Command type we wish to parse to
        Parameters:
        command - Command class
        Returns:
        Single command parser
      • singleCommand

        public static <C> SingleCommand<C> singleCommand​(java.lang.Class<C> command,
                                                         ParserMetadata<C> parserConfig)
        Creates a new single command
        Type Parameters:
        C - Command type we wish to parse to
        Parameters:
        command - Command class
        parserConfig - Parser configuration to use, if null the default configuration is used
        Returns:
        Single command parser
      • getCommandMetadata

        public CommandMetadata getCommandMetadata()
        Gets the command metadata
        Returns:
        Command metadata
      • getParserConfiguration

        public ParserMetadata<C> getParserConfiguration()
        Gets the parser configuration
        Returns:
        Parser configuration
      • parse

        public C parse​(java.lang.String... args)
        Parses the arguments to produce a command instance
        Parameters:
        args - Arguments
        Returns:
        Command instance
      • parse

        public C parse​(java.lang.Iterable<java.lang.String> args)
        Parses the arguments to produce a command instance
        Parameters:
        args - Arguments
        Returns:
        Command instance
      • parseWithResult

        public ParseResult<C> parseWithResult​(java.lang.String... args)
        Parses the arguments to produce a result. The result can be inspected to see errors (assuming a suitable error handler was used e.g. CollectAll) and to get a command instance
        Parameters:
        args - Arguments
        Returns:
        Parse result
      • parseWithResult

        public ParseResult<C> parseWithResult​(java.lang.Iterable<java.lang.String> args)
        Parses the arguments to produce a result. The result can be inspected to see errors (assuming a suitable error handler was used e.g. CollectAll) and to get a command instance
        Parameters:
        args - Arguments
        Returns:
        Parse result