org.freehep.tools.doclet
Class SerialMethodSubWriter

java.lang.Object
  org.freehep.tools.doclet.AbstractSubWriter
      org.freehep.tools.doclet.ExecutableMemberSubWriter
          org.freehep.tools.doclet.MethodSubWriter
              org.freehep.tools.doclet.SerialMethodSubWriter

public class SerialMethodSubWriter

extends MethodSubWriter

Generate serialized form for Serializable/Externalizable methods. Documentation denoted by the serialData tag is processed.

Author:

Joe Fialli

Source Code:

SerialMethodSubWriter.java

Field Summary

Fields inherited from class org.freehep.tools.doclet.AbstractSubWriter

classdoc, nodepr, printedSummaryHeader, visibleClasses, visibleMemberMap, writer

Constructor Summary

SerialMethodSubWriter(SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc, ConfigurationStandard configuration)

Method Summary

void	buildVisibleMemberMap()
List	members(com.sun.javadoc.ClassDoc cd)
protected void	printHeader(com.sun.javadoc.ClassDoc cd)
protected void	printMember(com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)
void	printMembers() Print header even if there are no serializable methods.
protected void	printSerialDataTag(com.sun.javadoc.Doc doc, com.sun.javadoc.Tag[] serialData)
protected void	printTags(com.sun.javadoc.ProgramElementDoc member) Print comments, See tags and serialData for SerialMethods.
protected void	printTypeLinkNoDimension(com.sun.javadoc.Type type)

Methods inherited from class org.freehep.tools.doclet.MethodSubWriter

getMemberKind, implementedMethod, parseCodeTag, printComment, printCommentFromCommentedMethod, printImplementsInfo, printInheritedSummaryAnchor, printInheritedSummaryLabel, printMembersSummary, printNavDetailLink, printNavSummaryLink, printOverridden, printReturnType, printSignature, printSummaryAnchor, printSummaryLabel, printSummaryType, printTagsInfoFooter, printTagsInfoHeader

Methods inherited from class org.freehep.tools.doclet.ExecutableMemberSubWriter

getReturnTypeLength, implementsMethodInIntfac, name, printBodyHtmlEnd, printDeprecatedLink, printExceptions, printInheritedSummaryLink, printMember, printParam, printParameters, printSummaryLink

Methods inherited from class org.freehep.tools.doclet.AbstractSubWriter

bold, configuration, eligibleMembers, isInherited, makeSpace, modifierString, msg, navDetailLink, navSummaryLink, print, print, printCommentAndTags, printDeprecated, printDeprecatedAPI, printDeprecatedClassComment, printFullComment, printHead, printInheritedMembersSummary, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printModifier, 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

Constructor Detail

SerialMethodSubWriter

public SerialMethodSubWriter(SubWriterHolderWriter writer,
                             com.sun.javadoc.ClassDoc classdoc,
                             ConfigurationStandard configuration)

Method Detail

members

public List members(com.sun.javadoc.ClassDoc cd)

Overrides:

members in class AbstractSubWriter

printHeader

protected void printHeader(com.sun.javadoc.ClassDoc cd)

Overrides:

printHeader in class MethodSubWriter

printMember

protected void printMember(com.sun.javadoc.ClassDoc cd,
                           com.sun.javadoc.ProgramElementDoc member)

printSerialDataTag

protected void printSerialDataTag(com.sun.javadoc.Doc doc,
                                  com.sun.javadoc.Tag[] serialData)

printTags

protected void printTags(com.sun.javadoc.ProgramElementDoc member)

Print comments, See tags and serialData for SerialMethods.

Overrides:

printTags in class MethodSubWriter

printMembers

public void printMembers()

Print header even if there are no serializable methods.

Overrides:

printMembers in class AbstractSubWriter

buildVisibleMemberMap

public void buildVisibleMemberMap()

Overrides:

buildVisibleMemberMap in class AbstractSubWriter

printTypeLinkNoDimension

protected void printTypeLinkNoDimension(com.sun.javadoc.Type type)

Overrides:

printTypeLinkNoDimension in class AbstractSubWriter