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.
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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String[]
Deprecated.private ConfigurationImpl
Deprecated.private static final String[]
Deprecated.private static final String[]
Deprecated.private static final String[]
Deprecated.private AbstractMemberWriter[]
Deprecated.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
blockTags, filename, fixedNavDiv, 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
ConstructorsConstructorDescriptionDeprecatedListWriter
(ConfigurationImpl configuration, DocPath filename) Deprecated.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addAnchor
(DeprecatedAPIListBuilder builder, int type, Content htmlTree) Deprecated.Add the anchor.private void
addIndexLink
(DeprecatedAPIListBuilder builder, int type, Content contentTree) Deprecated.Add the index link.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
Deprecated.Generate the deprecated API list.getContentsList
(DeprecatedAPIListBuilder deprapi) Deprecated.Get the contents list.Deprecated.Get the header for the deprecated API Listing.protected Content
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, check, 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
-
Field Details
-
ANCHORS
Deprecated. -
HEADING_KEYS
Deprecated. -
SUMMARY_KEYS
Deprecated. -
HEADER_KEYS
Deprecated. -
writers
Deprecated. -
configuration
Deprecated.
-
-
Constructor Details
-
DeprecatedListWriter
Deprecated.Constructor.- Parameters:
filename
- the file to be generated.- Throws:
IOException
-
-
Method Details
-
generate
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
Deprecated.Generate the deprecated API list.- Parameters:
deprapi
- list of deprecated API built already.- Throws:
IOException
-
addIndexLink
Deprecated.Add the index link.- Parameters:
builder
- the deprecated list buildertype
- the type of list being documentedcontentTree
- the content tree to which the index link will be added
-
getContentsList
Deprecated.Get the contents list.- Parameters:
deprapi
- the deprecated list builder- Returns:
- a content tree for the contents list
-
addAnchor
Deprecated.Add the anchor.- Parameters:
builder
- the deprecated list buildertype
- the type of list being documentedhtmlTree
- the content tree to which the anchor will be added
-
getHeader
Deprecated.Get the header for the deprecated API Listing.- Returns:
- a content tree for the header
-