Constructor Detail

• CommandLineOptions

  public CommandLineOptions()

Method Detail

• addFlag

  public void addFlag​(java.lang.String flag)

  Adds the flag to list of available command line options.

  Parameters:

  flag - the flag to add as an available command line option.

• addFlag

  public void addFlag​(java.lang.String flag,
                      java.lang.String comment)

  Adds the flag to list of available command line options.

  Parameters:

  flag - the flag to add as an available command line option.

  comment - a comment for the flag.

• addFlag

  public void addFlag​(java.lang.String flag,
                      java.lang.String usageText,
                      java.lang.String comment)

  Adds the flag to list of available command line options.

  Parameters:

  flag - the flag to add as an available command line option.

  comment - a comment for the flag.

  usageText - the text that appears after the flag in the usage string.

• addFlag

  public void addFlag​(java.lang.String flag,
                      java.lang.String usageText,
                      java.lang.String comment,
                      boolean optional)

  Adds the flag to list of available command line options.

  Parameters:

  flag - The flag to add as an available command line option.

  comment - A comment for the flag.

  usageText - The text that appears after the flag in the usage string.

  optional - When true, indicates that this flag is optional.

• getOptions

  public java.util.Properties getOptions​(java.lang.String[] args)

  Parses the arguments into a hashtable with the proper flag as the key.

• setComment

  public void setComment​(java.lang.String flag,
                         java.lang.String comment)

  Sets a comment for the flag.

  Parameters:

  flag - the flag to set the comment for.

  comment - the comment to use when printing help for the given flag.

• setOptional

  public void setOptional​(java.lang.String flag,
                          boolean optional)

  Sets whether or not a given flag is optional.

  Parameters:

  flag - the flag to set optionality for.

  optional - the boolean indicating the optionality for the given flag.

• setUsageInfo

  public void setUsageInfo​(java.lang.String flag,
                           java.lang.String usage)

  Sets the text to print after the flag when printing the usage line.

  Parameters:

  flag - the flag to set the usage info for.

  usage - the usage text.

• printUsage

  public void printUsage​(java.io.PrintWriter pw)

• printHelp

  public void printHelp​(java.io.PrintWriter pw)