Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class HtmlSerialFieldWriter

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.FieldWriterImpl

gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlSerialFieldWriter

All Implemented Interfaces:

FieldWriter, MemberSummaryWriter, SerializedFormWriter.SerialFieldWriter

@Deprecated
public class HtmlSerialFieldWriter
extends FieldWriterImpl
implements SerializedFormWriter.SerialFieldWriter

Deprecated.

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

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Author:

Joe Fialli, Bhavesh Patel (Modified)

Field Summary

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

classdoc, configuration, methodTypes, nodepr, printedSummaryHeader, typeMap, utils, writer

Constructor Summary

Constructors

Constructor	Description
HtmlSerialFieldWriter(SubWriterHolderWriter writer, ClassDoc classdoc)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addMemberDeprecatedInfo(FieldDoc field, Content contentTree)	Deprecated. Add the deprecated information for this member.
void	addMemberDescription(FieldDoc field, Content contentTree)	Deprecated. Add the description text for this member.
void	addMemberDescription(SerialFieldTag serialFieldTag, Content contentTree)	Deprecated. Add the description text for this member represented by the tag.
void	addMemberHeader(ClassDoc fieldType, String fieldTypeStr, String fieldDimensions, String fieldName, Content contentTree)	Deprecated. Add the member header.
void	addMemberTags(FieldDoc field, Content contentTree)	Deprecated. Add the tag information for this member.
Content	getFieldsContentHeader(boolean isLastContent)	Deprecated. Return the header for serializable fields content section.
Content	getSerializableFields(String heading, Content serializableFieldsTree)	Deprecated. Add serializable fields.
Content	getSerializableFieldsHeader()	Deprecated. Return the header for serializable fields section.
List<FieldDoc>	members(ClassDoc cd)	Deprecated.
boolean	shouldPrintOverview(FieldDoc field)	Deprecated. Check to see if overview details should be printed.

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

addComments, addDeprecated, addInheritedSummaryAnchor, addInheritedSummaryLabel, addInheritedSummaryLink, addMemberTree, addNavDetailLink, addSummaryAnchor, addSummaryLabel, addSummaryLink, addSummaryType, addTags, close, getCaption, getDeprecatedLink, getFieldDetails, getFieldDetailsTreeHeader, getFieldDoc, getFieldDocTreeHeader, getMemberKind, getMemberSummaryHeader, getNavSummaryLink, getSignature, getSummaryTableHeader, getTableSummary

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

addComment, addDeprecatedAPI, addDeprecatedInfo, addInheritedMemberSummary, addMemberSummary, addModifierAndType, addModifiers, addName, addNavDetailLink, addNavSummaryLink, addSummaryLink, addUseInfo, eligibleMembers, getHead, getInheritedSummaryHeader, getInheritedSummaryLinksTree, getMemberTree, getMemberTree, getSummaryTableTree, isInherited, makeSpace, modifierString, name, serialWarning, setSummaryColumnStyle, showTabs, typeString

Methods inherited from class java.lang.Object

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

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

addInheritedMemberSummary, addMemberSummary, getInheritedSummaryHeader, getInheritedSummaryLinksTree, getMemberTree, getSummaryTableTree

Constructor Detail

HtmlSerialFieldWriter

public HtmlSerialFieldWriter(SubWriterHolderWriter writer,
                             ClassDoc classdoc)

Deprecated.

Method Detail

members

public List<FieldDoc> members(ClassDoc cd)

Deprecated.

getSerializableFieldsHeader

public Content getSerializableFieldsHeader()

Deprecated.

Return the header for serializable fields section.

Specified by:

getSerializableFieldsHeader in interface SerializedFormWriter.SerialFieldWriter

Returns:

a content tree for the header

getFieldsContentHeader

public Content getFieldsContentHeader(boolean isLastContent)

Deprecated.

Return the header for serializable fields content section.

Specified by:

getFieldsContentHeader in interface SerializedFormWriter.SerialFieldWriter

Parameters:

isLastContent - true if the cotent being documented is the last content.

Returns:

a content tree for the header

getSerializableFields

public Content getSerializableFields(String heading,
                                     Content serializableFieldsTree)

Deprecated.

Add serializable fields.

Specified by:

getSerializableFields in interface SerializedFormWriter.SerialFieldWriter

Parameters:

heading - the heading for the section

serializableFieldsTree - the tree to be added to the serializable fileds content tree

Returns:

a content tree for the serializable fields content

addMemberHeader

public void addMemberHeader(ClassDoc fieldType,
                            String fieldTypeStr,
                            String fieldDimensions,
                            String fieldName,
                            Content contentTree)

Deprecated.

Add the member header.

Specified by:

addMemberHeader in interface SerializedFormWriter.SerialFieldWriter

Parameters:

fieldType - the class document to be listed

fieldTypeStr - the string for the field type to be documented

fieldDimensions - the dimensions of the field string to be added

fieldName - name of the field to be added

contentTree - the content tree to which the member header will be added

addMemberDeprecatedInfo

public void addMemberDeprecatedInfo(FieldDoc field,
                                    Content contentTree)

Deprecated.

Add the deprecated information for this member.

Specified by:

addMemberDeprecatedInfo in interface SerializedFormWriter.SerialFieldWriter

Parameters:

field - the field to document.

contentTree - the tree to which the deprecated info will be added

addMemberDescription

public void addMemberDescription(FieldDoc field,
                                 Content contentTree)

Deprecated.

Add the description text for this member.

Specified by:

addMemberDescription in interface SerializedFormWriter.SerialFieldWriter

Parameters:

field - the field to document.

contentTree - the tree to which the deprecated info will be added

addMemberDescription

public void addMemberDescription(SerialFieldTag serialFieldTag,
                                 Content contentTree)

Deprecated.

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

Specified by:

addMemberDescription in interface SerializedFormWriter.SerialFieldWriter

Parameters:

serialFieldTag - the field to document (represented by tag)

contentTree - the tree to which the deprecated info will be added

addMemberTags

public void addMemberTags(FieldDoc field,
                          Content contentTree)

Deprecated.

Add the tag information for this member.

Specified by:

addMemberTags in interface SerializedFormWriter.SerialFieldWriter

Parameters:

field - the field to document.

contentTree - the tree to which the member tags info will be added

shouldPrintOverview

public boolean shouldPrintOverview(FieldDoc field)

Deprecated.

Check to see if overview details should be printed. If nocomment option set or if there is no text to be printed for deprecation info, comment or tags, do not print overview details.

Specified by:

shouldPrintOverview in interface SerializedFormWriter.SerialFieldWriter

Parameters:

field - the field to check overview details for.

Returns:

true if overview details need to be printed