watch
Class Args

java.lang.Object
  extended by watch.Args
Direct Known Subclasses:
EditorArgs

 class Args
extends java.lang.Object

Command line argument processing.


Nested Class Summary
protected static class Args.BooleanOption
          Boolean command line option management.
protected static class Args.Option
          Command line option management.
protected static class Args.StringOption
          String command line option management.
 
Constructor Summary
protected Args(java.lang.String J_AppShortName, java.lang.String J_AppFullName)
          Constructor.
 
Method Summary
protected  Args.Option addBooleanOption(char C_Option, java.lang.String J_Option, java.lang.String J_ShortDescription, java.lang.String J_DetailedDescription)
          Boolean option addition.
protected  Args.Option addStringOption(char C_Option, java.lang.String J_Option, java.lang.String J_ShortDescription, java.lang.String J_DetailedDescription)
          String option addition.
 java.lang.String getAppFullName()
          Full name of application accessor.
 java.lang.String getAppShortName()
          Short name of application handler.
 boolean getbQuiet()
          Quiet option value accessor.
 boolean getbVerbose()
          Verbose option value accessor.
 java.util.Vector<java.lang.String> getInputFiles()
          Input files accessor.
 java.util.Vector<java.lang.String> getTraces()
          Traces option settings accessor.
 void parse(java.lang.String[] ARJ_Args)
          Argument parsing.
protected  void printUsage()
          Displays a help message explaining the usage of the program.
protected  void setRemainingArgsDescription(java.lang.String J_ShortDescription, java.lang.String J_DetailedDescription)
          Remaining arguments description.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Args

protected Args(java.lang.String J_AppShortName,
               java.lang.String J_AppFullName)
Constructor.

Parameters:
J_AppShortName - Application short name.
J_AppFullName - Application full name.
Method Detail

setRemainingArgsDescription

protected void setRemainingArgsDescription(java.lang.String J_ShortDescription,
                                           java.lang.String J_DetailedDescription)
Remaining arguments description.

Parameters:
J_ShortDescription - Short description for remaining arguments.
J_DetailedDescription - Detailed description for remaining arguments.

addBooleanOption

protected Args.Option addBooleanOption(char C_Option,
                                       java.lang.String J_Option,
                                       java.lang.String J_ShortDescription,
                                       java.lang.String J_DetailedDescription)
Boolean option addition.

Parameters:
C_Option - Single character option name.
J_Option - Full option name.
J_ShortDescription - Short description of the option.
J_DetailedDescription - Detailed description of the option.
Returns:
The new boolean option.

addStringOption

protected Args.Option addStringOption(char C_Option,
                                      java.lang.String J_Option,
                                      java.lang.String J_ShortDescription,
                                      java.lang.String J_DetailedDescription)
String option addition.

Parameters:
C_Option - Single character option name.
J_Option - Full option name.
J_ShortDescription - Short description of the option.
J_DetailedDescription - Detailed description of the option.
Returns:
The new string option.

getAppFullName

public java.lang.String getAppFullName()
Full name of application accessor.

Returns:
The full name of the application.

getAppShortName

public java.lang.String getAppShortName()
Short name of application handler.

Returns:
The short name of the application.

printUsage

protected void printUsage()
Displays a help message explaining the usage of the program.


parse

public void parse(java.lang.String[] ARJ_Args)
Argument parsing.

Parameters:
ARJ_Args - List of arguments as received by a main() function.

getbVerbose

public boolean getbVerbose()
Verbose option value accessor.

Returns:
The verbose option.

getbQuiet

public boolean getbQuiet()
Quiet option value accessor.

Returns:
The quiet option.

getTraces

public java.util.Vector<java.lang.String> getTraces()
Traces option settings accessor.

Returns:
The Traces option settings. Each string set in the vector represent a selected trace class.

getInputFiles

public java.util.Vector<java.lang.String> getInputFiles()
Input files accessor.

Returns:
Input files list.