Class CommandParser


  • public class CommandParser
    extends java.lang.Object
    A class to parse a series of commands, with the help of their associated command managers.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CommandParser.Fault
      Thrown when a bad command line argument is encountered.
    • Constructor Summary

      Constructors 
      Constructor Description
      CommandParser​(CommandManager... mgrs)
      Create a parser to parse the commands accepted by a set of command managers.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void parse​(java.lang.String[] args, boolean urlEncoded, CommandContext ctx)
      Parse command line arguments into a series of commands.
      void parse​(java.lang.String[] args, CommandContext ctx)
      Parse command line arguments into a series of commands.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CommandParser

        public CommandParser​(CommandManager... mgrs)
        Create a parser to parse the commands accepted by a set of command managers.
        Parameters:
        mgrs - the command managers for the commands that can be parsed
    • Method Detail

      • parse

        public void parse​(java.lang.String[] args,
                          CommandContext ctx)
                   throws CommandParser.Fault
        Parse command line arguments into a series of commands.
        Parameters:
        args - the args to be parsed
        ctx - the context in which to store the commands that are created
        Throws:
        CommandParser.Fault - if there are any problems with a command that is parsed, such as missing or inappropriate options
      • parse

        public void parse​(java.lang.String[] args,
                          boolean urlEncoded,
                          CommandContext ctx)
                   throws CommandParser.Fault
        Parse command line arguments into a series of commands.
        Parameters:
        args - the args to be parsed
        urlEncoded - whether or not the args have been encoded according to the "application/x-www-form-urlencoded" MIME format.
        ctx - the context in which to store the commands that are created
        Throws:
        CommandParser.Fault - if there are any problems with a command that is parsed, such as missing or inappropriate options