JML

org.jmlspecs.jmldoc
Class JavadocOptions

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
All Implemented Interfaces:
JavadocOptionsInterface
Direct Known Subclasses:
JmldocOptions

public class JavadocOptions
extends JmlCommonOptions
implements JavadocOptionsInterface

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


Field Summary
private  boolean author
           
private  String bootclasspath
           
private  String bottom
           
private  String charset
           
private  String docencoding
           
private  boolean docfilessubdirs
           
private  String doclet
           
private  String docletpath
           
private  String doctitle
           
private  String encoding
           
private  String exclude
           
private  String excludedocfilessubdir
           
private  String extdirs
           
private  String footer
           
private  String[][] group
           
private  String header
           
private  String helpfile
           
private  String J
           
private  String[][] link
           
private  String[][] linkoffline
           
private  boolean linksource
           
private  String locale
           
private static gnu.getopt.LongOpt[] LONGOPTS
           
private  boolean nocomment
           
private  boolean nodeprecated
           
private  boolean nodeprecatedlist
           
private  boolean nohelp
           
private  boolean noindex
           
private  boolean nonavbar
           
private  boolean nooverview
           
private  String noqualifier
           
private  boolean nosince
           
private  boolean notree
           
private  String overview
           
private  int privacy
           
private  boolean serialwarn
           
private  boolean splitindex
           
private  String stylesheetfile
           
private  String subpackages
           
private  String[][] tag
           
private  String taglet
           
private  String tagletpath
           
private  boolean use
           
private  boolean Version
           
private  String windowtitle
           
private  boolean x
           
private  boolean xnodate
           
 
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
JavadocOptions()
           
JavadocOptions(String name)
           
 
Method Summary
 boolean author()
           
 String bootclasspath()
           
 String bottom()
           
 String charset()
           
 String docencoding()
           
 boolean docfilessubdirs()
           
 String doclet()
           
 String docletpath()
           
 String doctitle()
           
 String encoding()
           
 String exclude()
           
 String excludedocfilessubdir()
           
 String extdirs()
           
 String footer()
           
 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
 String[][] group()
           
 String header()
           
 void help()
           
 String helpfile()
           
 String J()
           
 String[][] link()
           
 String[][] linkoffline()
           
 boolean linksource()
           
 String locale()
           
 boolean nocomment()
           
 boolean nodeprecated()
           
 boolean nodeprecatedlist()
           
 boolean nohelp()
           
 boolean noindex()
           
 boolean nonavbar()
           
 boolean nooverview()
           
 String noqualifier()
           
 boolean nosince()
           
 boolean notree()
           
 String overview()
           
 int privacy()
           
 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.
 boolean serialwarn()
           
 boolean set_author(boolean author)
           
 String set_bootclasspath(String bootclasspath)
           
 String set_bottom(String bottom)
           
 String set_charset(String charset)
           
 String set_docencoding(String docencoding)
           
 boolean set_docfilessubdirs(boolean docfilessubdirs)
           
 String set_doclet(String doclet)
           
 String set_docletpath(String docletpath)
           
 String set_doctitle(String doctitle)
           
 String set_encoding(String encoding)
           
 String set_exclude(String exclude)
           
 String set_excludedocfilessubdir(String excludedocfilessubdir)
           
 String set_extdirs(String extdirs)
           
 String set_footer(String footer)
           
 String[][] set_group(String[][] group)
           
 String set_header(String header)
           
 String set_helpfile(String helpfile)
           
 String set_J(String J)
           
 String[][] set_link(String[][] link)
           
 String[][] set_linkoffline(String[][] linkoffline)
           
 boolean set_linksource(boolean linksource)
           
 String set_locale(String locale)
           
 boolean set_nocomment(boolean nocomment)
           
 boolean set_nodeprecated(boolean nodeprecated)
           
 boolean set_nodeprecatedlist(boolean nodeprecatedlist)
           
 boolean set_nohelp(boolean nohelp)
           
 boolean set_noindex(boolean noindex)
           
 boolean set_nonavbar(boolean nonavbar)
           
 boolean set_nooverview(boolean nooverview)
           
 String set_noqualifier(String noqualifier)
           
 boolean set_nosince(boolean nosince)
           
 boolean set_notree(boolean notree)
           
 String set_overview(String overview)
           
 int set_privacy(int privacy)
           
 boolean set_serialwarn(boolean serialwarn)
           
 boolean set_splitindex(boolean splitindex)
           
 String set_stylesheetfile(String stylesheetfile)
           
 String set_subpackages(String subpackages)
           
 String[][] set_tag(String[][] tag)
           
 String set_taglet(String taglet)
           
 String set_tagletpath(String tagletpath)
           
 boolean set_use(boolean use)
           
 boolean set_Version(boolean Version)
           
 String set_windowtitle(String windowtitle)
           
 boolean set_x(boolean x)
           
 boolean set_xnodate(boolean xnodate)
           
 boolean setOption(String name, Object newValue)
           
 boolean splitindex()
           
 String stylesheetfile()
           
 String subpackages()
           
 String[][] tag()
           
 String taglet()
           
 String tagletpath()
           
 void usage()
           
 boolean use()
           
 boolean Version()
           
 String windowtitle()
           
 boolean x()
           
 boolean 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

