com.sun.tools.doclets.formats.html
Class PackageUseWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.formats.html.markup.HtmlWriter
              com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
                  com.sun.tools.doclets.formats.html.HtmlDocletWriter
                      com.sun.tools.doclets.formats.html.SubWriterHolderWriter
                          com.sun.tools.doclets.formats.html.PackageUseWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class PackageUseWriter
extends SubWriterHolderWriter

Generate package usage information.

Field Summary

(package private) PackageDoc	pkgdoc
(package private) java.util.SortedMap<java.lang.String,java.util.Set<ClassDoc>>	usingPackageToUsedClasses

Fields inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

configuration, displayLength, filename, path, relativePath, relativepathNoSlash

Fields inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

PackageUseWriter(ConfigurationImpl configuration, ClassUseMapper mapper, java.lang.String filename, PackageDoc pkgdoc)
Constructor.

Method Summary

static void	generate(ConfigurationImpl configuration, ClassUseMapper mapper, PackageDoc pkgdoc) Generate a class page.
protected void	generateClassList()
protected void	generatePackageList()
protected void	generatePackageUse() Print the class use list.
protected void	generatePackageUse(PackageDoc pkg) Print the package use list.
protected void	generatePackageUseFile() Print the class use list.
protected void	navLinkClassUse() Print class use link
protected void	navLinkPackage() Print this package link
protected void	navLinkTree() Print "Tree" link in the navigation bar.
protected void	printClassRow(ClassDoc usedClass, java.lang.String packageName)
protected void	printPackageUseFooter() Print the footer for the class use Listing.
protected void	printPackageUseHeader() Print the header for the class use Listing.

Methods inherited from class com.sun.tools.doclets.formats.html.SubWriterHolderWriter

printIndexComment, printIndexComment, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMemberFooter, printMemberHeader, printSummaryFooter, printSummaryHeader, printSummaryLinkComment, printSummaryLinkComment, printSummaryLinkType, printTableHeadingBackground, printTypeSummaryFooter, printTypeSummaryHeader

Methods inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

anchor, commentTagsToString, configuration, frame, frameEnd, frameSet, frameSetEnd, getAnchor, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getTagletWriterInstance, getTypeParameterLinks, isClassLinkable, isCoreClass, italicsClassName, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navLinkClass, navLinkClassIndex, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navShowLists, navShowLists, navSummary, pathString, pathString, pathToClass, printBottom, printDocLink, printDocLink, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPreQualifiedClassLink, printPreQualifiedStrongClassLink, printQualifiedClassLink, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTags, printTagsInfoFooter, printTagsInfoHeader, printTargetPackageLink, printText, printText, printText, printTop, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, seeTagToString, strongText, strongText, strongText, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, writeAnnotationInfo, writeAnnotationInfo, writeAnnotationInfo

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

getHyperLink, getHyperLink, getHyperLink, getHyperLink, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printFramesetHeader, printFramesetHeader, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPkgName, spaces, today

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontNoNewLine, fontSizeStyle, fontStyle, getCode, getCodeEnd, getFontColor, getFontEnd, getStrong, getStrongEnd, getWindowTitleOnload, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, hr, html, htmlEnd, img, italic, italicEnd, italics, italicsText, li, li, link, menu, menuEnd, noFrames, noFramesEnd, noScript, noScriptEnd, p, pEnd, pre, preEnd, preNoNewLine, printWinTitleScript, script, scriptEnd, space, strong, strong, strongEnd, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, thAlign, thAlignColspan, thAlignNowrap, thEnd, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

pkgdoc

final PackageDoc pkgdoc

usingPackageToUsedClasses

final java.util.SortedMap<java.lang.String,java.util.Set<ClassDoc>> usingPackageToUsedClasses

Constructor Detail

PackageUseWriter

public PackageUseWriter(ConfigurationImpl configuration,
                        ClassUseMapper mapper,
                        java.lang.String filename,
                        PackageDoc pkgdoc)
                 throws java.io.IOException

Constructor.

Parameters:

filename - the file to be generated.

Throws:

java.io.IOException

DocletAbortException

Method Detail

generate

public static void generate(ConfigurationImpl configuration,
                            ClassUseMapper mapper,
                            PackageDoc pkgdoc)

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 java.io.IOException

Print the class use list.

Throws:

java.io.IOException

generatePackageUse

protected void generatePackageUse()
                           throws java.io.IOException

Print the class use list.

Throws:

java.io.IOException

generatePackageList

protected void generatePackageList()
                            throws java.io.IOException

Throws:

java.io.IOException

generateClassList

protected void generateClassList()
                          throws java.io.IOException

Throws:

java.io.IOException

printClassRow

protected void printClassRow(ClassDoc usedClass,
                             java.lang.String packageName)

generatePackageUse

protected void generatePackageUse(PackageDoc pkg)
                           throws java.io.IOException

Print the package use list.

Throws:

java.io.IOException

printPackageUseHeader

protected void printPackageUseHeader()

Print the header for the class use Listing.

printPackageUseFooter

protected void printPackageUseFooter()

Print the footer for the class use Listing.

navLinkPackage

protected void navLinkPackage()

Print this package link

Overrides:

navLinkPackage in class HtmlDocletWriter

navLinkClassUse

protected void navLinkClassUse()

Print class use link

Overrides:

navLinkClassUse in class HtmlDocletWriter

navLinkTree

protected void navLinkTree()

Description copied from class: HtmlDocletWriter

Print "Tree" link in the navigation bar. If there is only one package specified on the command line, then the "Tree" link will be to the only "package-tree.html" file otherwise it will be to the "overview-tree.html" file.

Overrides:

navLinkTree in class HtmlDocletWriter