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
Modifier and TypeMethodDescriptionvoid
addMemberDeprecatedInfo
(FieldDoc field, Content contentTree) Adds the deprecated information for this member.void
addMemberDescription
(FieldDoc field, Content contentTree) Adds the description text for this member.void
addMemberDescription
(SerialFieldTag serialFieldTag, Content contentTree) Adds the description text for this member represented by the tag.void
addMemberHeader
(ClassDoc fieldType, String fieldTypeStr, String fieldDimensions, String fieldName, Content contentTree) Adds the member header.void
addMemberTags
(FieldDoc field, Content contentTree) Adds the tag information for this member.getFieldsContentHeader
(boolean isLastContent) Get the field content header.getSerializableFields
(String heading, Content contentTree) Get the fields content.Get the serializable field header.boolean
shouldPrintOverview
(FieldDoc field) Check to see if overview details should be printed.
-
Method Details
-
getSerializableFieldsHeader
Content getSerializableFieldsHeader()Get the serializable field header.- Returns:
- serialized fields header content tree
-
getFieldsContentHeader
Get the field content header.- Parameters:
isLastContent
- true if this is the last content to be documented- Returns:
- fields header content tree
-
getSerializableFields
Get the fields content.- Parameters:
heading
- the heading to write.contentTree
- content tree to which the heading will be added- Returns:
- serializable fields content tree
-
addMemberDeprecatedInfo
Adds the deprecated information for this member.- Parameters:
field
- the field to document.contentTree
- content tree to which the deprecated information will be added
-
addMemberDescription
Adds the description text for this member.- Parameters:
field
- the field to document.contentTree
- content tree to which the member description will be added
-
addMemberDescription
Adds the description text for this member represented by the tag.- Parameters:
serialFieldTag
- the field to document (represented by tag).contentTree
- content tree to which the member description will be added
-
addMemberTags
Adds the tag information for this member.- Parameters:
field
- the field to document.contentTree
- content tree to which the member tags will be added
-
addMemberHeader
void addMemberHeader(ClassDoc fieldType, String fieldTypeStr, String fieldDimensions, String fieldName, Content contentTree) Adds 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.contentTree
- content tree to which the member header will be added
-
shouldPrintOverview
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, inline comment or tags, do not print overview details.- Parameters:
field
- the field to check overview details for.- Returns:
- true if overview details need to be printed
-