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.
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.
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final ClassDoc
Deprecated.(package private) final NestedClassWriterImpl
Deprecated.(package private) final String
Deprecated.(package private) final ConstructorWriterImpl
Deprecated.(package private) final String
Deprecated.(package private) final FieldWriterImpl
Deprecated.(package private) final String
Deprecated.protected HtmlTree
Deprecated.The HTML tree for main tag.(package private) final MethodWriterImpl
Deprecated.(package private) final String
Deprecated.(package private) final SortedSet<PackageDoc>
Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) Set<PackageDoc>
Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final Map<String,
List<ProgramElementDoc>> Deprecated.(package private) final String
Deprecated.(package private) final String
Deprecated.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
blockTags, configuration, 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
ConstructorsConstructorDescriptionClassUseWriter
(ConfigurationImpl configuration, ClassUseMapper mapper, DocPath filename, ClassDoc classdoc) Deprecated.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected 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
Deprecated.Generate the class use list.protected HtmlTree
Deprecated.Get the header for the class use Listing.protected Content
Deprecated.Get class page link.protected Content
Deprecated.Get the use link.protected Content
Deprecated.Get this package link.protected Content
Deprecated.Get the tree link.private Map<String,
List<ProgramElementDoc>> pkgDivide
(Map<String, ? extends List<? extends ProgramElementDoc>> classMap) Deprecated.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, 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 Details
-
classdoc
Deprecated. -
pkgToPackageAnnotations
Set<PackageDoc> pkgToPackageAnnotationsDeprecated. -
pkgToClassTypeParameter
Deprecated. -
pkgToClassAnnotations
Deprecated. -
pkgToMethodTypeParameter
Deprecated. -
pkgToMethodArgTypeParameter
Deprecated. -
pkgToMethodReturnTypeParameter
Deprecated. -
pkgToMethodAnnotations
Deprecated. -
pkgToMethodParameterAnnotations
Deprecated. -
pkgToFieldTypeParameter
Deprecated. -
pkgToFieldAnnotations
Deprecated. -
pkgToSubclass
Deprecated. -
pkgToSubinterface
Deprecated. -
pkgToImplementingClass
Deprecated. -
pkgToField
Deprecated. -
pkgToMethodReturn
Deprecated. -
pkgToMethodArgs
Deprecated. -
pkgToMethodThrows
Deprecated. -
pkgToConstructorAnnotations
Deprecated. -
pkgToConstructorParameterAnnotations
Deprecated. -
pkgToConstructorArgs
Deprecated. -
pkgToConstructorArgTypeParameter
Deprecated. -
pkgToConstructorThrows
Deprecated. -
pkgSet
Deprecated. -
methodSubWriter
Deprecated. -
constrSubWriter
Deprecated. -
fieldSubWriter
Deprecated. -
classSubWriter
Deprecated. -
classUseTableSummary
Deprecated. -
subclassUseTableSummary
Deprecated. -
subinterfaceUseTableSummary
Deprecated. -
fieldUseTableSummary
Deprecated. -
methodUseTableSummary
Deprecated. -
constructorUseTableSummary
Deprecated. -
mainTree
Deprecated.The HTML tree for main tag.
-
-
Constructor Details
-
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 Details
-
generate
Deprecated.Write out class use pages.- Throws:
DocletAbortException
-
pkgDivide
private Map<String,List<ProgramElementDoc>> pkgDivide(Map<String, ? extends List<? extends ProgramElementDoc>> classMap) Deprecated. -
generate
public static void generate(ConfigurationImpl configuration, ClassUseMapper mapper, ClassDoc classdoc) Deprecated.Generate a class page. -
generateClassUseFile
Deprecated.Generate the class use list.- Throws:
IOException
-
addClassUse
Deprecated.Add the class use documentation.- Parameters:
contentTree
- the content tree to which the class use information will be added- Throws:
IOException
-
addPackageList
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
Deprecated.Add the package annotation list.- Parameters:
contentTree
- the content tree to which the package annotation list will be added- Throws:
IOException
-
addClassList
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
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
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
Deprecated.Get the header for the class use Listing.- Returns:
- a content tree representing the class use header
-