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

public Class SerialMethodWriter

extends MethodWriter
Class Inheritance
Imports
javax.lang.model.element.ExecutableElement, .TypeElement, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.formats.html.taglets.TagletManager, jdk.javadoc.internal.html.Content, .HtmlTag, .HtmlTree, .Text
Generate serialized form for Serializable/Externalizable methods. Documentation denoted by the serialData tag is processed.

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
protected void
addDeprecatedMemberInfo(ExecutableElement
the method to document.
member, Content
the content to which the deprecated info will be added
methodsContent)

Add the deprecated information for this member.

protected void
addMemberDescription(ExecutableElement
the method to document.
member, Content
the content to which the deprecated info will be added
methodsContent)

Add the description text for this member.

protected void
addMemberHeader(ExecutableElement
the method document to be listed
member, Content
the content to which the member header will be added
methodsContent)

Add the member header.

protected void
addMemberTags(ExecutableElement
the method to document.
member, Content
the content to which the member tags info will be added
methodsContent)

Add the tag information for this member.

protected Content
getMethodsContentHeader()

protected Content

Returns:

no customization message content
getNoCustomizationMsg(String
the message to be displayed
msg)

Return the no customization message.

protected Content

Returns:

a content for the serializable methods content
getSerializableMethods(String
the heading for the section
heading, Content
the content to be added to the serializable methods content
source)

Add serializable methods.

protected Content
getSerializableMethodsHeader()

Inherited from jdk.javadoc.internal.doclets.formats.html.MethodWriter:
addCommentsaddDeprecatedaddImplementsInfoaddInheritedSummaryLabeladdOverriddenaddPreviewaddRestrictedaddSummaryLabeladdSummaryTypeaddTagsbuildDeprecationInfobuildDetailsbuildMethodCommentsbuildMethodDocbuildPreviewInfobuildRestrictedInfobuildSignaturebuildSummarybuildTagInfocreateInheritedSummaryTablecreateSummaryTablegetInheritedSummaryIdgetMemberSummaryHeadergetMethodDetailsgetMethodDetailsHeadergetMethodHeadergetReturnTypegetSignaturegetSummaryTableHeader

Constructor Detail

SerialMethodWriterback to summary
public SerialMethodWriter(SubWriterHolderWriter writer, TypeElement typeElement)

Method Detail

addDeprecatedMemberInfoback to summary
protected void addDeprecatedMemberInfo(ExecutableElement member, Content methodsContent)

Add the deprecated information for this member.

Parameters
member:ExecutableElement

the method to document.

methodsContent:Content

the content to which the deprecated info will be added

addMemberDescriptionback to summary
protected void addMemberDescription(ExecutableElement member, Content methodsContent)

Add the description text for this member.

Parameters
member:ExecutableElement

the method to document.

methodsContent:Content

the content to which the deprecated info will be added

addMemberHeaderback to summary
protected void addMemberHeader(ExecutableElement member, Content methodsContent)

Add the member header.

Parameters
member:ExecutableElement

the method document to be listed

methodsContent:Content

the content to which the member header will be added

addMemberTagsback to summary
protected void addMemberTags(ExecutableElement member, Content methodsContent)

Add the tag information for this member.

Parameters
member:ExecutableElement

the method to document.

methodsContent:Content

the content to which the member tags info will be added

getMethodsContentHeaderback to summary
protected Content getMethodsContentHeader()
getNoCustomizationMsgback to summary
protected Content getNoCustomizationMsg(String msg)

Return the no customization message.

Parameters
msg:String

the message to be displayed

Returns:Content

no customization message content

getSerializableMethodsback to summary
protected Content getSerializableMethods(String heading, Content source)

Add serializable methods.

Parameters
heading:String

the heading for the section

source:Content

the content to be added to the serializable methods content

Returns:Content

a content for the serializable methods content

getSerializableMethodsHeaderback to summary
protected Content getSerializableMethodsHeader()