org.freehep.tools.doclet
Class DeprecatedListWriter

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.SubWriterHolderWriter
                                      |
                                      +--org.freehep.tools.doclet.DeprecatedListWriter

public class DeprecatedListWriter

extends SubWriterHolderWriter

Generate File to list all the deprecated classes and class members with the appropriate links.

Author:

Atul M Dambalkar

See Also:

List

Field Summary

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

DeprecatedListWriter(ConfigurationStandard configuration, String filename)
Constructor.

Method Summary

static void	generate(ConfigurationStandard configuration) Get list of all the deprecated classes and members in all the Packages specified on the Command Line.
protected void	generateDeprecatedListFile(DeprecatedAPIListBuilder deprapi) Print the deprecated API list.
protected void	navLinkDeprecated() Highlight the word "Deprecated" in the navigation bar as this is the same page.
protected void	printDeprecatedFooter() Print the navigation bar and the footer for the deprecated API Listing.
protected void	printDeprecatedHeader() Print the navigation bar and header for the deprecated API Listing.

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

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

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, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, 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

Constructor Detail

DeprecatedListWriter

public DeprecatedListWriter(ConfigurationStandard configuration,
                            String filename)
                     throws IOException

Constructor.

Parameters:

filename - the file to be generated.

Method Detail

generate

public static void generate(ConfigurationStandard configuration)

Get list of all the deprecated classes and members in all the Packages specified on the Command Line. Then instantiate DeprecatedListWriter and generate File.

Throws:

com.sun.tools.doclets.DocletAbortException

generateDeprecatedListFile

protected void generateDeprecatedListFile(DeprecatedAPIListBuilder deprapi)
                                   throws IOException

Print the deprecated API list. Separately print all class kinds and member kinds.

Parameters:

deprapi - list of deprecated API built already.

IOException

printDeprecatedHeader

protected void printDeprecatedHeader()

Print the navigation bar and header for the deprecated API Listing.

printDeprecatedFooter

protected void printDeprecatedFooter()

Print the navigation bar and the footer for the deprecated API Listing.

navLinkDeprecated

protected void navLinkDeprecated()

Highlight the word "Deprecated" in the navigation bar as this is the same page.

Overrides:

navLinkDeprecated in class HtmlStandardWriter