JML

org.jmlspecs.jmldoc
Class JmldocOptions

java.lang.Object
  extended byorg.multijava.util.Options
      extended byorg.multijava.mjc.MjcCommonOptions
          extended byorg.jmlspecs.checker.JmlVersionOptions
              extended byorg.jmlspecs.checker.JmlCommonOptions
                  extended byorg.jmlspecs.jmldoc.JavadocOptions
                      extended byorg.jmlspecs.jmldoc.JmldocOptions
All Implemented Interfaces:
JavadocOptionsInterface

public class JmldocOptions
extends JavadocOptions

This class is automatically generated from JmldocOptions.opt and contains member fields corresponding to command-line options.


Field Summary
private  String docpath
           
private  String fcns
           
private static gnu.getopt.LongOpt[] LONGOPTS
           
private  boolean showPromotion
           
private  boolean test
           
 
Fields inherited from class org.jmlspecs.jmldoc.JavadocOptions
 
Fields inherited from class org.jmlspecs.checker.JmlCommonOptions
 
Fields inherited from class org.multijava.mjc.MjcCommonOptions
 
Fields inherited from class org.multijava.util.Options
 
Constructor Summary
JmldocOptions()
           
JmldocOptions(String name)
           
 
Method Summary
 String docpath()
           
 String fcns()
           
 Hashtable getCurrentValue()
          Returns the current value
 Hashtable getDefaultValue()
          Returns the default value
 Hashtable getGuiType()
          Returns the GUI categories that this option is in
 Hashtable getHelpString()
          Returns the help messages
 LinkedHashSet getLongname()
          Returns the longname
 gnu.getopt.LongOpt[] getLongOptions()
          Gets long options
 HashMap getOptions()
           
 Hashtable getSelectionList()
          Returns the list of selections for an option
 String getShortOptions()
          Gets short options
 Hashtable getTableHeader()
          Returns the header for a table
 Hashtable getType()
          Returns the type
 void help()
           
 boolean processOption(int code, gnu.getopt.Getopt g)
          Handles the option identified by the given code, perhaps using g to process any arguments to the option.
 String set_docpath(String docpath)
           
 String set_fcns(String fcns)
           
 boolean set_showPromotion(boolean showPromotion)
           
 boolean set_test(boolean test)
           
 boolean setOption(String name, Object newValue)
           
 boolean showPromotion()
           
 boolean test()
           
 void usage()
           
 
Methods inherited from class org.jmlspecs.jmldoc.JavadocOptions
author, bootclasspath, bottom, charset, docencoding, docfilessubdirs, doclet, docletpath, doctitle, encoding, exclude, excludedocfilessubdir, extdirs, footer, group, header, helpfile, J, link, linkoffline, linksource, locale, nocomment, nodeprecated, nodeprecatedlist, nohelp, noindex, nonavbar, nooverview, noqualifier, nosince, notree, overview, privacy, serialwarn, set_author, set_bootclasspath, set_bottom, set_charset, set_docencoding, set_docfilessubdirs, set_doclet, set_docletpath, set_doctitle, set_encoding, set_exclude, set_excludedocfilessubdir, set_extdirs, set_footer, set_group, set_header, set_helpfile, set_J, set_link, set_linkoffline, set_linksource, set_locale, set_nocomment, set_nodeprecated, set_nodeprecatedlist, set_nohelp, set_noindex, set_nonavbar, set_nooverview, set_noqualifier, set_nosince, set_notree, set_overview, set_privacy, set_serialwarn, set_splitindex, set_stylesheetfile, set_subpackages, set_tag, set_taglet, set_tagletpath, set_use, set_Version, set_windowtitle, set_x, set_xnodate, splitindex, stylesheetfile, subpackages, tag, taglet, tagletpath, use, Version, windowtitle, x, xnodate
 
Methods inherited from class org.jmlspecs.checker.JmlCommonOptions
admissibility, Assignable, assignable, defaultNonNull, excludefiles, experiment, filter, multijava, nonnull, purity, Quiet, set_admissibility, set_Assignable, set_assignable, set_defaultNonNull, set_excludefiles, set_experiment, set_filter, set_multijava, set_nonnull, set_purity, set_Quiet, set_universesx, set_UnsafeOpWarnings, universesx, UnsafeOpWarnings
 
