Class DeprecatedListWriter
- 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.DeprecatedListWriter
-
@Deprecated public class DeprecatedListWriter extends SubWriterHolderWriter
Deprecated.Generate File to list all the deprecated classes and class members with the appropriate links.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:
- Atul M Dambalkar, Bhavesh Patel (Modified)
- See Also:
List
-
-
Field Summary
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.SubWriterHolderWriter
mainTree
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
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 DeprecatedListWriter(ConfigurationImpl configuration, DocPath filename)
Deprecated.Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static void
generate(ConfigurationImpl configuration)
Deprecated.Get list of all the deprecated classes and members in all the Packages specified on the Command Line.protected void
generateDeprecatedListFile(DeprecatedAPIListBuilder deprapi)
Deprecated.Generate the deprecated API list.Content
getContentsList(DeprecatedAPIListBuilder deprapi)
Deprecated.Get the contents list.HtmlTree
getHeader()
Deprecated.Get the header for the deprecated API Listing.protected Content
getNavLinkDeprecated()
Deprecated.Get the deprecated label.-
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, getNavLinkClassUse, getNavLinkContents, getNavLinkHelp, getNavLinkIndex, getNavLinkMainTree, getNavLinkNext, getNavLinkNext, getNavLinkPackage, getNavLinkPackage, getNavLinkPrevious, getNavLinkPrevious, getNavLinkTree, 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
-
-
-
-
Constructor Detail
-
DeprecatedListWriter
public DeprecatedListWriter(ConfigurationImpl configuration, DocPath filename) throws IOException
Deprecated.Constructor.- Parameters:
filename
- the file to be generated.- Throws:
IOException
-
-
Method Detail
-
generate
public static void generate(ConfigurationImpl configuration)
Deprecated.Get list of all the deprecated classes and members in all the Packages specified on the Command Line. Then instantiate DeprecatedListWriter and generate File.- Parameters:
configuration
- the current configuration of the doclet.
-
generateDeprecatedListFile
protected void generateDeprecatedListFile(DeprecatedAPIListBuilder deprapi) throws IOException
Deprecated.Generate the deprecated API list.- Parameters:
deprapi
- list of deprecated API built already.- Throws:
IOException
-
getContentsList
public Content getContentsList(DeprecatedAPIListBuilder deprapi)
Deprecated.Get the contents list.- Parameters:
deprapi
- the deprecated list builder- Returns:
- a content tree for the contents list
-
getHeader
public HtmlTree getHeader()
Deprecated.Get the header for the deprecated API Listing.- Returns:
- a content tree for the header
-
getNavLinkDeprecated
protected Content getNavLinkDeprecated()
Deprecated.Get the deprecated label.- Overrides:
getNavLinkDeprecated
in classHtmlDocletWriter
- Returns:
- a content tree for the deprecated label
-
-