Class CommandLineOptions

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

public class CommandLineOptions extends Object
A utility class for generating command line options
Version:
$Revision: 3633 $ $Date: 2003-03-01 08:38:44 +0100 (Sat, 01 Mar 2003) $
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
    • 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
    • setInvokeCommand

      public void setInvokeCommand(String invokeCommand)
      Sets the command used to invoke the application
      Parameters:
      invokeCommand - the command used to invoke the application
    • 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)