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 TypeMethodDescriptionvoid
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.getMethodsContentHeader
(boolean isLastContent) Get the method content header.Write a warning that no serializable methods exist.getSerializableMethods
(String heading, Content serializableMethodTree) Write the given heading.Get the serializable method header.
-
Method Details
-
getSerializableMethodsHeader
Content getSerializableMethodsHeader()Get the serializable method header.- Returns:
- serializable methods content tree
-
getMethodsContentHeader
Get the method content header.- Parameters:
isLastContent
- true if this is the last content to be documented- Returns:
- methods content tree
-
getSerializableMethods
Write the given heading.- Parameters:
heading
- the heading to writeserializableMethodTree
- content tree which will be added- Returns:
- serializable methods content tree
-
getNoCustomizationMsg
Write a warning that no serializable methods exist.- Parameters:
msg
- the warning to print- Returns:
- no customization message tree
-
addMemberHeader
Adds the header.- Parameters:
member
- the member to write the header formethodsContentTree
- content tree to which the header will be added
-
addDeprecatedMemberInfo
Adds the deprecated information for this member.- Parameters:
member
- the member to write the deprecated information formethodsContentTree
- content tree to which the deprecated information will be added
-
addMemberDescription
Adds the description for this member.- Parameters:
member
- the member to write the information formethodsContentTree
- content tree to which the member information will be added
-
addMemberTags
Adds the tag information for this member.- Parameters:
member
- the member to write the tags information formethodsContentTree
- content tree to which the tags information will be added
-