Constructor Detail

• CLArgsParser

  public CLArgsParser(String[] args,
              CLOptionDescriptor[] optionDescriptors,
              ParserControl control)

  Create a parser that can deal with options and parses certain args.

  Parameters:

  args - the args, typically that passed to the public static void main(String[] args) method.

  optionDescriptors - the option descriptors

• CLArgsParser

  public CLArgsParser(String[] args,
              CLOptionDescriptor[] optionDescriptors)

  Create a parser that deals with options and parses certain args.

  Parameters:

  args - the args

  optionDescriptors - the option descriptors

Method Detail

• getUnparsedArgs

  public final String[] getUnparsedArgs()

• getArguments

  public final Vector getArguments()

  Retrieve a list of options that were parsed from command list.

  Returns:

  the list of options

• getArgumentById

  public final CLOption getArgumentById(int id)

  Retrieve the CLOption with specified id, or null if no command line option is found.

  Parameters:

  id - the command line option id

  Returns:

  the CLOption with the specified id, or null if no CLOption is found.

  See Also:

  CLOption

• getArgumentByName

  public final CLOption getArgumentByName(String name)

  Retrieve the CLOption with specified name, or null if no command line option is found.

  Parameters:

  name - the command line option name

  Returns:

  the CLOption with the specified name, or null if no CLOption is found.

  See Also:

  CLOption

• getErrorString

  public final String getErrorString()

  Retrieve an error message that occured during parsing if one existed.

  Returns:

  the error string