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

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

public class ClockDomainCommandParser
extends com.martiansoftware.jsap.JSAP

A command-line argument parser for ClockDomainArchitectureImpl, based on JSAP (Java-based Simple Argument Parser). This class handles the parsing of all command-line arguments, ensuring that they are syntactically correct. It also provides automatically-formated usage and help information (--help option).

Author:
Kevin Lundgreen
See Also:
DWCCommandParser, JSAP, JSAPCommandParser, JSAP API, JSAP Homepage

Field Summary
protected  java.util.LinkedHashSet<com.martiansoftware.jsap.Parameter> _ClockAnalyzerParameters
          Ordered List of parameters to easily register them all or print them all
protected  com.martiansoftware.jsap.JSAPResult _result
          JSAPResult object used to store the parameters after being parsed.
static java.lang.String CREATE_DOTTY_GRAPH
           
static java.lang.String DIR
           
static java.lang.String DO_SCC_ANALYSIS
           
static java.lang.String DOMAIN
           
static java.lang.String FALSE
           
static java.lang.String FILE
           
static java.lang.String HELP
           
static java.lang.String INPUT_FILE
           
static char LIST_DELIMITER
           
static java.lang.String NO_IOB_FEEDBACK
           
static java.lang.String OUTPUT_FILE
           
static java.lang.String SHOW_ASYNCHRONOUS
           
static java.lang.String SHOW_ASYNCHRONOUS_RESET_CELLS
           
static java.lang.String SHOW_ASYNCHRONOUS_RESETS
           
static java.lang.String SHOW_CELLS
           
static java.lang.String SHOW_CLOCK_CROSSINGS
           
static java.lang.String SHOW_GATED_CLOCKS
           
static java.lang.String SHOW_NETS
           
static java.lang.String SHOW_NO_DOMAIN
           
static java.lang.String SHOW_SYNCHRONOUS
           
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
ClockDomainCommandParser()
          Create a new ClockDomainCommandParser.
 
Method Summary
 java.lang.String getUsage()
          Modified from JSAP.getUsage() by delimiting parameters with a newline rather than simply a space.
static void main(java.lang.String[] args)
          For testing purposes only.
 com.martiansoftware.jsap.JSAPResult parse(java.lang.String[] args)
          Overrides JSAP.parse(String[])
 
Methods inherited from class com.martiansoftware.jsap.JSAP
finalize, getByID, getByLongFlag, getByShortFlag, getByShortFlag, getDefaults, getHelp, getHelp, getHelp, getIDMap, getUnflaggedOptionsIterator, 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

FALSE

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

INPUT_FILE

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

OUTPUT_FILE

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

LIST_DELIMITER

public static final char LIST_DELIMITER
See Also:
Constant Field Values

DIR

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

FILE

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

DOMAIN

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

SHOW_NO_DOMAIN

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

SHOW_CLOCK_CROSSINGS

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

CREATE_DOTTY_GRAPH

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

SHOW_CELLS

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

SHOW_NETS

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

SHOW_SYNCHRONOUS

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

SHOW_ASYNCHRONOUS

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

DO_SCC_ANALYSIS

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

NO_IOB_FEEDBACK

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

SHOW_GATED_CLOCKS

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

SHOW_ASYNCHRONOUS_RESETS

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

SHOW_ASYNCHRONOUS_RESET_CELLS

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

HELP

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

VERSION

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

_ClockAnalyzerParameters

protected java.util.LinkedHashSet<com.martiansoftware.jsap.Parameter> _ClockAnalyzerParameters
Ordered List of parameters to easily register them all or print them all


_result

protected com.martiansoftware.jsap.JSAPResult _result
JSAPResult object used to store the parameters after being parsed.

Constructor Detail

ClockDomainCommandParser

public ClockDomainCommandParser()
Create a new ClockDomainCommandParser.

Method Detail

getUsage

public java.lang.String getUsage()
Modified from JSAP.getUsage() by delimiting parameters with a newline rather than simply a space. Also includes a "concise usage" string.

Overrides:
getUsage in class com.martiansoftware.jsap.JSAP
Returns:
A String with both concise and verbose usage information.
See Also:
JSAP.getUsage()

main

public static void main(java.lang.String[] args)
For testing purposes only. Parses the command-line arguments, which ensures that they are valid, and then simply prints a list of all the arguments.

Parameters:
args - Command-line arguments

parse

public com.martiansoftware.jsap.JSAPResult parse(java.lang.String[] args)
Overrides JSAP.parse(String[])

Overrides:
parse in class com.martiansoftware.jsap.JSAP
Parameters:
args - Command-line arguments