author

private boolean author

bootclasspath

private String bootclasspath

bottom

private String bottom

charset

private String charset

docfilessubdirs

private boolean docfilessubdirs

docencoding

private String docencoding

doclet

private String doclet

docletpath

private String docletpath

doctitle

private String doctitle

encoding

private String encoding

exclude

private String exclude

excludedocfilessubdir

private String excludedocfilessubdir

extdirs

private String extdirs

footer

private String footer

group

private String[][] group

header

private String header

helpfile

private String helpfile

J

private String J

link

private String[][] link

linkoffline

private String[][] linkoffline

linksource

private boolean linksource

locale

private String locale

nocomment

private boolean nocomment

nodeprecated

private boolean nodeprecated

nodeprecatedlist

private boolean nodeprecatedlist

nohelp

private boolean nohelp

noindex

private boolean noindex

nonavbar

private boolean nonavbar

nooverview

private boolean nooverview

noqualifier

private String noqualifier

nosince

private boolean nosince

notree

private boolean notree

overview

private String overview

privacy

private int privacy

serialwarn

private boolean serialwarn

splitindex

private boolean splitindex

stylesheetfile

private String stylesheetfile

subpackages

private String subpackages

tag

private String[][] tag

taglet

private String taglet

tagletpath

private String tagletpath

use

private boolean use

Version

private boolean Version

windowtitle

private String windowtitle

x

private boolean x

xnodate

private boolean xnodate

LONGOPTS

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

JavadocOptions

public JavadocOptions(String name)

JavadocOptions

public JavadocOptions()
Method Detail

author

public boolean author()
Specified by:
author in interface JavadocOptionsInterface

set_author

public boolean set_author(boolean author)

bootclasspath

public String bootclasspath()
Specified by:
bootclasspath in interface JavadocOptionsInterface

set_bootclasspath

public String set_bootclasspath(String bootclasspath)

bottom

public String bottom()
Specified by:
bottom in interface JavadocOptionsInterface

set_bottom

public String set_bottom(String bottom)

charset

public String charset()
Specified by:
charset in interface JavadocOptionsInterface

set_charset

public String set_charset(String charset)

docfilessubdirs

public boolean docfilessubdirs()
Specified by:
docfilessubdirs in interface JavadocOptionsInterface

set_docfilessubdirs

public boolean set_docfilessubdirs(boolean docfilessubdirs)

docencoding

public String docencoding()
Specified by:
docencoding in interface JavadocOptionsInterface

set_docencoding

public String set_docencoding(String docencoding)

doclet

public String doclet()
Specified by:
doclet in interface JavadocOptionsInterface

set_doclet

public String set_doclet(String doclet)

docletpath

public String docletpath()
Specified by:
docletpath in interface JavadocOptionsInterface

set_docletpath

public String set_docletpath(String docletpath)

doctitle

public String doctitle()
Specified by:
doctitle in interface JavadocOptionsInterface

set_doctitle

public String set_doctitle(String doctitle)

encoding

public String encoding()
Specified by:
encoding in interface JavadocOptionsInterface

set_encoding

public String set_encoding(String encoding)

exclude

public String exclude()
Specified by:
exclude in interface JavadocOptionsInterface

set_exclude

public String set_exclude(String exclude)

excludedocfilessubdir

public String excludedocfilessubdir()
Specified by:
excludedocfilessubdir in interface JavadocOptionsInterface

set_excludedocfilessubdir

public String set_excludedocfilessubdir(String excludedocfilessubdir)

extdirs

public String extdirs()
Specified by:
extdirs in interface JavadocOptionsInterface

set_extdirs

public String set_extdirs(String extdirs)

footer

public String footer()
Specified by:
footer in interface JavadocOptionsInterface

set_footer

public String set_footer(String footer)

group

public String[][] group()
Specified by:
group in interface JavadocOptionsInterface

set_group

public String[][] set_group(String[][] group)

header

public String header()
Specified by:
header in interface JavadocOptionsInterface

set_header

public String set_header(String header)

helpfile

public String helpfile()
Specified by:
helpfile in interface JavadocOptionsInterface

set_helpfile

public String set_helpfile(String helpfile)

J

public String J()
Specified by:
J in interface JavadocOptionsInterface

set_J

public String set_J(String J)

link

public String[][] link()
Specified by:
link in interface JavadocOptionsInterface

set_link

public String[][] set_link(String[][] link)

linkoffline

public String[][] linkoffline()
Specified by:
linkoffline in interface JavadocOptionsInterface

set_linkoffline

public String[][] set_linkoffline(String[][] linkoffline)

linksource

public boolean linksource()
Specified by:
linksource in interface JavadocOptionsInterface

set_linksource

public boolean set_linksource(boolean linksource)

locale

public String locale()
Specified by:
locale in interface JavadocOptionsInterface

