Class ConstantsSummaryWriterImpl
- 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.ConstantsSummaryWriterImpl
-
- All Implemented Interfaces:
ConstantsSummaryWriter
@Deprecated public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements ConstantsSummaryWriter
Deprecated.Write the Constants Summary Page in HTML format.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.
- Since:
- 1.4
- Author:
- Jamie Ho, Bhavesh Patel (Modified)
-
-
Field Summary
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
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 ConstantsSummaryWriterImpl(ConfigurationImpl configuration)
Deprecated.Construct a ConstantsSummaryWriter.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addClassConstant(Content summariesTree, Content classConstantTree)
Deprecated.Add the content list to the documentation summaries tree.void
addConstantMembers(ClassDoc cd, List<FieldDoc> fields, Content classConstantTree)
Deprecated.Adds the constant member table to the documentation tree.void
addConstantSummaries(Content contentTree, Content summariesTree)
Deprecated.Add the summaries list to the content tree.void
addContentsList(Content contentTree, Content contentListTree)
Deprecated.Add the content list to the documentation tree.void
addFooter(Content contentTree)
Deprecated.Adds the footer for the summary documentation.void
addLinkToPackageContent(PackageDoc pkg, String parsedPackageName, Set<String> printedPackageHeaders, Content contentListTree)
Deprecated.Adds the given package name link to the constant content list tree.void
addPackageName(String parsedPackageName, Content summariesTree, boolean first)
Deprecated.Adds the given package name.Content
getClassConstantHeader()
Deprecated.Get the class summary header for the constants summary.protected Content
getClassName(Content classStr)
Deprecated.Get the class name in the table caption and the table header.Content
getConstantMembersHeader(ClassDoc cd)
Deprecated.Get the table caption and header for the constant summary tableContent
getConstantSummaries()
Deprecated.Get the constant summaries for the document.Content
getContentsHeader()
Deprecated.Get the header for the constant content list.Content
getHeader()
Deprecated.Get the header for the constant summary documentation.void
printDocument(Content contentTree)
Deprecated.Print the constants summary document.-
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.ConstantsSummaryWriter
close
-
-
-
-
Constructor Detail
-
ConstantsSummaryWriterImpl
public ConstantsSummaryWriterImpl(ConfigurationImpl configuration) throws IOException
Deprecated.Construct a ConstantsSummaryWriter.- Parameters:
configuration
- the configuration used in this run of the standard doclet.- Throws:
IOException
-
-
Method Detail
-
getHeader
public Content getHeader()
Deprecated.Get the header for the constant summary documentation.- Specified by:
getHeader
in interfaceConstantsSummaryWriter
- Returns:
- header that needs to be added to the documentation
-
getContentsHeader
public Content getContentsHeader()
Deprecated.Get the header for the constant content list.- Specified by:
getContentsHeader
in interfaceConstantsSummaryWriter
- Returns:
- content header that needs to be added to the documentation
-
addLinkToPackageContent
public void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName, Set<String> printedPackageHeaders, Content contentListTree)
Deprecated.Adds the given package name link to the constant content list tree.- Specified by:
addLinkToPackageContent
in interfaceConstantsSummaryWriter
- Parameters:
pkg
- thePackageDoc
to index.parsedPackageName
- the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.printedPackageHeaders
- the set of package headers that have already been indexed. We don't want to index something more than once.contentListTree
- the content tree to which the link will be added
-
addContentsList
public void addContentsList(Content contentTree, Content contentListTree)
Deprecated.Add the content list to the documentation tree.- Specified by:
addContentsList
in interfaceConstantsSummaryWriter
- Parameters:
contentTree
- the tree to which the contents list will be addedcontentListTree
- the content that will be added to the list
-
getConstantSummaries
public Content getConstantSummaries()
Deprecated.Get the constant summaries for the document.- Specified by:
getConstantSummaries
in interfaceConstantsSummaryWriter
- Returns:
- constant summaries header to be added to the documentation tree
-
addPackageName
public void addPackageName(String parsedPackageName, Content summariesTree, boolean first)
Deprecated.Adds the given package name.- Specified by:
addPackageName
in interfaceConstantsSummaryWriter
- Parameters:
parsedPackageName
- the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.summariesTree
- the summaries documentation treefirst
- true if the first package is listed be written
-
getClassConstantHeader
public Content getClassConstantHeader()
Deprecated.Get the class summary header for the constants summary.- Specified by:
getClassConstantHeader
in interfaceConstantsSummaryWriter
- Returns:
- the header content for the class constants summary
-
addClassConstant
public void addClassConstant(Content summariesTree, Content classConstantTree)
Deprecated.Add the content list to the documentation summaries tree.- Specified by:
addClassConstant
in interfaceConstantsSummaryWriter
- Parameters:
summariesTree
- the tree to which the class constants list will be addedclassConstantTree
- the class constant tree that will be added to the list
-
getConstantMembersHeader
public Content getConstantMembersHeader(ClassDoc cd)
Deprecated.Get the table caption and header for the constant summary table- Parameters:
cd
- classdoc to be documented- Returns:
- constant members header content
-
getClassName
protected Content getClassName(Content classStr)
Deprecated.Get the class name in the table caption and the table header.- Parameters:
classStr
- the class name to print.- Returns:
- the table caption and header
-
addConstantMembers
public void addConstantMembers(ClassDoc cd, List<FieldDoc> fields, Content classConstantTree)
Deprecated.Adds the constant member table to the documentation tree.- Specified by:
addConstantMembers
in interfaceConstantsSummaryWriter
- Parameters:
cd
- the class whose constants are being documented.fields
- the constants being documented.classConstantTree
- the documentation tree to which theconstant member table content will be added
-
addConstantSummaries
public void addConstantSummaries(Content contentTree, Content summariesTree)
Deprecated.Add the summaries list to the content tree.- Specified by:
addConstantSummaries
in interfaceConstantsSummaryWriter
- Parameters:
contentTree
- the tree to which the summaries list will be addedsummariesTree
- the summaries content tree that will be added to the list
-
addFooter
public void addFooter(Content contentTree)
Deprecated.Adds the footer for the summary documentation.- Specified by:
addFooter
in interfaceConstantsSummaryWriter
- Parameters:
contentTree
- content tree to which the footer will be added
-
printDocument
public void printDocument(Content contentTree) throws IOException
Deprecated.Print the constants summary document.- Specified by:
printDocument
in interfaceConstantsSummaryWriter
- Parameters:
contentTree
- content tree which should be printed- Throws:
IOException
-
-