Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit

Interface SerializedFormWriter.SerialMethodWriter

All Known Implementing Classes:

HtmlSerialMethodWriter

Enclosing interface:

SerializedFormWriter

public static interface SerializedFormWriter.SerialMethodWriter

Write the serialized form for a given field.

Method Summary

Modifier and Type	Method	Description
void	addDeprecatedMemberInfo(MethodDoc member, Content methodsContentTree)	Adds the deprecated information for this member.
void	addMemberDescription(MethodDoc member, Content methodsContentTree)	Adds the description for this member.
void	addMemberHeader(MethodDoc member, Content methodsContentTree)	Adds the header.
void	addMemberTags(MethodDoc member, Content methodsContentTree)	Adds the tag information for this member.
Content	getMethodsContentHeader(boolean isLastContent)	Get the method content header.
Content	getNoCustomizationMsg(String msg)	Write a warning that no serializable methods exist.
Content	getSerializableMethods(String heading, Content serializableMethodTree)	Write the given heading.
Content	getSerializableMethodsHeader()	Get the serializable method header.

Method Detail

getSerializableMethodsHeader

Content getSerializableMethodsHeader()

Get the serializable method header.

Returns:

serializable methods content tree

getMethodsContentHeader

Content getMethodsContentHeader(boolean isLastContent)

Get the method content header.

Parameters:

isLastContent - true if this is the last content to be documented

Returns:

methods content tree

getSerializableMethods

Content getSerializableMethods(String heading,
                               Content serializableMethodTree)

Write the given heading.

Parameters:

heading - the heading to write

serializableMethodTree - content tree which will be added

Returns:

serializable methods content tree

getNoCustomizationMsg

Content getNoCustomizationMsg(String msg)

Write a warning that no serializable methods exist.

Parameters:

msg - the warning to print

Returns:

no customization message tree

addMemberHeader

void addMemberHeader(MethodDoc member,
                     Content methodsContentTree)

Adds the header.

Parameters:

member - the member to write the header for

methodsContentTree - content tree to which the header will be added

addDeprecatedMemberInfo

void addDeprecatedMemberInfo(MethodDoc member,
                             Content methodsContentTree)

Adds the deprecated information for this member.

Parameters:

member - the member to write the deprecated information for

methodsContentTree - content tree to which the deprecated information will be added

addMemberDescription

void addMemberDescription(MethodDoc member,
                          Content methodsContentTree)

Adds the description for this member.

Parameters:

member - the member to write the information for

methodsContentTree - content tree to which the member information will be added

addMemberTags

void addMemberTags(MethodDoc member,
                   Content methodsContentTree)

Adds the tag information for this member.

Parameters:

member - the member to write the tags information for

methodsContentTree - content tree to which the tags information will be added