JML

org.jmlspecs.jmldoc.jmldoc_142
Class JmldocFieldSubWriter

java.lang.Object
  extended bycom.sun.tools.doclets.standard.AbstractSubWriter
      extended bycom.sun.tools.doclets.standard.FieldSubWriter
          extended byorg.multijava.mjdoc.mjdoc_142.MjdocFieldSubWriter
              extended byorg.jmlspecs.jmldoc.jmldoc_142.JmldocFieldSubWriter

public class JmldocFieldSubWriter
extends org.multijava.mjdoc.mjdoc_142.MjdocFieldSubWriter

Author:
David R. Cok

Field Summary
protected  JmlHTML jmlwriter
           
protected  long modFields
           
 
Fields inherited from class com.sun.tools.doclets.standard.AbstractSubWriter
classdoc, nodepr, printedSummaryHeader, visibleClasses, visibleMemberMap, writer
 
Constructor Summary
JmldocFieldSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer)
           
JmldocFieldSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc, long modFields)
           
 
Method Summary
 String getLink(CClass container, CField fd, String label)
           
protected  boolean isInherited(com.sun.javadoc.ProgramElementDoc ped)
           
protected  void printFullComment(com.sun.javadoc.ProgramElementDoc emd)
          Overridden in order to insert any JML specification.
protected  void printHeader(com.sun.javadoc.ClassDoc cd)
           
 void printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc cd)
           
 void printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)
           
protected  void printModifier(com.sun.javadoc.ProgramElementDoc member)
          This is overridden in order to insert spec_public and spec_protected as appropriate in the list of modifiers for fields.
protected  void printSpecification(com.sun.javadoc.ProgramElementDoc emd)
           
 void printSummaryAnchor(com.sun.javadoc.ClassDoc cd)
           
 void printSummaryLabel(com.sun.javadoc.ClassDoc cd)
           
 
Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjdocFieldSubWriter
printTags, printTypeLinkNoDimension
 
Methods inherited from class com.sun.tools.doclets.standard.FieldSubWriter
getMemberKind, printBodyHtmlEnd, printDeprecatedLink, printInheritedSummaryLink, printMember, printNavDetailLink, printNavSummaryLink, printSummaryLink, printSummaryType
 
Methods inherited from class com.sun.tools.doclets.standard.AbstractSubWriter
bold, buildVisibleMemberMap, configuration, eligibleMembers, makeSpace, members, modifierString, msg, name, navDetailLink, navSummaryLink, print, print, printComment, printCommentAndTags, printDeprecated, printDeprecatedAPI, printDeprecatedClassComment, printHead, printInheritedMembersSummary, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMembers, printMembersSummary, printModifierAndType, printModifiers, printStaticAndType, printSummaryFooter, printSummaryHeader, printSummaryMember, printTypedName, printTypeLink, printUseInfo, serialWarning, typeString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

jmlwriter

protected JmlHTML jmlwriter

modFields

protected long modFields
Constructor Detail

JmldocFieldSubWriter

public JmldocFieldSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer,
                            com.sun.javadoc.ClassDoc classdoc,
                            long modFields)

JmldocFieldSubWriter

public JmldocFieldSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer)
Method Detail

printFullComment

protected void printFullComment(com.sun.javadoc.ProgramElementDoc emd)
Overridden in order to insert any JML specification.

Overrides:
printFullComment in class com.sun.tools.doclets.standard.AbstractSubWriter

printSpecification

protected void printSpecification(com.sun.javadoc.ProgramElementDoc emd)

getLink

public String getLink(CClass container,
                      CField fd,
                      String label)

printSummaryLabel

public void printSummaryLabel(com.sun.javadoc.ClassDoc cd)
Overrides:
printSummaryLabel in class com.sun.tools.doclets.standard.FieldSubWriter

printSummaryAnchor

public void printSummaryAnchor(com.sun.javadoc.ClassDoc cd)
Overrides:
printSummaryAnchor in class com.sun.tools.doclets.standard.FieldSubWriter

printInheritedSummaryAnchor

public void printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc cd)
Overrides:
printInheritedSummaryAnchor in class com.sun.tools.doclets.standard.FieldSubWriter

printInheritedSummaryLabel

public void printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)
Overrides:
printInheritedSummaryLabel in class com.sun.tools.doclets.standard.FieldSubWriter

printHeader

protected void printHeader(com.sun.javadoc.ClassDoc cd)
Overrides:
printHeader in class com.sun.tools.doclets.standard.FieldSubWriter

isInherited

protected boolean isInherited(com.sun.javadoc.ProgramElementDoc ped)
Overrides:
isInherited in class com.sun.tools.doclets.standard.AbstractSubWriter

printModifier

protected void printModifier(com.sun.javadoc.ProgramElementDoc member)
This is overridden in order to insert spec_public and spec_protected as appropriate in the list of modifiers for fields.

Overrides:
printModifier in class com.sun.tools.doclets.standard.AbstractSubWriter

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.