com.sun.tools.doclets.formats.html
Class HtmlSerialMethodWriter

java.lang.Object
  com.sun.tools.doclets.formats.html.AbstractMemberWriter
      com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter
          com.sun.tools.doclets.formats.html.MethodWriterImpl
              com.sun.tools.doclets.formats.html.HtmlSerialMethodWriter

All Implemented Interfaces:

MemberSummaryWriter, MethodWriter, SerializedFormWriter.SerialMethodWriter

public class HtmlSerialMethodWriter
extends MethodWriterImpl
implements SerializedFormWriter.SerialMethodWriter

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

Field Summary

private boolean

printedFirstMember

Fields inherited from class com.sun.tools.doclets.formats.html.AbstractMemberWriter

classdoc, nodepr, writer

Constructor Summary

HtmlSerialMethodWriter(SubWriterHolderWriter writer, ClassDoc classdoc)

Method Summary

protected void	printTypeLinkNoDimension(Type type)
void	writeDeprecatedMemberInfo(MethodDoc member) Write the deprecated information for this member.
void	writeHeader(java.lang.String heading) Write the given heading.
void	writeMemberDescription(MethodDoc member) Write the description for this member.
void	writeMemberFooter(MethodDoc member) Write the footer.
void	writeMemberHeader(MethodDoc member) Write the header.
void	writeMemberTags(MethodDoc member) Write the tag information for this member.
void	writeNoCustomizationMsg(java.lang.String msg) Write a warning that no serializable methods exist.

Methods inherited from class com.sun.tools.doclets.formats.html.MethodWriterImpl

close, getMemberKind, parseCodeTag, printImplementsInfo, printInheritedSummaryAnchor, printInheritedSummaryLabel, printNavDetailLink, printNavSummaryLink, printOverridden, printReturnType, printSummaryAnchor, printSummaryLabel, printSummaryType, writeComments, writeDeprecated, writeFooter, writeHeader, writeInheritedMemberSummary, writeInheritedMemberSummaryFooter, writeInheritedMemberSummaryHeader, writeMemberSummaryFooter, writeMemberSummaryHeader, writeMethodFooter, writeMethodHeader, writeSignature, writeTags

Methods inherited from class com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter

getErasureAnchor, getReturnTypeLength, implementsMethodInIntfac, writeDeprecatedLink, writeExceptions, writeInheritedSummaryLink, writeParam, writeParameters, writeParameters, writeSignature, writeSummaryLink, writeTypeParameters

Methods inherited from class com.sun.tools.doclets.formats.html.AbstractMemberWriter

configuration, eligibleMembers, isInherited, makeSpace, modifierString, name, navDetailLink, navSummaryLink, print, print, printComment, printCommentAndTags, printDeprecatedAPI, printFullComment, printHead, printInheritedSummaryFooter, printInheritedSummaryHeader, printModifierAndType, printModifiers, printStaticAndType, printSummaryFooter, printSummaryHeader, printUseInfo, serialWarning, strong, typeString, writeMemberSummary, writeSummaryLink

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.tools.doclets.internal.toolkit.MemberSummaryWriter

writeMemberSummary

Field Detail

printedFirstMember

private boolean printedFirstMember

Constructor Detail

HtmlSerialMethodWriter

public HtmlSerialMethodWriter(SubWriterHolderWriter writer,
                              ClassDoc classdoc)

Method Detail

writeHeader

public void writeHeader(java.lang.String heading)

Description copied from interface: SerializedFormWriter.SerialMethodWriter

Write the given heading.

Specified by:

writeHeader in interface SerializedFormWriter.SerialMethodWriter

Parameters:

heading - the heading to write.

writeNoCustomizationMsg

public void writeNoCustomizationMsg(java.lang.String msg)

Description copied from interface: SerializedFormWriter.SerialMethodWriter

Write a warning that no serializable methods exist.

Specified by:

writeNoCustomizationMsg in interface SerializedFormWriter.SerialMethodWriter

Parameters:

msg - the warning to print.

writeMemberHeader

public void writeMemberHeader(MethodDoc member)

Description copied from interface: SerializedFormWriter.SerialMethodWriter

Write the header.

Specified by:

writeMemberHeader in interface SerializedFormWriter.SerialMethodWriter

Parameters:

member - the member to write the header for.

writeMemberFooter

public void writeMemberFooter(MethodDoc member)

Description copied from interface: SerializedFormWriter.SerialMethodWriter

Write the footer.

Specified by:

writeMemberFooter in interface SerializedFormWriter.SerialMethodWriter

Parameters:

member - the member to write the header for.

writeDeprecatedMemberInfo

public void writeDeprecatedMemberInfo(MethodDoc member)

Description copied from interface: SerializedFormWriter.SerialMethodWriter

Write the deprecated information for this member.

Specified by:

writeDeprecatedMemberInfo in interface SerializedFormWriter.SerialMethodWriter

writeMemberDescription

public void writeMemberDescription(MethodDoc member)

Description copied from interface: SerializedFormWriter.SerialMethodWriter

Write the description for this member.

Specified by:

writeMemberDescription in interface SerializedFormWriter.SerialMethodWriter

writeMemberTags

public void writeMemberTags(MethodDoc member)

Description copied from interface: SerializedFormWriter.SerialMethodWriter

Write the tag information for this member.

Specified by:

writeMemberTags in interface SerializedFormWriter.SerialMethodWriter

printTypeLinkNoDimension

protected void printTypeLinkNoDimension(Type type)