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.
- Author:
- Atul M Dambalkar
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.SerializedFormWriter
SerializedFormWriter.SerialFieldWriter, SerializedFormWriter.SerialMethodWriter
-
-
Field Summary
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
configuration, filename, 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 Constructor Description SerializedFormWriterImpl(ConfigurationImpl configuration)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addFooter(Content serializedTree)
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.Content
getClassContentHeader()
Deprecated.Get the class serialize content header.Content
getClassHeader(ClassDoc classDoc)
Deprecated.Get the serializable class heading.Content
getClassSerializedHeader()
Deprecated.Get the serialized class header.Content
getHeader(String header)
Deprecated.Get the given header.Content
getPackageHeader(String packageName)
Deprecated.Get the given package header.Content
getPackageSerializedHeader()
Deprecated.Get the package serialized form header.SerializedFormWriter.SerialFieldWriter
getSerialFieldWriter(ClassDoc classDoc)
Deprecated.Return an instance of a SerialFieldWriter.Content
getSerializedContent(Content serializedTreeContent)
Deprecated.Get the serialized content tree section.Content
getSerializedSummariesHeader()
Deprecated.Get the serialized form summaries header.SerializedFormWriter.SerialMethodWriter
getSerialMethodWriter(ClassDoc classDoc)
Deprecated.Return an instance of a SerialMethodWriter.Content
getSerialUIDInfoHeader()
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, 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
-
-
-
-
Constructor Detail
-
SerializedFormWriterImpl
public SerializedFormWriterImpl(ConfigurationImpl configuration) throws IOException
Deprecated.- Parameters:
configuration
- the configuration data for the doclet- Throws:
IOException
DocletAbortException
-
-
Method Detail
-
getHeader
public Content getHeader(String header)
Deprecated.Get the given header.- Specified by:
getHeader
in interfaceSerializedFormWriter
- Parameters:
header
- the header to write- Returns:
- the body content tree
-
getSerializedSummariesHeader
public Content getSerializedSummariesHeader()
Deprecated.Get the serialized form summaries header.- Specified by:
getSerializedSummariesHeader
in interfaceSerializedFormWriter
- Returns:
- the serialized form summary header tree
-
getPackageSerializedHeader
public Content getPackageSerializedHeader()
Deprecated.Get the package serialized form header.- Specified by:
getPackageSerializedHeader
in interfaceSerializedFormWriter
- Returns:
- the package serialized form header tree
-
getPackageHeader
public Content getPackageHeader(String packageName)
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
public Content getClassSerializedHeader()
Deprecated.Get the serialized class header.- Specified by:
getClassSerializedHeader
in interfaceSerializedFormWriter
- Returns:
- a content tree for the serialized class header
-
isVisibleClass
public boolean isVisibleClass(ClassDoc classDoc)
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
public Content getClassHeader(ClassDoc classDoc)
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
public Content getSerialUIDInfoHeader()
Deprecated.Get the serial UID info header.- Specified by:
getSerialUIDInfoHeader
in interfaceSerializedFormWriter
- Returns:
- a content tree for the serial uid info header
-
addSerialUIDInfo
public void addSerialUIDInfo(String header, String serialUID, Content serialUidTree)
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
public Content getClassContentHeader()
Deprecated.Get the class serialize content header.- Specified by:
getClassContentHeader
in interfaceSerializedFormWriter
- Returns:
- a content tree for the class serialize content header
-
getSerializedContent
public Content getSerializedContent(Content serializedTreeContent)
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
-
addFooter
public void addFooter(Content serializedTree)
Deprecated.Add the footer.- Specified by:
addFooter
in interfaceSerializedFormWriter
- Parameters:
serializedTree
- the serialized tree to be added
-
printDocument
public void printDocument(Content serializedTree) throws IOException
Deprecated.Print the serialized form document.- Specified by:
printDocument
in interfaceSerializedFormWriter
- Parameters:
serializedTree
- the content tree that will be printed- Throws:
IOException
-
getSerialFieldWriter
public SerializedFormWriter.SerialFieldWriter getSerialFieldWriter(ClassDoc classDoc)
Deprecated.Return an instance of a SerialFieldWriter.- Specified by:
getSerialFieldWriter
in interfaceSerializedFormWriter
- Returns:
- an instance of a SerialFieldWriter.
-
getSerialMethodWriter
public SerializedFormWriter.SerialMethodWriter getSerialMethodWriter(ClassDoc classDoc)
Deprecated.Return an instance of a SerialMethodWriter.- Specified by:
getSerialMethodWriter
in interfaceSerializedFormWriter
- Returns:
- an instance of a SerialMethodWriter.
-
-