Constructor Detail

• Parser

  public Parser()

Method Detail

• parse

  public CommandLine parse(String[] arguments)
                    throws OptionException

  Parse the arguments according to the specified options and properties.

  Parameters:

  arguments - the command line arguments

  Returns:

  the list of atomic option and value tokens

  Throws:

  OptionException - if there are any problems encountered while parsing the command line tokens.

• parseAndHelp

  public CommandLine parseAndHelp(String[] arguments)

  Parse the arguments according to the specified options and properties and displays the usage screen if the CommandLine is not valid or the help option was specified.

  Parameters:

  arguments - the command line arguments

  Returns:

  a valid CommandLine or null if the parse was unsuccessful

• setGroup

  public void setGroup(Group group)

  Sets the Group of options to parse against

  Parameters:

  group - the group of options to parse against

• setHelpFormatter

  public void setHelpFormatter(HelpFormatter helpFormatter)

  Sets the HelpFormatter to use with the simplified parsing.

  Parameters:

  helpFormatter - the HelpFormatter to use with the simplified parsing

  See Also:

  parseAndHelp(String[])

• setHelpOption

  public void setHelpOption(Option helpOption)

  Sets the help option to use with the simplified parsing. For example --help, -h and -? are often used.

  Parameters:

  helpOption - the help Option

  See Also:

  parseAndHelp(String[])

• setHelpTrigger

  public void setHelpTrigger(String helpTrigger)

  Sets the help option to use with the simplified parsing. For example --help, -h and -? are often used.

  Parameters:

  helpTrigger - the trigger of the help Option

  See Also:

  parseAndHelp(String[])