set_locale

public String set_locale(String locale)

nocomment

public boolean nocomment()
Specified by:
nocomment in interface JavadocOptionsInterface

set_nocomment

public boolean set_nocomment(boolean nocomment)

nodeprecated

public boolean nodeprecated()
Specified by:
nodeprecated in interface JavadocOptionsInterface

set_nodeprecated

public boolean set_nodeprecated(boolean nodeprecated)

nodeprecatedlist

public boolean nodeprecatedlist()
Specified by:
nodeprecatedlist in interface JavadocOptionsInterface

set_nodeprecatedlist

public boolean set_nodeprecatedlist(boolean nodeprecatedlist)

nohelp

public boolean nohelp()
Specified by:
nohelp in interface JavadocOptionsInterface

set_nohelp

public boolean set_nohelp(boolean nohelp)

noindex

public boolean noindex()
Specified by:
noindex in interface JavadocOptionsInterface

set_noindex

public boolean set_noindex(boolean noindex)

nonavbar

public boolean nonavbar()
Specified by:
nonavbar in interface JavadocOptionsInterface

set_nonavbar

public boolean set_nonavbar(boolean nonavbar)

nooverview

public boolean nooverview()
Specified by:
nooverview in interface JavadocOptionsInterface

set_nooverview

public boolean set_nooverview(boolean nooverview)

noqualifier

public String noqualifier()
Specified by:
noqualifier in interface JavadocOptionsInterface

set_noqualifier

public String set_noqualifier(String noqualifier)

nosince

public boolean nosince()
Specified by:
nosince in interface JavadocOptionsInterface

set_nosince

public boolean set_nosince(boolean nosince)

notree

public boolean notree()
Specified by:
notree in interface JavadocOptionsInterface

set_notree

public boolean set_notree(boolean notree)

overview

public String overview()
Specified by:
overview in interface JavadocOptionsInterface

set_overview

public String set_overview(String overview)

privacy

public int privacy()
Specified by:
privacy in interface JavadocOptionsInterface

set_privacy

public int set_privacy(int privacy)

serialwarn

public boolean serialwarn()
Specified by:
serialwarn in interface JavadocOptionsInterface

set_serialwarn

public boolean set_serialwarn(boolean serialwarn)

splitindex

public boolean splitindex()
Specified by:
splitindex in interface JavadocOptionsInterface

set_splitindex

public boolean set_splitindex(boolean splitindex)

stylesheetfile

public String stylesheetfile()
Specified by:
stylesheetfile in interface JavadocOptionsInterface

set_stylesheetfile

public String set_stylesheetfile(String stylesheetfile)

subpackages

public String subpackages()
Specified by:
subpackages in interface JavadocOptionsInterface

set_subpackages

public String set_subpackages(String subpackages)

tag

public String[][] tag()
Specified by:
tag in interface JavadocOptionsInterface

set_tag

public String[][] set_tag(String[][] tag)

taglet

public String taglet()
Specified by:
taglet in interface JavadocOptionsInterface

set_taglet

public String set_taglet(String taglet)

tagletpath

public String tagletpath()
Specified by:
tagletpath in interface JavadocOptionsInterface

set_tagletpath

public String set_tagletpath(String tagletpath)

use

public boolean use()
Specified by:
use in interface JavadocOptionsInterface

set_use

public boolean set_use(boolean use)

Version

public boolean Version()
Specified by:
Version in interface JavadocOptionsInterface

set_Version

public boolean set_Version(boolean Version)

windowtitle

public String windowtitle()
Specified by:
windowtitle in interface JavadocOptionsInterface

set_windowtitle

public String set_windowtitle(String windowtitle)

x

public boolean x()
Specified by:
x in interface JavadocOptionsInterface

set_x

public boolean set_x(boolean x)

xnodate

public boolean xnodate()
Specified by:
xnodate in interface JavadocOptionsInterface

set_xnodate

public boolean set_xnodate(boolean xnodate)

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 JmlCommonOptions

setOption

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

getOptions

public HashMap getOptions()
Overrides:
getOptions in class JmlCommonOptions

getLongname

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

Overrides:
getLongname in class JmlCommonOptions

getType

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

Overrides:
getType in class JmlCommonOptions

getDefaultValue

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

Overrides:
getDefaultValue in class JmlCommonOptions

getCurrentValue

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

Overrides:
getCurrentValue in class JmlCommonOptions

getTableHeader

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

Overrides:
getTableHeader in class JmlCommonOptions

getSelectionList

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

Overrides:
getSelectionList in class JmlCommonOptions

getHelpString

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

Overrides:
getHelpString in class JmlCommonOptions

getGuiType

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

Overrides:
getGuiType in class JmlCommonOptions

getShortOptions

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

Overrides:
getShortOptions in class JmlCommonOptions

usage

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

Overrides:
usage in class JmlCommonOptions

help

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

Overrides:
help in class JmlCommonOptions

getLongOptions

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

Overrides:
getLongOptions in class JmlCommonOptions

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.