edu.byu.ece.edif.util.jsap
Class EdifCommandParser

java.lang.Object
  extended by com.martiansoftware.jsap.JSAP
      extended by edu.byu.ece.edif.util.jsap.EdifCommandParser

public class EdifCommandParser
extends com.martiansoftware.jsap.JSAP

A standard command line parser for the EDIF infrastructure, using the JSAP (Java-based Simple Argument Parser) with additional functionality.

TODO:

See Also:
JSAP API, JSAP Homepage, JSAP

Field Summary
private  java.util.LinkedHashSet<com.martiansoftware.jsap.Parameter> _commands
           
(package private) static java.lang.String HELP
           
(package private) static java.lang.String VERSION
           
 
Fields inherited from class com.martiansoftware.jsap.JSAP
BIGDECIMAL_PARSER, BIGINTEGER_PARSER, BOOLEAN_PARSER, BYTE_PARSER, CHARACTER_PARSER, CLASS_PARSER, COLOR_PARSER, DEFAULT_LISTSEPARATOR, DEFAULT_PARAM_HELP_SEPARATOR, DEFAULT_SCREENWIDTH, DOUBLE_PARSER, FLOAT_PARSER, GREEDY, INETADDRESS_PARSER, INTEGER_PARSER, INTSIZE_PARSER, LIST, LONG_PARSER, LONGSIZE_PARSER, MULTIPLEDECLARATIONS, NO_DEFAULT, NO_HELP, NO_LONGFLAG, NO_MULTIPLEDECLARATIONS, NO_SHORTFLAG, NOT_GREEDY, NOT_LIST, NOT_REQUIRED, PACKAGE_PARSER, REQUIRED, SHORT_PARSER, STRING_PARSER, URL_PARSER
 
Constructor Summary
EdifCommandParser()
           
 
Method Summary
 void addCommands(CommandGroup group)
           
 java.util.Set<com.martiansoftware.jsap.Parameter> getCommands()
           
static java.lang.String getVersionInfo()
           
 com.martiansoftware.jsap.JSAPResult parse(java.lang.String[] args, java.io.PrintStream err)
          Parses the command line, and looks for options that will kill the program (help, version, and write_config_file)
 
Methods inherited from class com.martiansoftware.jsap.JSAP
finalize, getByID, getByLongFlag, getByShortFlag, getByShortFlag, getDefaults, getHelp, getHelp, getHelp, getIDMap, getUnflaggedOptionsIterator, getUsage, parse, parse, registerDefaultSource, registerParameter, setHelp, setUsage, toString, unregisterDefaultSource, unregisterParameter
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_commands

private java.util.LinkedHashSet<com.martiansoftware.jsap.Parameter> _commands

HELP

static final java.lang.String HELP
See Also:
Constant Field Values

VERSION

static final java.lang.String VERSION
See Also:
Constant Field Values
Constructor Detail

EdifCommandParser

public EdifCommandParser()
Method Detail

parse

public com.martiansoftware.jsap.JSAPResult parse(java.lang.String[] args,
                                                 java.io.PrintStream err)
Parses the command line, and looks for options that will kill the program (help, version, and write_config_file)

Parameters:
args -
err -
Returns:

getVersionInfo

public static java.lang.String getVersionInfo()

addCommands

public void addCommands(CommandGroup group)

getCommands

public java.util.Set<com.martiansoftware.jsap.Parameter> getCommands()