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.
-
Field Summary
FieldsFields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
classdoc, configuration, methodTypes, nodepr, printedSummaryHeader, typeMap, utils, writer
-
Constructor Summary
ConstructorsConstructorDescriptionHtmlSerialFieldWriter
(SubWriterHolderWriter writer, ClassDoc classdoc) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.getFieldsContentHeader
(boolean isLastContent) Deprecated.Return the header for serializable fields content section.getSerializableFields
(String heading, Content serializableFieldsTree) Deprecated.Add serializable fields.Deprecated.Return the header for serializable fields section.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
-
Field Details
-
members
ProgramElementDoc[] membersDeprecated.
-
-
Constructor Details
-
HtmlSerialFieldWriter
Deprecated.
-
-
Method Details
-
members
Deprecated. -
getSerializableFieldsHeader
Deprecated.Return the header for serializable fields section.- Specified by:
getSerializableFieldsHeader
in interfaceSerializedFormWriter.SerialFieldWriter
- Returns:
- a content tree for the header
-
getFieldsContentHeader
Deprecated.Return the header for serializable fields content section.- Specified by:
getFieldsContentHeader
in interfaceSerializedFormWriter.SerialFieldWriter
- Parameters:
isLastContent
- true if the cotent being documented is the last content.- Returns:
- a content tree for the header
-
getSerializableFields
Deprecated.Add serializable fields.- Specified by:
getSerializableFields
in interfaceSerializedFormWriter.SerialFieldWriter
- Parameters:
heading
- the heading for the sectionserializableFieldsTree
- 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 interfaceSerializedFormWriter.SerialFieldWriter
- Parameters:
fieldType
- the class document to be listedfieldTypeStr
- the string for the field type to be documentedfieldDimensions
- the dimensions of the field string to be addedfieldName
- name of the field to be addedcontentTree
- the content tree to which the member header will be added
-
addMemberDeprecatedInfo
Deprecated.Add the deprecated information for this member.- Specified by:
addMemberDeprecatedInfo
in interfaceSerializedFormWriter.SerialFieldWriter
- Parameters:
field
- the field to document.contentTree
- the tree to which the deprecated info will be added
-
addMemberDescription
Deprecated.Add the description text for this member.- Specified by:
addMemberDescription
in interfaceSerializedFormWriter.SerialFieldWriter
- Parameters:
field
- the field to document.contentTree
- the tree to which the deprecated info will be added
-
addMemberDescription
Deprecated.Add the description text for this member represented by the tag.- Specified by:
addMemberDescription
in interfaceSerializedFormWriter.SerialFieldWriter
- Parameters:
serialFieldTag
- the field to document (represented by tag)contentTree
- the tree to which the deprecated info will be added
-
addMemberTags
Deprecated.Add the tag information for this member.- Specified by:
addMemberTags
in interfaceSerializedFormWriter.SerialFieldWriter
- Parameters:
field
- the field to document.contentTree
- the tree to which the member tags info will be added
-
shouldPrintOverview
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 interfaceSerializedFormWriter.SerialFieldWriter
- Parameters:
field
- the field to check overview details for.- Returns:
- true if overview details need to be printed
-