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

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.ClassUseWriter

All Implemented Interfaces:

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

public class ClassUseWriter
extends SubWriterHolderWriter

Generate class usage information.

Field Summary

(package private) ClassDoc	classdoc
(package private) NestedClassWriterImpl	classSubWriter
(package private) ConstructorWriterImpl	constrSubWriter
(package private) FieldWriterImpl	fieldSubWriter
(package private) MethodWriterImpl	methodSubWriter
(package private) java.util.SortedSet<PackageDoc>	pkgSet
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToClassAnnotations
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToClassTypeParameter
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToConstructorAnnotations
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToConstructorArgs
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToConstructorArgTypeParameter
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToConstructorParameterAnnotations
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToConstructorThrows
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToField
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToFieldAnnotations
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToFieldTypeParameter
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToImplementingClass
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToMethodAnnotations
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToMethodArgs
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToMethodArgTypeParameter
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToMethodParameterAnnotations
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToMethodReturn
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToMethodReturnTypeParameter
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToMethodThrows
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToMethodTypeParameter
(package private) java.util.Set<PackageDoc>	pkgToPackageAnnotations
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToSubclass
(package private) java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgToSubinterface

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

ClassUseWriter(ConfigurationImpl configuration, ClassUseMapper mapper, java.lang.String path, java.lang.String filename, java.lang.String relpath, ClassDoc classdoc)
Constructor.

Method Summary

static void	generate(ConfigurationImpl configuration, ClassTree classtree) Write out class use pages.
static void	generate(ConfigurationImpl configuration, ClassUseMapper mapper, ClassDoc classdoc) Generate a class page.
protected void	generateClassList()
protected void	generateClassUse()
protected void	generateClassUse(PackageDoc pkg) Print the class use list.
protected void	generateClassUseFile() Print the class use list.
protected void	generatePackageAnnotationList()
protected void	generatePackageList()
protected void	generatePackageUse(PackageDoc pkg) Print the package use list.
protected void	navLinkClass() Print class page indicator
protected void	navLinkClassUse() Print class use link
protected void	navLinkPackage() Print this package link
protected void	navLinkTree() Print "Tree" link in the navigation bar.
private java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>>	pkgDivide(java.util.Map<java.lang.String,? extends java.util.List<? extends ProgramElementDoc>> classMap)
protected void	printClassUseFooter() Print the footer for the class use Listing.
protected void	printClassUseHeader() 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, 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

classdoc

final ClassDoc classdoc

pkgToPackageAnnotations

java.util.Set<PackageDoc> pkgToPackageAnnotations

pkgToClassTypeParameter

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToClassTypeParameter

pkgToClassAnnotations

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToClassAnnotations

pkgToMethodTypeParameter

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToMethodTypeParameter

pkgToMethodArgTypeParameter

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToMethodArgTypeParameter

pkgToMethodReturnTypeParameter

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToMethodReturnTypeParameter

pkgToMethodAnnotations

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToMethodAnnotations

pkgToMethodParameterAnnotations

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToMethodParameterAnnotations

pkgToFieldTypeParameter

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToFieldTypeParameter

pkgToFieldAnnotations

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToFieldAnnotations

pkgToSubclass

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToSubclass

pkgToSubinterface

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToSubinterface

pkgToImplementingClass

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToImplementingClass

pkgToField

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToField

pkgToMethodReturn

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToMethodReturn

pkgToMethodArgs

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToMethodArgs

pkgToMethodThrows

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToMethodThrows

pkgToConstructorAnnotations

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToConstructorAnnotations

pkgToConstructorParameterAnnotations

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToConstructorParameterAnnotations

pkgToConstructorArgs

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToConstructorArgs

pkgToConstructorArgTypeParameter

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToConstructorArgTypeParameter

pkgToConstructorThrows

final java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgToConstructorThrows

pkgSet

final java.util.SortedSet<PackageDoc> pkgSet

methodSubWriter

final MethodWriterImpl methodSubWriter

constrSubWriter

final ConstructorWriterImpl constrSubWriter

fieldSubWriter

final FieldWriterImpl fieldSubWriter

classSubWriter

final NestedClassWriterImpl classSubWriter

Constructor Detail

ClassUseWriter

public ClassUseWriter(ConfigurationImpl configuration,
                      ClassUseMapper mapper,
                      java.lang.String path,
                      java.lang.String filename,
                      java.lang.String relpath,
                      ClassDoc classdoc)
               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,
                            ClassTree classtree)

Write out class use pages.

Throws:

DocletAbortException

pkgDivide

private java.util.Map<java.lang.String,java.util.List<ProgramElementDoc>> pkgDivide(java.util.Map<java.lang.String,? extends java.util.List<? extends ProgramElementDoc>> classMap)

generate

public static void generate(ConfigurationImpl configuration,
                            ClassUseMapper mapper,
                            ClassDoc classdoc)

Generate a class page.

generateClassUseFile

protected void generateClassUseFile()
                             throws java.io.IOException

Print the class use list.

Throws:

java.io.IOException

generateClassUse

protected void generateClassUse()
                         throws java.io.IOException

Throws:

java.io.IOException

generatePackageList

protected void generatePackageList()
                            throws java.io.IOException

Throws:

java.io.IOException

generatePackageAnnotationList

protected void generatePackageAnnotationList()
                                      throws java.io.IOException

Throws:

java.io.IOException

generateClassList

protected void generateClassList()
                          throws java.io.IOException

Throws:

java.io.IOException

generatePackageUse

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

Print the package use list.

Throws:

java.io.IOException

generateClassUse

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

Print the class use list.

Throws:

java.io.IOException

printClassUseHeader

protected void printClassUseHeader()

Print the header for the class use Listing.

printClassUseFooter

protected void printClassUseFooter()

Print the footer for the class use Listing.

navLinkPackage

protected void navLinkPackage()

Print this package link

Overrides:

navLinkPackage in class HtmlDocletWriter

navLinkClass

protected void navLinkClass()

Print class page indicator

Overrides:

navLinkClass 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