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

java.lang.Object
  com.sun.tools.doclets.formats.html.AbstractMemberWriter
      com.sun.tools.doclets.formats.html.FieldWriterImpl
          com.sun.tools.doclets.formats.html.HtmlSerialFieldWriter

All Implemented Interfaces:

FieldWriter, MemberSummaryWriter, SerializedFormWriter.SerialFieldWriter

public class HtmlSerialFieldWriter
extends FieldWriterImpl
implements SerializedFormWriter.SerialFieldWriter

Generate serialized form for serializable fields. Documentation denoted by the tags serial and serialField is processed.

Field Summary

(package private) ProgramElementDoc[]	members
private boolean	printedFirstMember
private boolean	printedOverallAnchor

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

classdoc, nodepr, writer

Constructor Summary

HtmlSerialFieldWriter(SubWriterHolderWriter writer, ClassDoc classdoc)

Method Summary

java.util.List<FieldDoc>	members(ClassDoc cd)
protected void	printTypeLinkNoDimension(Type type)
void	writeHeader(java.lang.String heading) Write the given heading.
void	writeMemberDeprecatedInfo(FieldDoc field) Write the deprecated information for this member.
void	writeMemberDescription(FieldDoc field) Write the description text for this member.
void	writeMemberDescription(SerialFieldTag serialFieldTag) Write the description text for this member represented by the tag.
void	writeMemberFooter(FieldDoc member) Write the footer.
void	writeMemberHeader(ClassDoc fieldType, java.lang.String fieldTypeStr, java.lang.String fieldDimensions, java.lang.String fieldName) Write the member header.
void	writeMemberTags(FieldDoc field) Write the tag information for this member.

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

close, getMemberKind, printInheritedSummaryAnchor, printInheritedSummaryLabel, printNavDetailLink, printNavSummaryLink, printSummaryAnchor, printSummaryLabel, printSummaryType, writeComments, writeDeprecated, writeDeprecatedLink, writeFieldFooter, writeFieldHeader, writeFooter, writeHeader, writeInheritedMemberSummary, writeInheritedMemberSummaryFooter, writeInheritedMemberSummaryHeader, writeInheritedSummaryLink, writeMemberSummaryFooter, writeMemberSummaryHeader, writeSignature, writeSummaryLink, writeTags

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

members

ProgramElementDoc[] members

printedOverallAnchor

private boolean printedOverallAnchor

printedFirstMember

private boolean printedFirstMember

Constructor Detail

HtmlSerialFieldWriter

public HtmlSerialFieldWriter(SubWriterHolderWriter writer,
                             ClassDoc classdoc)

Method Detail

members

public java.util.List<FieldDoc> members(ClassDoc cd)

printTypeLinkNoDimension

protected void printTypeLinkNoDimension(Type type)

writeHeader

public void writeHeader(java.lang.String heading)

Description copied from interface: SerializedFormWriter.SerialFieldWriter

Write the given heading.

Specified by:

writeHeader in interface SerializedFormWriter.SerialFieldWriter

Parameters:

heading - the heading to write.

writeMemberHeader

public void writeMemberHeader(ClassDoc fieldType,
                              java.lang.String fieldTypeStr,
                              java.lang.String fieldDimensions,
                              java.lang.String fieldName)

Description copied from interface: SerializedFormWriter.SerialFieldWriter

Write the member header.

Specified by:

writeMemberHeader in interface SerializedFormWriter.SerialFieldWriter

Parameters:

fieldType - the type of the field.

fieldTypeStr - the type of the field in string format. We will print this out if we can't link to the type.

fieldDimensions - the dimensions of the field.

fieldName - the name of the field.

writeMemberDeprecatedInfo

public void writeMemberDeprecatedInfo(FieldDoc field)

Write the deprecated information for this member.

Specified by:

writeMemberDeprecatedInfo in interface SerializedFormWriter.SerialFieldWriter

Parameters:

field - the field to document.

writeMemberDescription

public void writeMemberDescription(FieldDoc field)

Write the description text for this member.

Specified by:

writeMemberDescription in interface SerializedFormWriter.SerialFieldWriter

Parameters:

field - the field to document.

writeMemberDescription

public void writeMemberDescription(SerialFieldTag serialFieldTag)

Write the description text for this member represented by the tag.

Specified by:

writeMemberDescription in interface SerializedFormWriter.SerialFieldWriter

Parameters:

serialFieldTag - the field to document (represented by tag).

writeMemberTags

public void writeMemberTags(FieldDoc field)

Write the tag information for this member.

Specified by:

writeMemberTags in interface SerializedFormWriter.SerialFieldWriter

Parameters:

field - the field to document.

writeMemberFooter

public void writeMemberFooter(FieldDoc member)

Description copied from interface: SerializedFormWriter.SerialFieldWriter

Write the footer.

Specified by:

writeMemberFooter in interface SerializedFormWriter.SerialFieldWriter

Parameters:

member - the member to write the header for.