Constructor Detail

• ParamParser

  public ParamParser(String spec)

Method Detail

• getUsage

  public String getUsage(String commandName)

  Build a usage summary string.

  Parameters:

  commandName - command name

  Returns:

  usage string

• getOptionFlags

  public Set<ParamParser.Param> getOptionFlags()

  Get option flags.

  Returns:

  optional parameters

• getParameters

  public List<ParamParser.Param> getParameters()

  Get regular parameters, in expected order.

  Returns:

  mandatory parameters

• getParser

  protected Parser<?> getParser(String typeName)

  Convert parameter spec type name into a Parser.

  The implementation in ParamParser supports all of the pre-defined types of FieldTypeRegistry (identified by their names), plus word to parse a String containing one or more non-whitespace characters. Subclasses should override as required to add additional supported types.

  Parameters:

  typeName - name of type

  Returns:

  parser for parameters of the specified type

  Throws:

  IllegalArgumentException - if typeName is unknown

• parse

  public Map<String,Object> parse(ParseSession session,
                         ParseContext ctx,
                         boolean complete)

  Parse command line parameters.

  Specified by:

  parse in interface Parser<Map<String,Object>>

  Parameters:

  session - associated session

  ctx - parse context positioned at whitespace preceeding parameters (if any)

  complete - true if we're only determining completions

  Throws:

  ParseException - if parse fails