org.incava.jagol
Class OptionSet

java.lang.Object
  extended by org.incava.jagol.OptionSet
Direct Known Subclasses:
Options

public class OptionSet
extends java.lang.Object

A group of options.


Constructor Summary
OptionSet(java.lang.String appName, java.lang.String description)
           
 
Method Summary
 void add(Option opt)
          Adds an options to this set.
 void addRunControlFile(java.lang.String name)
          Adds a run control file to be processed.
 java.lang.String getAppName()
          Returns the application name.
 java.lang.String getDescription()
          Returns the description.
 java.lang.String[] process(java.lang.String[] args)
          Processes the run control files and command line arguments.
protected  java.lang.String[] processCommandLine(java.lang.String[] args)
          Processes the command line arguments.
protected  void processRunControlFiles()
          Processes the run control files, if any.
protected  void showConfig()
           
protected  void showUsage()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptionSet

public OptionSet(java.lang.String appName,
                 java.lang.String description)
Method Detail

getAppName

public java.lang.String getAppName()
Returns the application name.


getDescription

public java.lang.String getDescription()
Returns the description.


add

public void add(Option opt)
Adds an options to this set.


addRunControlFile

public void addRunControlFile(java.lang.String name)
Adds a run control file to be processed.


process

public java.lang.String[] process(java.lang.String[] args)
Processes the run control files and command line arguments. Returns the arguments that were not consumed by option processing.


processRunControlFiles

protected void processRunControlFiles()
Processes the run control files, if any.


processCommandLine

protected java.lang.String[] processCommandLine(java.lang.String[] args)
Processes the command line arguments. Returns the arguments that were not consumed by option processing.


showUsage

protected void showUsage()

showConfig

protected void showConfig()