Class HtmlSerialMethodWriter
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.MethodWriterImpl
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlSerialMethodWriter
-
- All Implemented Interfaces:
MemberSummaryWriter
,MethodWriter
,SerializedFormWriter.SerialMethodWriter
@Deprecated public class HtmlSerialMethodWriter extends MethodWriterImpl implements SerializedFormWriter.SerialMethodWriter
Deprecated.Generate serialized form for Serializable/Externalizable methods. Documentation denoted by theserialData
tag is processed.This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Author:
- Joe Fialli, Bhavesh Patel (Modified)
-
-
Field Summary
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
classdoc, configuration, methodTypes, nodepr, printedSummaryHeader, typeMap, utils, writer
-
-
Constructor Summary
Constructors Constructor Description HtmlSerialMethodWriter(SubWriterHolderWriter writer, ClassDoc classdoc)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addDeprecatedMemberInfo(MethodDoc member, Content methodsContentTree)
Deprecated.Add the deprecated information for this member.void
addMemberDescription(MethodDoc member, Content methodsContentTree)
Deprecated.Add the description text for this member.void
addMemberHeader(MethodDoc member, Content methodsContentTree)
Deprecated.Add the member header.void
addMemberTags(MethodDoc member, Content methodsContentTree)
Deprecated.Add the tag information for this member.Content
getMethodsContentHeader(boolean isLastContent)
Deprecated.Return the header for serializable methods content section.Content
getNoCustomizationMsg(String msg)
Deprecated.Return the no customization message.Content
getSerializableMethods(String heading, Content serializableMethodContent)
Deprecated.Add serializable methods.Content
getSerializableMethodsHeader()
Deprecated.Return the header for serializable methods section.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.MethodWriterImpl
addComments, addDeprecated, addImplementsInfo, addInheritedSummaryAnchor, addInheritedSummaryLabel, addMemberTree, addNavDetailLink, addOverridden, addReturnType, addSummaryAnchor, addSummaryLabel, addSummaryType, addTags, close, getCaption, getMemberKind, getMemberSummaryHeader, getMethodDetails, getMethodDetailsTreeHeader, getMethodDoc, getMethodDocTreeHeader, getNavSummaryLink, getSignature, getSummaryTableHeader, getTableSummary
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter
addExceptions, addInheritedSummaryLink, addParam, addParameters, addParameters, addReceiverAnnotations, addSummaryLink, addTypeParameters, getDeprecatedLink, getErasureAnchor, getTypeParameters, implementsMethodInIntfac
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
addComment, addDeprecatedAPI, addDeprecatedInfo, addInheritedMemberSummary, addMemberSummary, addModifierAndType, addModifiers, addName, addNavDetailLink, addNavSummaryLink, addSummaryLink, addUseInfo, eligibleMembers, getHead, getInheritedSummaryHeader, getInheritedSummaryLinksTree, getMemberTree, getMemberTree, getSummaryTableTree, isInherited, makeSpace, modifierString, name, serialWarning, setSummaryColumnStyle, showTabs, typeString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.MemberSummaryWriter
addInheritedMemberSummary, addMemberSummary, getInheritedSummaryHeader, getInheritedSummaryLinksTree, getMemberTree, getSummaryTableTree
-
-
-
-
Constructor Detail
-
HtmlSerialMethodWriter
public HtmlSerialMethodWriter(SubWriterHolderWriter writer, ClassDoc classdoc)
Deprecated.
-
-
Method Detail
-
getSerializableMethodsHeader
public Content getSerializableMethodsHeader()
Deprecated.Return the header for serializable methods section.- Specified by:
getSerializableMethodsHeader
in interfaceSerializedFormWriter.SerialMethodWriter
- Returns:
- a content tree for the header
-
getMethodsContentHeader
public Content getMethodsContentHeader(boolean isLastContent)
Deprecated.Return the header for serializable methods content section.- Specified by:
getMethodsContentHeader
in interfaceSerializedFormWriter.SerialMethodWriter
- Parameters:
isLastContent
- true if the cotent being documented is the last content.- Returns:
- a content tree for the header
-
getSerializableMethods
public Content getSerializableMethods(String heading, Content serializableMethodContent)
Deprecated.Add serializable methods.- Specified by:
getSerializableMethods
in interfaceSerializedFormWriter.SerialMethodWriter
- Parameters:
heading
- the heading for the sectionserializableMethodContent
- the tree to be added to the serializable methods content tree- Returns:
- a content tree for the serializable methods content
-
getNoCustomizationMsg
public Content getNoCustomizationMsg(String msg)
Deprecated.Return the no customization message.- Specified by:
getNoCustomizationMsg
in interfaceSerializedFormWriter.SerialMethodWriter
- Parameters:
msg
- the message to be displayed- Returns:
- no customization message content
-
addMemberHeader
public void addMemberHeader(MethodDoc member, Content methodsContentTree)
Deprecated.Add the member header.- Specified by:
addMemberHeader
in interfaceSerializedFormWriter.SerialMethodWriter
- Parameters:
member
- the method document to be listedmethodsContentTree
- the content tree to which the member header will be added
-
addDeprecatedMemberInfo
public void addDeprecatedMemberInfo(MethodDoc member, Content methodsContentTree)
Deprecated.Add the deprecated information for this member.- Specified by:
addDeprecatedMemberInfo
in interfaceSerializedFormWriter.SerialMethodWriter
- Parameters:
member
- the method to document.methodsContentTree
- the tree to which the deprecated info will be added
-
addMemberDescription
public void addMemberDescription(MethodDoc member, Content methodsContentTree)
Deprecated.Add the description text for this member.- Specified by:
addMemberDescription
in interfaceSerializedFormWriter.SerialMethodWriter
- Parameters:
member
- the method to document.methodsContentTree
- the tree to which the deprecated info will be added
-
addMemberTags
public void addMemberTags(MethodDoc member, Content methodsContentTree)
Deprecated.Add the tag information for this member.- Specified by:
addMemberTags
in interfaceSerializedFormWriter.SerialMethodWriter
- Parameters:
member
- the method to document.methodsContentTree
- the tree to which the member tags info will be added
-
-