Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class ClassWriterImpl

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.ClassWriterImpl

All Implemented Interfaces:

ClassWriter

@Deprecated
public class ClassWriterImpl
extends SubWriterHolderWriter
implements ClassWriter

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 ClassDoc	classDoc	Deprecated.
protected ClassTree	classtree	Deprecated.
protected ClassDoc	next	Deprecated.
protected ClassDoc	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
ClassWriterImpl(ConfigurationImpl configuration, ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addClassDeprecationInfo(Content classInfoTree)	Deprecated. If this class is deprecated, add the appropriate information.
void	addClassDescription(Content classInfoTree)	Deprecated. Build the class description.
void	addClassSignature(String modifiers, Content classInfoTree)	Deprecated. Add the signature of the current class content tree.
void	addClassTagInfo(Content classInfoTree)	Deprecated. Add the tag information for the current class.
void	addClassTree(Content classContentTree)	Deprecated. Add the class tree documentation.
void	addFooter(Content contentTree)	Deprecated. Add the footer of the page.
void	addFunctionalInterfaceInfo(Content classInfoTree)	Deprecated. If this is an functional interface, display appropriate message.
void	addImplementedInterfacesInfo(Content classInfoTree)	Deprecated. Add all implemented interfaces if this is a class.
void	addInterfaceUsageInfo(Content classInfoTree)	Deprecated. If this is an interface, add all classes that implement this interface.
protected void	addNavGap(Content liNav)	Deprecated. Add gap between navigation bar elements.
void	addNestedClassInfo(Content classInfoTree)	Deprecated. If this is an inner class or interface, add the enclosing class or interface.
void	addSubClassInfo(Content classInfoTree)	Deprecated. Add all the classes that extend this one.
void	addSubInterfacesInfo(Content classInfoTree)	Deprecated. Add all the interfaces that extend this one.
protected void	addSummaryDetailLinks(Content subDiv)	Deprecated. Add summary details to the navigation bar.
void	addSuperInterfacesInfo(Content classInfoTree)	Deprecated. Add all super interfaces if this is an interface.
void	addTypeParamInfo(Content classInfoTree)	Deprecated. Add the type parameter information.
Content	getClassContentHeader()	Deprecated. Get the class content header.
ClassDoc	getClassDoc()	Deprecated. Return the classDoc being documented.
Content	getClassInfo(Content classInfoTree)	Deprecated. Get the class information.
Content	getClassInfoTreeHeader()	Deprecated. Get the class information tree header.
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.
boolean	isFunctionalInterface()	Deprecated.
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.ClassWriter

addClassContentTree, close, getMemberDetailsTree, getMemberSummaryTree, getMemberTreeHeader

Field Detail

classDoc

protected final ClassDoc classDoc

Deprecated.

classtree

protected final ClassTree classtree

Deprecated.

prev

protected final ClassDoc prev

Deprecated.

next

protected final ClassDoc next

Deprecated.

Constructor Detail

ClassWriterImpl

public ClassWriterImpl(ConfigurationImpl configuration,
                       ClassDoc classDoc,
                       ClassDoc prevClass,
                       ClassDoc nextClass,
                       ClassTree classTree)
                throws IOException

Deprecated.

Parameters:

configuration - the configuration data for the doclet

classDoc - the class being documented.

prevClass - the previous class that was documented.

nextClass - the next class being documented.

classTree - the class tree for the given class.

Throws:

IOException

Method Detail

getNavLinkPackage

protected Content getNavLinkPackage()

Deprecated.

Get this package link.

Overrides:

getNavLinkPackage in class HtmlDocletWriter

Returns:

a content tree for the package link

getNavLinkClass

protected Content getNavLinkClass()

Deprecated.

Get the class link.

Overrides:

getNavLinkClass in class HtmlDocletWriter

Returns:

a content tree for the class link

getNavLinkClassUse

protected Content getNavLinkClassUse()

Deprecated.

Get the class use link.

Overrides:

getNavLinkClassUse in class HtmlDocletWriter

Returns:

a content tree for the class use link

getNavLinkPrevious

public Content getNavLinkPrevious()

Deprecated.

Get link to previous class.

Overrides:

getNavLinkPrevious in class HtmlDocletWriter

Returns:

a content tree for the previous class link

getNavLinkNext

public Content getNavLinkNext()

Deprecated.

Get link to next class.

Overrides:

getNavLinkNext in class HtmlDocletWriter

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 interface ClassWriter

Parameters:

header - the header string to write

Returns:

header content that needs to be added to the documentation

getClassContentHeader

public Content getClassContentHeader()

Deprecated.

Get the class content header.

Specified by:

getClassContentHeader in interface ClassWriter

Returns:

class 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 interface ClassWriter

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 interface ClassWriter

Parameters:

contentTree - content tree that will be printed as a document

Throws:

IOException

getClassInfoTreeHeader

public Content getClassInfoTreeHeader()

Deprecated.

Get the class information tree header.

Specified by:

getClassInfoTreeHeader in interface ClassWriter

Returns:

class informaion tree header that needs to be added to the documentation

getClassInfo

public Content getClassInfo(Content classInfoTree)

Deprecated.

Get the class information.

Specified by:

getClassInfo in interface ClassWriter

Parameters:

classInfoTree - content tree conatining the class information

Returns:

a content tree for the class

addClassSignature

public void addClassSignature(String modifiers,
                              Content classInfoTree)

Deprecated.

Add the signature of the current class content tree.

Specified by:

addClassSignature in interface ClassWriter

Parameters:

modifiers - the modifiers for the signature

classInfoTree - the class content tree to which the signature will be added

addClassDescription

public void addClassDescription(Content classInfoTree)

Deprecated.

Build the class description.

Specified by:

addClassDescription in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

addClassTagInfo

public void addClassTagInfo(Content classInfoTree)

Deprecated.

Add the tag information for the current class.

Specified by:

addClassTagInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the tag information will be added

addClassTree

public void addClassTree(Content classContentTree)

Deprecated.

Add the class tree documentation.

Specified by:

addClassTree in interface ClassWriter

Parameters:

classContentTree - class content tree to which the documentation will be added

addTypeParamInfo

public void addTypeParamInfo(Content classInfoTree)

Deprecated.

Add the type parameter information.

Specified by:

addTypeParamInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

addSubClassInfo

public void addSubClassInfo(Content classInfoTree)

Deprecated.

Add all the classes that extend this one.

Specified by:

addSubClassInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

addSubInterfacesInfo

public void addSubInterfacesInfo(Content classInfoTree)

Deprecated.

Add all the interfaces that extend this one.

Specified by:

addSubInterfacesInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

addInterfaceUsageInfo

public void addInterfaceUsageInfo(Content classInfoTree)

Deprecated.

If this is an interface, add all classes that implement this interface.

Specified by:

addInterfaceUsageInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

addImplementedInterfacesInfo

public void addImplementedInterfacesInfo(Content classInfoTree)

Deprecated.

Add all implemented interfaces if this is a class.

Specified by:

addImplementedInterfacesInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

addSuperInterfacesInfo

public void addSuperInterfacesInfo(Content classInfoTree)

Deprecated.

Add all super interfaces if this is an interface.

Specified by:

addSuperInterfacesInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

addNestedClassInfo

public void addNestedClassInfo(Content classInfoTree)

Deprecated.

If this is an inner class or interface, add the enclosing class or interface.

Specified by:

addNestedClassInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

addFunctionalInterfaceInfo

public void addFunctionalInterfaceInfo(Content classInfoTree)

Deprecated.

If this is an functional interface, display appropriate message.

Specified by:

addFunctionalInterfaceInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation will be added

isFunctionalInterface

public boolean isFunctionalInterface()

Deprecated.

addClassDeprecationInfo

public void addClassDeprecationInfo(Content classInfoTree)

Deprecated.

If this class is deprecated, add the appropriate information.

Specified by:

addClassDeprecationInfo in interface ClassWriter

Parameters:

classInfoTree - content tree to which the documentation 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 class HtmlDocletWriter

Returns:

a content tree for the link

addSummaryDetailLinks

protected void addSummaryDetailLinks(Content subDiv)

Deprecated.

Add summary details to the navigation bar.

Overrides:

addSummaryDetailLinks in class HtmlDocletWriter

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

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

getClassDoc

public ClassDoc getClassDoc()

Deprecated.

Return the classDoc being documented.

Specified by:

getClassDoc in interface ClassWriter

Returns:

the classDoc being documented.