com.sun.tools.doclets.internal.toolkit
Interface SerializedFormWriter.SerialFieldWriter

All Known Implementing Classes:

HtmlSerialFieldWriter

Enclosing interface:

SerializedFormWriter

public static interface SerializedFormWriter.SerialFieldWriter

Write the serialized form for a given field.

Method Summary

void	writeHeader(java.lang.String heading) Write the given heading.
void	writeMemberDeprecatedInfo(FieldDoc field) Write the deprecated information for this member.
void	writeMemberDescription(FieldDoc field) Write the description text for this member.
void	writeMemberDescription(SerialFieldTag serialFieldTag) Write the description text for this member represented by the tag.
void	writeMemberFooter(FieldDoc member) Write the footer.
void	writeMemberHeader(ClassDoc fieldType, java.lang.String fieldTypeStr, java.lang.String fieldDimensions, java.lang.String fieldName) Write the member header.
void	writeMemberTags(FieldDoc field) Write the tag information for this member.

Method Detail

writeHeader

void writeHeader(java.lang.String heading)

Write the given heading.

Parameters:

heading - the heading to write.

writeMemberDeprecatedInfo

void writeMemberDeprecatedInfo(FieldDoc field)

Write the deprecated information for this member.

Parameters:

field - the field to document.

writeMemberDescription

void writeMemberDescription(FieldDoc field)

Write the description text for this member.

Parameters:

field - the field to document.

writeMemberDescription

void writeMemberDescription(SerialFieldTag serialFieldTag)

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

Parameters:

serialFieldTag - the field to document (represented by tag).

writeMemberTags

void writeMemberTags(FieldDoc field)

Write the tag information for this member.

Parameters:

field - the field to document.

writeMemberHeader

void writeMemberHeader(ClassDoc fieldType,
                       java.lang.String fieldTypeStr,
                       java.lang.String fieldDimensions,
                       java.lang.String fieldName)

Write the member header.

Parameters:

fieldType - the type of the field.

fieldTypeStr - the type of the field in string format. We will print this out if we can't link to the type.

fieldDimensions - the dimensions of the field.

fieldName - the name of the field.

writeMemberFooter

void writeMemberFooter(FieldDoc member)

Write the footer.

Parameters:

member - the member to write the header for.