Class CommandLineOptions

java.lang.Object
org.exolab.castor.util.CommandLineOptions

public class CommandLineOptions extends Object
A utility class for generating command line options.
Version:
$Revision: 8146 $ $Date: 2006-04-10 16:39:24 -0600 (Mon, 10 Apr 2006) $
Author:
Keith Visco
  • Constructor Details

    • CommandLineOptions

      public CommandLineOptions()
  • Method Details

    • addFlag

      public void addFlag(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(String flag, 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(String flag, String usageText, String comment)
      Adds the flag to list of available command line options.
      Parameters:
      flag - the flag to add as an available command line option.
      usageText - the text that appears after the flag in the usage string.
      comment - a comment for the flag.
    • addFlag

      public void addFlag(String flag, String usageText, 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.
      usageText - The text that appears after the flag in the usage string.
      comment - A comment for the flag.
      optional - When true, indicates that this flag is optional.
    • getOptions

      public Properties getOptions(String[] args)
      Parses the arguments into a hashtable with the proper flag as the key.
    • setComment

      public void setComment(String flag, 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(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(String flag, 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(PrintWriter pw)
    • printHelp

      public void printHelp(PrintWriter pw)