Class ClassUseWriter
- 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.ClassUseWriter
-
@Deprecated public class ClassUseWriter extends SubWriterHolderWriter
Deprecated.Generate class usage information.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:
- Robert G. Field, Bhavesh Patel (Modified)
-
-
Field Summary
Fields Modifier and Type Field Description protected HtmlTree
mainTree
Deprecated.The HTML tree for main tag.-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
configuration, 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 ClassUseWriter(ConfigurationImpl configuration, ClassUseMapper mapper, DocPath filename, ClassDoc classdoc)
Deprecated.Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addClassList(Content contentTree)
Deprecated.Add the class list that use the given class.protected void
addClassUse(PackageDoc pkg, Content contentTree)
Deprecated.Add the class use information.protected void
addClassUse(Content contentTree)
Deprecated.Add the class use documentation.protected void
addPackageAnnotationList(Content contentTree)
Deprecated.Add the package annotation list.protected void
addPackageList(Content contentTree)
Deprecated.Add the packages list that use the given class.protected void
addPackageUse(PackageDoc pkg, Content contentTree)
Deprecated.Add the package use information.static void
generate(ConfigurationImpl configuration, ClassTree classtree)
Deprecated.Write out class use pages.static void
generate(ConfigurationImpl configuration, ClassUseMapper mapper, ClassDoc classdoc)
Deprecated.Generate a class page.protected void
generateClassUseFile()
Deprecated.Generate the class use list.protected HtmlTree
getClassUseHeader()
Deprecated.Get the header for the class use Listing.protected Content
getNavLinkClass()
Deprecated.Get class page link.protected Content
getNavLinkClassUse()
Deprecated.Get the use link.protected Content
getNavLinkPackage()
Deprecated.Get this package link.protected Content
getNavLinkTree()
Deprecated.Get the tree link.-
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, getNavLinkClassIndex, getNavLinkContents, getNavLinkDeprecated, getNavLinkHelp, getNavLinkIndex, getNavLinkMainTree, getNavLinkNext, getNavLinkNext, getNavLinkPackage, getNavLinkPrevious, getNavLinkPrevious, 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 Detail
-
mainTree
protected HtmlTree mainTree
Deprecated.The HTML tree for main tag.
-
-
Constructor Detail
-
ClassUseWriter
public ClassUseWriter(ConfigurationImpl configuration, ClassUseMapper mapper, DocPath filename, ClassDoc classdoc) throws IOException
Deprecated.Constructor.- Parameters:
filename
- the file to be generated.- Throws:
IOException
DocletAbortException
-
-
Method Detail
-
generate
public static void generate(ConfigurationImpl configuration, ClassTree classtree)
Deprecated.Write out class use pages.- Throws:
DocletAbortException
-
generate
public static void generate(ConfigurationImpl configuration, ClassUseMapper mapper, ClassDoc classdoc)
Deprecated.Generate a class page.
-
generateClassUseFile
protected void generateClassUseFile() throws IOException
Deprecated.Generate the class use list.- Throws:
IOException
-
addClassUse
protected void addClassUse(Content contentTree) throws IOException
Deprecated.Add the class use documentation.- Parameters:
contentTree
- the content tree to which the class use information will be added- Throws:
IOException
-
addPackageList
protected void addPackageList(Content contentTree) throws IOException
Deprecated.Add the packages list that use the given class.- Parameters:
contentTree
- the content tree to which the packages list will be added- Throws:
IOException
-
addPackageAnnotationList
protected void addPackageAnnotationList(Content contentTree) throws IOException
Deprecated.Add the package annotation list.- Parameters:
contentTree
- the content tree to which the package annotation list will be added- Throws:
IOException
-
addClassList
protected void addClassList(Content contentTree) throws IOException
Deprecated.Add the class list that use the given class.- Parameters:
contentTree
- the content tree to which the class list will be added- Throws:
IOException
-
addPackageUse
protected void addPackageUse(PackageDoc pkg, Content contentTree) throws IOException
Deprecated.Add the package use information.- Parameters:
pkg
- the package that uses the given classcontentTree
- the content tree to which the package use information will be added- Throws:
IOException
-
addClassUse
protected void addClassUse(PackageDoc pkg, Content contentTree) throws IOException
Deprecated.Add the class use information.- Parameters:
pkg
- the package that uses the given classcontentTree
- the content tree to which the class use information will be added- Throws:
IOException
-
getClassUseHeader
protected HtmlTree getClassUseHeader()
Deprecated.Get the header for the class use Listing.- Returns:
- a content tree representing the class use header
-
getNavLinkPackage
protected Content getNavLinkPackage()
Deprecated.Get this package link.- Overrides:
getNavLinkPackage
in classHtmlDocletWriter
- Returns:
- a content tree for the package link
-
getNavLinkClass
protected Content getNavLinkClass()
Deprecated.Get class page link.- Overrides:
getNavLinkClass
in classHtmlDocletWriter
- Returns:
- a content tree for the class page link
-
getNavLinkClassUse
protected Content getNavLinkClassUse()
Deprecated.Get the use link.- Overrides:
getNavLinkClassUse
in classHtmlDocletWriter
- Returns:
- a content tree for the use link
-
getNavLinkTree
protected Content getNavLinkTree()
Deprecated.Get the tree link.- Overrides:
getNavLinkTree
in classHtmlDocletWriter
- Returns:
- a content tree for the tree link
-
-