APIdia Launch Partner
Top Description Constructors Methods
jdk.javadoc.internal.doclets.formats.html

public Class SerialFieldWriter

extends FieldWriter
Class Inheritance
Imports
java.util.List, javax.lang.model.element.TypeElement, .VariableElement, javax.lang.model.type.TypeMirror, com.sun.source.doctree.DocTree, .SerialFieldTree, .SerialTree, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.formats.html.taglets.TagletWriter, jdk.javadoc.internal.html.Content, .HtmlTag, .HtmlTree, .Text
Generate serialized form for serializable fields. Documentation denoted by the tags serial and serialField is processed.

Constructor Summary

AccessConstructor and Description
public
SerialFieldWriter(SubWriterHolderWriter writer, TypeElement typeElement)

Method Summary

Modifier and TypeMethod and Description
protected void
addMemberDeprecatedInfo(VariableElement
the field to document.
field, Content
the content to which the deprecated info will be added
content)

Add the deprecated information for this member.

protected void
addMemberDescription(VariableElement
the field to document.
field, Content
the content to which the deprecated info will be added
content)

Add the description text for this member.

protected void
addMemberDescription(VariableElement field, SerialFieldTree
the field to document (represented by tag)
serialFieldTag, Content
the content to which the deprecated info will be added
content)

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

protected void
addMemberHeader(TypeMirror fieldType, String fieldName, Content content)

protected void
addMemberTags(VariableElement
the field to document.
field, Content
the content to which the member tags info will be added
content)

Add the tag information for this member.

protected Content
getFieldsContentHeader()

protected Content
getSerializableFields(String heading, Content source)

protected Content
getSerializableFieldsHeader()

protected boolean

Returns:

true if overview details need to be printed
shouldPrintOverview(VariableElement
the field to check overview details for.
field)

Check to see if overview details should be printed.

Inherited from jdk.javadoc.internal.doclets.formats.html.FieldWriter:
addCommentsaddDeprecatedaddInheritedSummaryLabeladdInheritedSummaryLinkaddPreviewaddSummaryLabeladdSummaryLinkaddSummaryTypeaddTagsbuildDeprecationInfobuildDetailsbuildFieldCommentsbuildFieldDocbuildPreviewInfobuildSignaturebuildSummarybuildTagInfocreateInheritedSummaryTablecreateSummaryTablegetFieldDetailsgetFieldDetailsHeadergetFieldHeaderContentgetInheritedSummaryIdgetMemberSummaryHeadergetSignaturegetSummaryLinkgetSummaryTableHeader

Constructor Detail

SerialFieldWriterback to summary
public SerialFieldWriter(SubWriterHolderWriter writer, TypeElement typeElement)

Method Detail

addMemberDeprecatedInfoback to summary
protected void addMemberDeprecatedInfo(VariableElement field, Content content)

Add the deprecated information for this member.

Parameters
field:VariableElement

the field to document.

content:Content

the content to which the deprecated info will be added

addMemberDescriptionback to summary
protected void addMemberDescription(VariableElement field, Content content)

Add the description text for this member.

Parameters
field:VariableElement

the field to document.

content:Content

the content to which the deprecated info will be added

addMemberDescriptionback to summary
protected void addMemberDescription(VariableElement field, SerialFieldTree serialFieldTag, Content content)

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

Parameters
serialFieldTag:SerialFieldTree

the field to document (represented by tag)

content:Content

the content to which the deprecated info will be added

addMemberHeaderback to summary
protected void addMemberHeader(TypeMirror fieldType, String fieldName, Content content)
addMemberTagsback to summary
protected void addMemberTags(VariableElement field, Content content)

Add the tag information for this member.

Parameters
field:VariableElement

the field to document.

content:Content

the content to which the member tags info will be added

getFieldsContentHeaderback to summary
protected Content getFieldsContentHeader()
getSerializableFieldsback to summary
protected Content getSerializableFields(String heading, Content source)
getSerializableFieldsHeaderback to summary
protected Content getSerializableFieldsHeader()
shouldPrintOverviewback to summary
protected boolean shouldPrintOverview(VariableElement field)

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.

Parameters
field:VariableElement

the field to check overview details for.

Returns:boolean

true if overview details need to be printed