Class AnnotationTypeWriterImpl
- 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.AnnotationTypeWriterImpl
-
- All Implemented Interfaces:
AnnotationTypeWriter
@Deprecated public class AnnotationTypeWriterImpl extends SubWriterHolderWriter implements AnnotationTypeWriter
Deprecated.Generate the Class Information Page.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, Robert Field, Bhavesh Patel (Modified)
- See Also:
ClassDoc
,Collections
,List
,ArrayList
,HashMap
-
-
Field Summary
Fields Modifier and Type Field Description protected AnnotationTypeDoc
annotationType
Deprecated.protected Type
next
Deprecated.protected Type
prev
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
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 AnnotationTypeWriterImpl(ConfigurationImpl configuration, AnnotationTypeDoc annotationType, Type prevType, Type nextType)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addAnnotationTypeDeprecationInfo(Content annotationInfoTree)
Deprecated.If this annotation is deprecated, add the appropriate information.void
addAnnotationTypeDescription(Content annotationInfoTree)
Deprecated.Build the annotation type description.void
addAnnotationTypeSignature(String modifiers, Content annotationInfoTree)
Deprecated.Add the signature of the current annotation type.void
addAnnotationTypeTagInfo(Content annotationInfoTree)
Deprecated.Add the tag information for the current annotation type.void
addFooter(Content contentTree)
Deprecated.Add the footer of the page.protected void
addNavGap(Content liNav)
Deprecated.Add gap between navigation bar elements.protected void
addNavSummaryLink(MemberSummaryBuilder builder, String label, int type, Content liNav)
Deprecated.Add the navigation summary link.protected void
addSummaryDetailLinks(Content subDiv)
Deprecated.Add summary details to the navigation bar.Content
getAnnotationContentHeader()
Deprecated.Get the annotation content header.Content
getAnnotationInfo(Content annotationInfoTree)
Deprecated.Get the annotation information.Content
getAnnotationInfoTreeHeader()
Deprecated.Get the annotation information tree header.AnnotationTypeDoc
getAnnotationTypeDoc()
Deprecated.Return theAnnotationTypeDoc
being documented.Content
getHeader(String header)
Deprecated.Get the header of the page.protected Content
getNavDetailLinks()
Deprecated.Get detail links for the navigation bar.protected Content
getNavLinkClass()
Deprecated.Get the class link.protected Content
getNavLinkClassUse()
Deprecated.Get the class use link.Content
getNavLinkNext()
Deprecated.Get link to next class.protected Content
getNavLinkPackage()
Deprecated.Get this package link.Content
getNavLinkPrevious()
Deprecated.Get link to previous class.protected Content
getNavLinkTree()
Deprecated.Get "Tree" link in the navigation bar.protected Content
getNavSummaryLinks()
Deprecated.Get summary links for navigation bar.void
printDocument(Content contentTree)
Deprecated.Print the document.-
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, 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, getNavLinkPackage, 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
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.AnnotationTypeWriter
addAnnotationContentTree, close, getMemberDetailsTree, getMemberSummaryTree, getMemberTree, getMemberTreeHeader
-
-
-
-
Field Detail
-
annotationType
protected AnnotationTypeDoc annotationType
Deprecated.
-
prev
protected Type prev
Deprecated.
-
next
protected Type next
Deprecated.
-
-
Constructor Detail
-
AnnotationTypeWriterImpl
public AnnotationTypeWriterImpl(ConfigurationImpl configuration, AnnotationTypeDoc annotationType, Type prevType, Type nextType) throws Exception
Deprecated.- Parameters:
annotationType
- the annotation type being documented.prevType
- the previous class that was documented.nextType
- the next class being documented.- Throws:
Exception
-
-
Method Detail
-
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 the class link.- Overrides:
getNavLinkClass
in classHtmlDocletWriter
- Returns:
- a content tree for the class link
-
getNavLinkClassUse
protected Content getNavLinkClassUse()
Deprecated.Get the class use link.- Overrides:
getNavLinkClassUse
in classHtmlDocletWriter
- Returns:
- a content tree for the class use link
-
getNavLinkPrevious
public Content getNavLinkPrevious()
Deprecated.Get link to previous class.- Overrides:
getNavLinkPrevious
in classHtmlDocletWriter
- Returns:
- a content tree for the previous class link
-
getNavLinkNext
public Content getNavLinkNext()
Deprecated.Get link to next class.- Overrides:
getNavLinkNext
in classHtmlDocletWriter
- Returns:
- a content tree for the next class link
-
getHeader
public Content getHeader(String header)
Deprecated.Get the header of the page.- Specified by:
getHeader
in interfaceAnnotationTypeWriter
- Parameters:
header
- the header string to write- Returns:
- a content tree for the header documentation
-
getAnnotationContentHeader
public Content getAnnotationContentHeader()
Deprecated.Get the annotation content header.- Specified by:
getAnnotationContentHeader
in interfaceAnnotationTypeWriter
- Returns:
- annotation content header that needs to be added to the documentation
-
addFooter
public void addFooter(Content contentTree)
Deprecated.Add the footer of the page.- Specified by:
addFooter
in interfaceAnnotationTypeWriter
- Parameters:
contentTree
- content tree to which the footer will be added
-
printDocument
public void printDocument(Content contentTree) throws IOException
Deprecated.Print the document.- Specified by:
printDocument
in interfaceAnnotationTypeWriter
- Parameters:
contentTree
- content tree that will be printed as a document- Throws:
IOException
-
getAnnotationInfoTreeHeader
public Content getAnnotationInfoTreeHeader()
Deprecated.Get the annotation information tree header.- Specified by:
getAnnotationInfoTreeHeader
in interfaceAnnotationTypeWriter
- Returns:
- annotation information tree header that needs to be added to the documentation
-
getAnnotationInfo
public Content getAnnotationInfo(Content annotationInfoTree)
Deprecated.Get the annotation information.- Specified by:
getAnnotationInfo
in interfaceAnnotationTypeWriter
- Parameters:
annotationInfoTree
- content tree containing the annotation information- Returns:
- a content tree for the annotation
-
addAnnotationTypeSignature
public void addAnnotationTypeSignature(String modifiers, Content annotationInfoTree)
Deprecated.Add the signature of the current annotation type.- Specified by:
addAnnotationTypeSignature
in interfaceAnnotationTypeWriter
- Parameters:
modifiers
- the modifiers for the signatureannotationInfoTree
- the annotation content tree to which the signature will be added
-
addAnnotationTypeDescription
public void addAnnotationTypeDescription(Content annotationInfoTree)
Deprecated.Build the annotation type description.- Specified by:
addAnnotationTypeDescription
in interfaceAnnotationTypeWriter
- Parameters:
annotationInfoTree
- content tree to which the description will be added
-
addAnnotationTypeTagInfo
public void addAnnotationTypeTagInfo(Content annotationInfoTree)
Deprecated.Add the tag information for the current annotation type.- Specified by:
addAnnotationTypeTagInfo
in interfaceAnnotationTypeWriter
- Parameters:
annotationInfoTree
- content tree to which the tag information will be added
-
addAnnotationTypeDeprecationInfo
public void addAnnotationTypeDeprecationInfo(Content annotationInfoTree)
Deprecated.If this annotation is deprecated, add the appropriate information.- Specified by:
addAnnotationTypeDeprecationInfo
in interfaceAnnotationTypeWriter
- Parameters:
annotationInfoTree
- content tree to which the deprecated information will be added
-
getNavLinkTree
protected Content getNavLinkTree()
Deprecated.Get "Tree" link in the navigation bar. If there is only one package specified on the command line, then the "Tree" link will be to the only "package-tree.html" file otherwise it will be to the "overview-tree.html" file.- Overrides:
getNavLinkTree
in classHtmlDocletWriter
- Returns:
- a content tree for the link
-
addSummaryDetailLinks
protected void addSummaryDetailLinks(Content subDiv)
Deprecated.Add summary details to the navigation bar.- Overrides:
addSummaryDetailLinks
in classHtmlDocletWriter
- Parameters:
subDiv
- the content tree to which the summary detail links will be added
-
getNavSummaryLinks
protected Content getNavSummaryLinks() throws Exception
Deprecated.Get summary links for navigation bar.- Returns:
- the content tree for the navigation summary links
- Throws:
Exception
-
addNavSummaryLink
protected void addNavSummaryLink(MemberSummaryBuilder builder, String label, int type, Content liNav)
Deprecated.Add the navigation summary link.- Parameters:
builder
- builder for the member to be documentedlabel
- the label for the navigationtype
- type to be documentedliNav
- the content tree to which the navigation summary link will be added
-
getNavDetailLinks
protected Content getNavDetailLinks() throws Exception
Deprecated.Get detail links for the navigation bar.- Returns:
- the content tree for the detail links
- Throws:
Exception
-
addNavGap
protected void addNavGap(Content liNav)
Deprecated.Add gap between navigation bar elements.- Parameters:
liNav
- the content tree to which the gap will be added
-
getAnnotationTypeDoc
public AnnotationTypeDoc getAnnotationTypeDoc()
Deprecated.Return theAnnotationTypeDoc
being documented.- Specified by:
getAnnotationTypeDoc
in interfaceAnnotationTypeWriter
- Returns:
- the AnnotationTypeDoc being documented.
-
-