Methods inherited from class org.jmlspecs.checker.JmlVersionOptions
version
 
Methods inherited from class org.multijava.mjc.MjcCommonOptions
classpath, debug, deprecation, destination, generic, keepGoing, nonnulltypes, quiet, recursive, relaxed, safemath, set_classpath, set_debug, set_deprecation, set_destination, set_generic, set_keepGoing, set_nonnulltypes, set_quiet, set_recursive, set_relaxed, set_safemath, set_source, set_sourcepath, set_verbose, set_warning, set_xArrayNNTS, set_Xlint, source, sourcepath, verbose, warning, xArrayNNTS, Xlint
 
Methods inherited from class org.multijava.util.Options
formOneColumnArray, formTwoColumnArray, getInt, getNonNullString, getNonNullStringArray, getString, getString, getSystemProperty, nonOptions, parseCommandLine, parseCommandLine, printOptions, printVersion, Xnoversion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

docpath

private String docpath

showPromotion

private boolean showPromotion

test

private boolean test

fcns

private String fcns

LONGOPTS

private static final gnu.getopt.LongOpt[] LONGOPTS
Constructor Detail

JmldocOptions

public JmldocOptions(String name)

JmldocOptions

public JmldocOptions()
Method Detail

docpath

public String docpath()

set_docpath

public String set_docpath(String docpath)

showPromotion

public boolean showPromotion()

set_showPromotion

public boolean set_showPromotion(boolean showPromotion)

test

public boolean test()

set_test

public boolean set_test(boolean test)

fcns

public String fcns()

set_fcns

public String set_fcns(String fcns)

processOption

public boolean processOption(int code,
                             gnu.getopt.Getopt g)
Description copied from class: Options
Handles the option identified by the given code, perhaps using g to process any arguments to the option. This method is typically overridden in subclasses to process additional arguments with the subclass defering to the superclass if code is unknown.

Overrides:
processOption in class JavadocOptions

setOption

public boolean setOption(String name,
                         Object newValue)
Specified by:
setOption in interface JavadocOptionsInterface
Overrides:
setOption in class JavadocOptions

getOptions

public HashMap getOptions()
Overrides:
getOptions in class JavadocOptions

getLongname

public LinkedHashSet getLongname()
Description copied from class: Options
Returns the longname

Overrides:
getLongname in class JavadocOptions

getType

public Hashtable getType()
Description copied from class: Options
Returns the type

Overrides:
getType in class JavadocOptions

getDefaultValue

public Hashtable getDefaultValue()
Description copied from class: Options
Returns the default value

Overrides:
getDefaultValue in class JavadocOptions

getCurrentValue

public Hashtable getCurrentValue()
Description copied from class: Options
Returns the current value

Overrides:
getCurrentValue in class JavadocOptions

getTableHeader

public Hashtable getTableHeader()
Description copied from class: Options
Returns the header for a table

Overrides:
getTableHeader in class JavadocOptions

getSelectionList

public Hashtable getSelectionList()
Description copied from class: Options
Returns the list of selections for an option

Overrides:
getSelectionList in class JavadocOptions

getHelpString

public Hashtable getHelpString()
Description copied from class: Options
Returns the help messages

Overrides:
getHelpString in class JavadocOptions

getGuiType

public Hashtable getGuiType()
Description copied from class: Options
Returns the GUI categories that this option is in

Overrides:
getGuiType in class JavadocOptions

getShortOptions

public String getShortOptions()
Description copied from class: Options
Gets short options

Overrides:
getShortOptions in class JavadocOptions

usage

public void usage()
Description copied from class: Options
shows a help message

Overrides:
usage in class JavadocOptions

help

public void help()
Description copied from class: Options
shows an usage message

Overrides:
help in class JavadocOptions

getLongOptions

public gnu.getopt.LongOpt[] getLongOptions()
Description copied from class: Options
Gets long options

Overrides:
getLongOptions in class JavadocOptions

JML

JML is Copyright (C) 1998-2002 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the MultiJava project and is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.