JML

org.jmlspecs.jmldoc.jmldoc_142
Class JmldocClassWriter

java.lang.Object
  extended byjava.io.Writer
      extended byjava.io.PrintWriter
          extended bycom.sun.tools.doclets.HtmlWriter
              extended bycom.sun.tools.doclets.HtmlDocWriter
                  extended bycom.sun.tools.doclets.standard.HtmlStandardWriter
                      extended bycom.sun.tools.doclets.standard.SubWriterHolderWriter
                          extended bycom.sun.tools.doclets.standard.ClassWriter
                              extended byorg.multijava.mjdoc.mjdoc_142.MjdocClassWriter
                                  extended byorg.jmlspecs.jmldoc.jmldoc_142.JmldocClassWriter
All Implemented Interfaces:
Appendable, Closeable, Flushable

public class JmldocClassWriter
extends org.multijava.mjdoc.mjdoc_142.MjdocClassWriter

A derivative of a class in the javadoc doclet API, so as to be able to instantiate a MjdocClassWriter instead of a ClassWriter and a MjdocMethodSubWriter instead of a MethodSubWriter.

Author:
David R. Cok

Nested Class Summary
static class JmldocClassWriter.JmlMemberFilter
           
 
Field Summary
protected  JmldocFieldSubWriter ghostfieldSubWriter
           
private  JmlHTML jmlwriter
           
protected  JmldocConstructorSubWriter modelConstructorSubWriter
           
protected  JmldocFieldSubWriter modelfieldSubWriter
           
protected  JmldocMethodSubWriter modelMethodSubWriter
           
protected  JmldocClassSubWriter modelNestedSubWriter
           
 
Fields inherited from class com.sun.tools.doclets.standard.ClassWriter
classdoc, classtree, constrSubWriter, containingPackagesSeen, fieldSubWriter, methodSubWriter, nestedSubWriter, next, prev
 
Fields inherited from class com.sun.tools.doclets.standard.HtmlStandardWriter
backpath, configuration, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, relativepathNoSlash
 
Fields inherited from class com.sun.tools.doclets.HtmlWriter
fileseparator, htmlFilename, winTitle
 
Fields inherited from class java.io.PrintWriter
out
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
JmldocClassWriter(com.sun.tools.doclets.standard.ConfigurationStandard configuration, String path, String filename, com.sun.javadoc.ClassDoc classdoc, com.sun.javadoc.ClassDoc prev, com.sun.javadoc.ClassDoc next, com.sun.tools.doclets.ClassTree classtree, boolean nopackage)
           
 
Method Summary
static void generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration, com.sun.javadoc.ClassDoc classdoc, com.sun.javadoc.ClassDoc prev, com.sun.javadoc.ClassDoc next, com.sun.tools.doclets.ClassTree classtree, boolean nopackage)
           
 JmlHTML jmlwriter()
           
protected  void printAllMembers()
           
protected  void printClassDescription()
          Print the class description regarding interfaces implemented, classes inherited; this is overridden just to introduce the weakly modifier
protected  void printSubClassLinkInfo(List list)
          This is overridden so that we can include the modifier weakly.
 
Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjdocClassWriter
getEMLink, getGFLink, printHeader, printHtmlHeader, printScript, printSummaryLinkComment
 
Methods inherited from class com.sun.tools.doclets.standard.ClassWriter
generate, generateClassFile, navDetailLinks, navGap, navLinkClass, navLinkClassUse, navLinkNext, navLinkPackage, navLinkPrevious, navLinkTree, navSummaryLinks, printDeprecated, printEnclosingInfo, printImplementingClasses, printInfoHeader, printStep, printSubClassInterfaceInfo, printSummaryDetailLinks, printSuperImplementedInterfacesInfo, printTreeForClass
 
Methods inherited from class com.sun.tools.doclets.standard.SubWriterHolderWriter
printCommentDef, printIndexComment, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMemberFooter, printMemberHeader, printSummaryFooter, printSummaryHeader, printSummaryLinkType, printSummaryMember, printTableHeadingBackground, printTypeSummaryFooter, printTypeSummaryHeader
 
Methods inherited from class com.sun.tools.doclets.standard.HtmlStandardWriter
boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getText, getText, getText, getText, isCoreClass, isCrossClassIncluded, isGeneratedDoc, italicsClassName, msg, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navHideLists, navLinkClassIndex, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkPackage, navLinkPrevious, navLinks, navShowLists, navShowLists, navSummary, notice, notice, pathString, pathString, pathToClass, printBoldTargetHyperLink, printBottom, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printDocLink, printDocLink, printHtmlHeader, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, replaceInheritDoc, seeTagToString, serialClassInclude, serialDocInclude, serialInclude, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, warning, warning, warning
 
Methods inherited from class com.sun.tools.doclets.HtmlDocWriter
getHyperLink, getHyperLink, getHyperLink, getHyperLink, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printFramesetHeader, printFramesetHeader, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPkgName, spaces, today
 
Methods inherited from class com.sun.tools.doclets.HtmlWriter
address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontSizeStyle, fontStyle, genWriter, getBold, getBoldEnd, getCode, getCodeEnd, getFontColor, getFontEnd, getWindowTitleOnload, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, hr, html, htmlEnd, img, italic, italicEnd, italics, italicsText, li, li, link, menu, menuEnd, noFrames, noFramesEnd, p, pEnd, pre, preEnd, printWinTitleScript, script, scriptEnd, space, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd
 
Methods inherited from class java.io.PrintWriter
append, append, append, append, append, append, append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

modelfieldSubWriter

protected JmldocFieldSubWriter modelfieldSubWriter

ghostfieldSubWriter

protected JmldocFieldSubWriter ghostfieldSubWriter

modelMethodSubWriter

protected JmldocMethodSubWriter modelMethodSubWriter

modelNestedSubWriter

protected JmldocClassSubWriter modelNestedSubWriter

modelConstructorSubWriter

protected JmldocConstructorSubWriter modelConstructorSubWriter

jmlwriter

private JmlHTML jmlwriter
Constructor Detail

JmldocClassWriter

public JmldocClassWriter(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                         String path,
                         String filename,
                         com.sun.javadoc.ClassDoc classdoc,
                         com.sun.javadoc.ClassDoc prev,
                         com.sun.javadoc.ClassDoc next,
                         com.sun.tools.doclets.ClassTree classtree,
                         boolean nopackage)
                  throws IOException,
                         com.sun.tools.doclets.DocletAbortException
Throws:
IOException
com.sun.tools.doclets.DocletAbortException
Method Detail

generate

public static void generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                            com.sun.javadoc.ClassDoc classdoc,
                            com.sun.javadoc.ClassDoc prev,
                            com.sun.javadoc.ClassDoc next,
                            com.sun.tools.doclets.ClassTree classtree,
                            boolean nopackage)

jmlwriter

public JmlHTML jmlwriter()

printAllMembers

protected void printAllMembers()
Overrides:
printAllMembers in class com.sun.tools.doclets.standard.ClassWriter

printSubClassLinkInfo

protected void printSubClassLinkInfo(List list)
This is overridden so that we can include the modifier weakly.

Overrides:
printSubClassLinkInfo in class com.sun.tools.doclets.standard.ClassWriter

printClassDescription

protected void printClassDescription()
Print the class description regarding interfaces implemented, classes inherited; this is overridden just to introduce the weakly modifier

Overrides:
printClassDescription in class com.sun.tools.doclets.standard.ClassWriter

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.