Class SerializedFormWriterImpl
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.SubWriterHolderWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.SerializedFormWriterImpl
- All Implemented Interfaces:
SerializedFormWriter
@Deprecated
public class SerializedFormWriterImpl
extends SubWriterHolderWriter
implements SerializedFormWriter
Deprecated.
Generate the Serialized Form Information Page.
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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.SerializedFormWriter
SerializedFormWriter.SerialFieldWriter, SerializedFormWriter.SerialMethodWriter
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate HtmlTree
Deprecated.HTML tree for main tag.Deprecated.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
blockTags, configuration, filename, fixedNavDiv, path, pathToRoot, printedAnnotationFieldHeading, printedAnnotationHeading, utils
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
CONTENT_TYPE
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
allclassesLabel, allpackagesLabel, annotationTypeDetailsLabel, classLabel, constructorDetailsLabel, defaultPackageLabel, deprecatedLabel, deprecatedPhrase, descfrmClassLabel, descfrmInterfaceLabel, descriptionLabel, detailLabel, enumConstantsDetailsLabel, fieldDetailsLabel, framesLabel, helpLabel, indexLabel, memberDetailsListPrinted, methodDetailsLabel, modifierTypeHeader, nextclassLabel, nextLabel, nextpackageLabel, noframesLabel, overridesLabel, overviewLabel, packageLabel, packagesLabel, packageTableHeader, prevclassLabel, prevLabel, prevpackageLabel, propertyDetailsLabel, script, seeLabel, specifiedByLabel, summaryLabel, treeLabel, useLabel, useTableSummary, winTitle
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.Add the footer.void
addPackageSerializedTree
(Content serializedSummariesTree, Content packageSerializedTree) Deprecated.Add the serialized tree per package to the serialized summaries tree.void
addSerialUIDInfo
(String header, String serialUID, Content serialUidTree) Deprecated.Adds the serial UID info.Deprecated.Get the class serialize content header.getClassHeader
(ClassDoc classDoc) Deprecated.Get the serializable class heading.Deprecated.Get the serialized class header.Deprecated.Get the given header.getPackageHeader
(String packageName) Deprecated.Get the given package header.Deprecated.Get the package serialized form header.getSerialFieldWriter
(ClassDoc classDoc) Deprecated.Return an instance of a SerialFieldWriter.getSerializedContent
(Content serializedTreeContent) Deprecated.Get the serialized content tree section.Deprecated.Get the serialized form summaries header.getSerialMethodWriter
(ClassDoc classDoc) Deprecated.Return an instance of a SerialMethodWriter.Deprecated.Get the serial UID info header.boolean
isVisibleClass
(ClassDoc classDoc) Deprecated.Checks if a class is generated and is visible.void
printDocument
(Content serializedTree) Deprecated.Print the serialized form document.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.SubWriterHolderWriter
addAnnotationContentTree, addClassContentTree, addIndexComment, addIndexComment, addInheritedMemberSummary, addInheritedSummaryHeader, addMemberTree, addSummaryHeader, addSummaryLinkComment, addSummaryLinkComment, addSummaryType, getContentHeader, getMemberDetailsTree, getMemberSummaryTree, getMemberTree, getMemberTree, getMemberTreeHeader, getMethodTypeLinks, getSummaryTableTree, getTableCaption
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
addAnnotationInfo, addAnnotationInfo, addAnnotationInfo, addBottom, addInlineComment, addInlineComment, addInlineDeprecatedComment, addNavLinks, addPackageDeprecatedAPI, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addReceiverAnnotationInfo, addScriptProperties, addSrcLink, addStyleSheetProperties, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addSummaryDetailLinks, addTagsInfo, addTop, check, commentTagsToContent, configuration, getAllClassesLinkScript, getAnchor, getAnchor, getAnnotations, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getLink, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getNavHideLists, getNavLinkClass, getNavLinkClassIndex, getNavLinkClassUse, getNavLinkContents, getNavLinkDeprecated, getNavLinkHelp, getNavLinkIndex, getNavLinkMainTree, getNavLinkNext, getNavLinkNext, getNavLinkPackage, getNavLinkPackage, getNavLinkPrevious, getNavLinkPrevious, getNavLinkTree, getNavShowLists, getNavShowLists, getPackageAnchorName, getPackageLabel, getPackageLink, getPackageLink, getPackageName, getPreQualifiedClassLink, getQualifiedClassLink, getSummaryTableHeader, getTableCaption, getTagletWriterInstance, getTargetPackageLink, getTypeParameterLinks, getUserHeaderFooter, getWindowTitle, hasSerializationOverviewTags, isClassLinkable, isCoreClass, italicsClassName, pathString, pathString, printHtmlDocument, removeNonInlineHtmlTags, replaceDocRootDir, seeTagToContent
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
getDocLink, getDocLink, getDocLink, getGeneratedBy, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getMemberDetailsListPrinted, getName, getPkgName, getStyleSheetProperties, printFramesDocument
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
addStyles, close, codeText, generateMethodTypesScript, getBody, getFramesJavaScript, getModifierTypeHeader, getNonBreakResource, getResource, getResource, getResource, getSpace, getTitle, getWinTitleScript, write
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.SerializedFormWriter
close
-
Field Details
-
visibleClasses
Deprecated. -
mainTree
Deprecated.HTML tree for main tag.
-
-
Constructor Details
-
SerializedFormWriterImpl
Deprecated.- Parameters:
configuration
- the configuration data for the doclet- Throws:
IOException
DocletAbortException
-
-
Method Details
-
getHeader
Deprecated.Get the given header.- Specified by:
getHeader
in interfaceSerializedFormWriter
- Parameters:
header
- the header to write- Returns:
- the body content tree
-
getSerializedSummariesHeader
Deprecated.Get the serialized form summaries header.- Specified by:
getSerializedSummariesHeader
in interfaceSerializedFormWriter
- Returns:
- the serialized form summary header tree
-
getPackageSerializedHeader
Deprecated.Get the package serialized form header.- Specified by:
getPackageSerializedHeader
in interfaceSerializedFormWriter
- Returns:
- the package serialized form header tree
-
getPackageHeader
Deprecated.Get the given package header.- Specified by:
getPackageHeader
in interfaceSerializedFormWriter
- Parameters:
packageName
- the package header to write- Returns:
- a content tree for the package header
-
getClassSerializedHeader
Deprecated.Get the serialized class header.- Specified by:
getClassSerializedHeader
in interfaceSerializedFormWriter
- Returns:
- a content tree for the serialized class header
-
isVisibleClass
Deprecated.Checks if a class is generated and is visible.- Parameters:
classDoc
- the class being processed.- Returns:
- true if the class, that is being processed, is generated and is visible.
-
getClassHeader
Deprecated.Get the serializable class heading.- Specified by:
getClassHeader
in interfaceSerializedFormWriter
- Parameters:
classDoc
- the class being processed- Returns:
- a content tree for the class header
-
getSerialUIDInfoHeader
Deprecated.Get the serial UID info header.- Specified by:
getSerialUIDInfoHeader
in interfaceSerializedFormWriter
- Returns:
- a content tree for the serial uid info header
-
addSerialUIDInfo
Deprecated.Adds the serial UID info.- Specified by:
addSerialUIDInfo
in interfaceSerializedFormWriter
- Parameters:
header
- the header that will show up before the UID.serialUID
- the serial UID to print.serialUidTree
- the serial UID content tree to which the serial UID content will be added
-
getClassContentHeader
Deprecated.Get the class serialize content header.- Specified by:
getClassContentHeader
in interfaceSerializedFormWriter
- Returns:
- a content tree for the class serialize content header
-
getSerializedContent
Deprecated.Get the serialized content tree section.- Specified by:
getSerializedContent
in interfaceSerializedFormWriter
- Parameters:
serializedTreeContent
- the serialized content tree to be added- Returns:
- a div content tree
-
addPackageSerializedTree
public void addPackageSerializedTree(Content serializedSummariesTree, Content packageSerializedTree) Deprecated.Add the serialized tree per package to the serialized summaries tree.- Specified by:
addPackageSerializedTree
in interfaceSerializedFormWriter
- Parameters:
serializedSummariesTree
- the serialized tree to which the package serialized tree will be addedpackageSerializedTree
- the serialized tree per package that needs to be added
-
printDocument
Deprecated.Print the serialized form document.- Specified by:
printDocument
in interfaceSerializedFormWriter
- Parameters:
serializedTree
- the content tree that will be printed- Throws:
IOException
-
getSerialFieldWriter
Deprecated.Return an instance of a SerialFieldWriter.- Specified by:
getSerialFieldWriter
in interfaceSerializedFormWriter
- Returns:
- an instance of a SerialFieldWriter.
-
getSerialMethodWriter
Deprecated.Return an instance of a SerialMethodWriter.- Specified by:
getSerialMethodWriter
in interfaceSerializedFormWriter
- Returns:
- an instance of a SerialMethodWriter.
-