Package gw.gosudoc.com.sun.tools.doclets.formats.html

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
public class PackageUseWriter
extends SubWriterHolderWriter

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.

Author:

Robert G. Field, Bhavesh Patel (Modified)

Field Summary

Fields

Modifier and Type	Field	Description
protected HtmlTree	mainTree	Deprecated.

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
PackageUseWriter(ConfigurationImpl configuration, ClassUseMapper mapper, DocPath filename, PackageDoc pkgdoc)	Deprecated. Constructor.

Method Summary

Modifier and Type	Method	Description
protected 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	generatePackageUseFile()	Deprecated. Generate the package use list.
protected Content	getNavLinkClassUse()	Deprecated. Get the use link.
protected Content	getNavLinkPackage()	Deprecated. Get this package link.
protected Content	getNavLinkTree()	Deprecated. Get the tree link.
protected HtmlTree	getPackageUseHeader()	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, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mainTree

protected HtmlTree mainTree

Deprecated.

Constructor Detail

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 Detail

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

protected void generatePackageUseFile()
                               throws IOException

Deprecated.

Generate the package use list.

Throws:

IOException

addPackageUse

protected void addPackageUse(Content contentTree)
                      throws IOException

Deprecated.

Add the package use information.

Parameters:

contentTree - the content tree to which the package use information will be added

Throws:

IOException

addPackageList

protected void addPackageList(Content contentTree)
                       throws IOException

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

protected void addClassList(Content contentTree)
                     throws IOException

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

protected void addClassRow(ClassDoc usedClass,
                           PackageDoc pkg,
                           Content contentTree)

Deprecated.

Add a row for the class that uses the given package.

Parameters:

usedClass - the class that uses the given package

pkg - the package to which the class belongs

contentTree - the content tree to which the row will be added

addPackageUse

protected void addPackageUse(PackageDoc pkg,
                             Content contentTree)
                      throws IOException

Deprecated.

Add the package use information.

Parameters:

pkg - the package that used the given package

contentTree - the content tree to which the information will be added

Throws:

IOException

getPackageUseHeader

protected HtmlTree getPackageUseHeader()

Deprecated.

Get the header for the package use listing.

Returns:

a content tree representing the package use header

getNavLinkPackage

protected Content getNavLinkPackage()

Deprecated.

Get this package link.

Overrides:

getNavLinkPackage in class HtmlDocletWriter

Returns:

a content tree for the package link

getNavLinkClassUse

protected Content getNavLinkClassUse()

Deprecated.

Get the use link.

Overrides:

getNavLinkClassUse in class HtmlDocletWriter

Returns:

a content tree for the use link

getNavLinkTree

protected Content getNavLinkTree()

Deprecated.

Get the tree link.

Overrides:

getNavLinkTree in class HtmlDocletWriter

Returns:

a content tree for the tree link