Class PackageUseWriter
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.PackageUseWriter
Deprecated.
Generate package usage information.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected HtmlTree
Deprecated.(package private) final PackageDoc
Deprecated.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
ConstructorsConstructorDescriptionPackageUseWriter
(ConfigurationImpl configuration, ClassUseMapper mapper, DocPath filename, PackageDoc pkgdoc) Deprecated.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addClassList
(Content contentTree) Deprecated.Add the list of classes that use the given package.protected void
addClassRow
(ClassDoc usedClass, PackageDoc pkg, Content contentTree) Deprecated.Add a row for the class that uses the given package.protected void
addPackageList
(Content contentTree) Deprecated.Add the list of packages that use the given package.protected void
addPackageUse
(PackageDoc pkg, Content contentTree) Deprecated.Add the package use information.protected void
addPackageUse
(Content contentTree) Deprecated.Add the package use information.static void
generate
(ConfigurationImpl configuration, ClassUseMapper mapper, PackageDoc pkgdoc) Deprecated.Generate a class page.protected void
Deprecated.Generate the package use list.protected Content
Deprecated.Get the use link.protected Content
Deprecated.Get this package link.protected Content
Deprecated.Get the tree link.protected HtmlTree
Deprecated.Get the header for the package use listing.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, getNavLinkContents, getNavLinkDeprecated, getNavLinkHelp, getNavLinkIndex, getNavLinkMainTree, getNavLinkNext, getNavLinkNext, getNavLinkPackage, getNavLinkPrevious, getNavLinkPrevious, 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
-
Field Details
-
pkgdoc
Deprecated. -
usingPackageToUsedClasses
Deprecated. -
mainTree
Deprecated.
-
-
Constructor Details
-
PackageUseWriter
public PackageUseWriter(ConfigurationImpl configuration, ClassUseMapper mapper, DocPath filename, PackageDoc pkgdoc) throws IOException Deprecated.Constructor.- Parameters:
filename
- the file to be generated.- Throws:
IOException
DocletAbortException
-
-
Method Details
-
generate
public static void generate(ConfigurationImpl configuration, ClassUseMapper mapper, PackageDoc pkgdoc) Deprecated.Generate a class page.- Parameters:
configuration
- the current configuration of the doclet.mapper
- the mapping of the class usage.pkgdoc
- the package doc being documented.
-
generatePackageUseFile
Deprecated.Generate the package use list.- Throws:
IOException
-
addPackageUse
Deprecated.Add the package use information.- Parameters:
contentTree
- the content tree to which the package use information will be added- Throws:
IOException
-
addPackageList
Deprecated.Add the list of packages that use the given package.- Parameters:
contentTree
- the content tree to which the package list will be added- Throws:
IOException
-
addClassList
Deprecated.Add the list of classes that use the given package.- Parameters:
contentTree
- the content tree to which the class list will be added- Throws:
IOException
-
addClassRow
Deprecated.Add a row for the class that uses the given package.- Parameters:
usedClass
- the class that uses the given packagepkg
- the package to which the class belongscontentTree
- the content tree to which the row will be added
-
addPackageUse
Deprecated.Add the package use information.- Parameters:
pkg
- the package that used the given packagecontentTree
- the content tree to which the information will be added- Throws:
IOException
-
getPackageUseHeader
Deprecated.Get the header for the package use listing.- Returns:
- a content tree representing the package use header
-