org.freehep.tools.doclet
Class AbstractPackageWriter

java.lang.Object
  |
  +--java.io.Writer
        |
        +--java.io.PrintWriter
              |
              +--com.sun.tools.doclets.HtmlWriter
                    |
                    +--com.sun.tools.doclets.HtmlDocWriter
                          |
                          +--org.freehep.tools.doclet.HtmlStandardWriter
                                |
                                +--org.freehep.tools.doclet.AbstractPackageWriter

Direct Known Subclasses:

PackageFrameWriter, PackageWriter

public abstract class AbstractPackageWriter

extends HtmlStandardWriter

Abstract class to generate file for each package contents. Sub-classed to generate specific formats Frame and Non-Frame Output by PackageIndexFrameWriter and PackageIndexFrameWriter respectively.

Author:

Atul M Dambalkar

Field Summary

protected Set

documentedClasses The classes to be documented.

Fields inherited from class org.freehep.tools.doclet.HtmlStandardWriter

backpath, checkedSoucePath, configuration, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, shouldCopyDocFiles

Fields inherited from class com.sun.tools.doclets.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

AbstractPackageWriter(ConfigurationStandard configuration, String path, String filename, com.sun.javadoc.PackageDoc packagedoc)
Create appropriate directory for the package and also initilise the relative path from this generated file to the current or the destination directory.

Method Summary

protected abstract void	generateClassListing()
protected void	generatePackageFile() Generate Individual Package File with Class/Interface/Exceptions and Error Listing with the appropriate links.
protected void	navLinkPackage() Highlight "Package" in the navigation bar, as this is the package page.
protected abstract void	printPackageDescription()
protected abstract void	printPackageFooter()
protected abstract void	printPackageHeader(String head)

Methods inherited from class org.freehep.tools.doclet.HtmlStandardWriter

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getNoFramesTargetHyperLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getTargetHyperLink, getText, getText, getText, getText, isCoreClass, isCrossClassIncluded, isGeneratedDoc, italicsClassName, msg, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, notice, notice, pathString, pathString, pathToClass, printBoldTargetHyperLink, printBottom, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLinkForSameDir, printDocLink, printDocLink, printHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineTags, replace, replaceDocRootDir, replaceInheritDoc, seeTagToString, serialClassInclude, serialDocInclude, serialInclude, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, warning, warning, warning

Methods inherited from class com.sun.tools.doclets.HtmlDocWriter

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

Methods inherited from class com.sun.tools.doclets.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontSizeStyle, fontStyle, genWriter, getBold, getBoldEnd, getCode, getCodeEnd, getFontColor, getFontEnd, getScriptCode, 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, p, pEnd, pre, preEnd, space, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

checkError, close, flush, print, print, print, print, print, print, print, print, print, 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

documentedClasses

protected Set documentedClasses

The classes to be documented. Use this to filter out classes that will not be documented.

Constructor Detail

AbstractPackageWriter

public AbstractPackageWriter(ConfigurationStandard configuration,
                             String path,
                             String filename,
                             com.sun.javadoc.PackageDoc packagedoc)
                      throws IOException

Create appropriate directory for the package and also initilise the relative path from this generated file to the current or the destination directory.

Parameters:

path - Directories in this path will be created if they are not already there.

filename - Name of the package summary file to be generated.

packagedoc - PackageDoc under consideration.

Throws:

com.sun.tools.doclets.DocletAbortException

IOException

Method Detail

generateClassListing

protected abstract void generateClassListing()

printPackageDescription

protected abstract void printPackageDescription()
                                         throws IOException

IOException

printPackageHeader

protected abstract void printPackageHeader(String head)

printPackageFooter

protected abstract void printPackageFooter()

generatePackageFile

protected void generatePackageFile()
                            throws IOException

Generate Individual Package File with Class/Interface/Exceptions and Error Listing with the appropriate links. Calls the methods from the sub-classes to generate the file contents.

IOException

navLinkPackage

protected void navLinkPackage()

Highlight "Package" in the navigation bar, as this is the package page.

Overrides:

navLinkPackage in class HtmlStandardWriter