com.sun.tools.doclets.formats.html
Class ClassWriterImpl

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.formats.html.markup.HtmlWriter
              com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
                  com.sun.tools.doclets.formats.html.HtmlDocletWriter
                      com.sun.tools.doclets.formats.html.SubWriterHolderWriter
                          com.sun.tools.doclets.formats.html.ClassWriterImpl

All Implemented Interfaces:

ClassWriter, java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class ClassWriterImpl
extends SubWriterHolderWriter
implements ClassWriter

Generate the Class Information Page.

See Also:

ClassDoc, Collections, List, ArrayList, HashMap

Field Summary

protected ClassDoc	classDoc
protected ClassTree	classtree
protected ClassDoc	next
protected ClassDoc	prev

Fields inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

configuration, displayLength, filename, path, relativePath, relativepathNoSlash

Fields inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

ClassWriterImpl(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)

Method Summary

void	completeMemberSummaryBuild() Perform any operations that are necessary when the member summary finished building.
ClassDoc	getClassDoc() Return the classDoc being documented.
protected void	navDetailLinks() Method navDetailLinks
protected void	navGap()
protected void	navLinkClass() Print class page indicator
protected void	navLinkClassUse() Print class use link
protected void	navLinkNext() Print next package link
protected void	navLinkPackage() Print this package link
protected void	navLinkPrevious() Print previous package link
protected void	navLinkTree() Print "Tree" link in the navigation bar.
protected void	navSummaryLinks()
protected void	printSummaryDetailLinks() Do nothing.
void	writeClassDeprecationInfo() If this class is deprecated, write the appropriate information.
void	writeClassDescription() Build the class description.
private void	writeClassLinks(int context, java.util.List<?> list) Generate links to the given classes.
void	writeClassSignature(java.lang.String modifiers) Write the signature of the current class.
void	writeClassTagInfo() Write the tag information for the current class.
void	writeClassTree() Print the class hierarchy tree for this class only.
void	writeFooter() Write the footer of the page.
void	writeHeader(java.lang.String header) Write the header of the page.
void	writeImplementedInterfacesInfo() Write all implemented interfaces if this is a class.
void	writeInterfaceUsageInfo() If this is the interface which are the classes, that implement this?
void	writeNestedClassInfo() If this is an inner class or interface, write the enclosing class or interface.
private void	writeStep(int indent) Generate the indent and get the line image for the class tree.
void	writeSubClassInfo() Write all the classes that extend this one.
void	writeSubInterfacesInfo() Write all the interfaces that extend this one.
void	writeSuperInterfacesInfo() Write all super interfaces if this is an interface.
private int	writeTreeForClassHelper(Type type) Print the class hierarchy tree for the given class.
void	writeTypeParamInfo() Write the type parameter information.

Methods inherited from class com.sun.tools.doclets.formats.html.SubWriterHolderWriter

printIndexComment, printIndexComment, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMemberFooter, printMemberHeader, printSummaryFooter, printSummaryHeader, printSummaryLinkComment, printSummaryLinkComment, printSummaryLinkType, printTableHeadingBackground, printTypeSummaryFooter, printTypeSummaryHeader

Methods inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

anchor, commentTagsToString, configuration, frame, frameEnd, frameSet, frameSetEnd, getAnchor, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getTagletWriterInstance, getTypeParameterLinks, isClassLinkable, isCoreClass, italicsClassName, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navLinkClassIndex, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkPackage, navLinkPrevious, navLinks, navShowLists, navShowLists, navSummary, pathString, pathString, pathToClass, printBottom, printDocLink, printDocLink, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPreQualifiedClassLink, printPreQualifiedStrongClassLink, printQualifiedClassLink, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printTags, printTagsInfoFooter, printTagsInfoHeader, printTargetPackageLink, printText, printText, printText, printTop, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, seeTagToString, strongText, strongText, strongText, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, writeAnnotationInfo, writeAnnotationInfo, writeAnnotationInfo

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

getHyperLink, getHyperLink, getHyperLink, getHyperLink, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printFramesetHeader, printFramesetHeader, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPkgName, spaces, today

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontNoNewLine, fontSizeStyle, fontStyle, getCode, getCodeEnd, getFontColor, getFontEnd, getStrong, getStrongEnd, getWindowTitleOnload, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, hr, html, htmlEnd, img, italic, italicEnd, italics, italicsText, li, li, link, menu, menuEnd, noFrames, noFramesEnd, noScript, noScriptEnd, p, pEnd, pre, preEnd, preNoNewLine, printWinTitleScript, script, scriptEnd, space, strong, strong, strongEnd, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, thAlign, thAlignColspan, thAlignNowrap, thEnd, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.tools.doclets.internal.toolkit.ClassWriter

close

Field Detail

classDoc

protected ClassDoc classDoc

classtree

protected ClassTree classtree

prev

protected ClassDoc prev

next

protected ClassDoc next

Constructor Detail

ClassWriterImpl

public ClassWriterImpl(ClassDoc classDoc,
                       ClassDoc prevClass,
                       ClassDoc nextClass,
                       ClassTree classTree)
                throws java.lang.Exception

Parameters:

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:

java.lang.Exception

Method Detail

navLinkPackage

protected void navLinkPackage()

Print this package link

Overrides:

navLinkPackage in class HtmlDocletWriter

navLinkClass

protected void navLinkClass()

Print class page indicator

Overrides:

navLinkClass in class HtmlDocletWriter

navLinkClassUse

protected void navLinkClassUse()

Print class use link

Overrides:

navLinkClassUse in class HtmlDocletWriter

navLinkPrevious

protected void navLinkPrevious()

Print previous package link

Overrides:

navLinkPrevious in class HtmlDocletWriter

navLinkNext

protected void navLinkNext()

Print next package link

Overrides:

navLinkNext in class HtmlDocletWriter

writeHeader

public void writeHeader(java.lang.String header)

Write the header of the page.

Specified by:

writeHeader in interface ClassWriter

Parameters:

header - the header to write.

writeFooter

public void writeFooter()

Write the footer of the page.

Specified by:

writeFooter in interface ClassWriter

writeClassSignature

public void writeClassSignature(java.lang.String modifiers)

Write the signature of the current class.

Specified by:

writeClassSignature in interface ClassWriter

Parameters:

modifiers - the modifiers for the signature.

writeClassDescription

public void writeClassDescription()

Build the class description.

Specified by:

writeClassDescription in interface ClassWriter

writeClassTagInfo

public void writeClassTagInfo()

Write the tag information for the current class.

Specified by:

writeClassTagInfo in interface ClassWriter

writeClassDeprecationInfo

public void writeClassDeprecationInfo()

If this class is deprecated, write the appropriate information.

Specified by:

writeClassDeprecationInfo in interface ClassWriter

writeStep

private void writeStep(int indent)

Generate the indent and get the line image for the class tree. For user accessibility, the image includes the alt attribute "extended by". (This method is not intended for a class implementing an interface, where "implemented by" would be required.) indent integer indicating the number of spaces to indent

writeTreeForClassHelper

private int writeTreeForClassHelper(Type type)

Print the class hierarchy tree for the given class.

Parameters:

type - the class to print the hierarchy for.

Returns:

return the amount that should be indented in the next level of the tree.

writeClassTree

public void writeClassTree()

Print the class hierarchy tree for this class only.

Specified by:

writeClassTree in interface ClassWriter

writeTypeParamInfo

public void writeTypeParamInfo()

Write the type parameter information.

Specified by:

writeTypeParamInfo in interface ClassWriter

writeSubClassInfo

public void writeSubClassInfo()

Write all the classes that extend this one.

Specified by:

writeSubClassInfo in interface ClassWriter

writeSubInterfacesInfo

public void writeSubInterfacesInfo()

Write all the interfaces that extend this one.

Specified by:

writeSubInterfacesInfo in interface ClassWriter

writeInterfaceUsageInfo

public void writeInterfaceUsageInfo()

If this is the interface which are the classes, that implement this?

Specified by:

writeInterfaceUsageInfo in interface ClassWriter

writeImplementedInterfacesInfo

public void writeImplementedInterfacesInfo()

Write all implemented interfaces if this is a class.

Specified by:

writeImplementedInterfacesInfo in interface ClassWriter

writeSuperInterfacesInfo

public void writeSuperInterfacesInfo()

Write all super interfaces if this is an interface.

Specified by:

writeSuperInterfacesInfo in interface ClassWriter

writeClassLinks

private void writeClassLinks(int context,
                             java.util.List<?> list)

Generate links to the given classes.

navLinkTree

protected void navLinkTree()

Description copied from class: HtmlDocletWriter

Print "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:

navLinkTree in class HtmlDocletWriter

printSummaryDetailLinks

protected void printSummaryDetailLinks()

Description copied from class: HtmlDocletWriter

Do nothing. This is the default method.

Overrides:

printSummaryDetailLinks in class HtmlDocletWriter

navSummaryLinks

protected void navSummaryLinks()
                        throws java.lang.Exception

Throws:

java.lang.Exception

navDetailLinks

protected void navDetailLinks()
                       throws java.lang.Exception

Method navDetailLinks

Throws:

java.lang.Exception

navGap

protected void navGap()

writeNestedClassInfo

public void writeNestedClassInfo()

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

Specified by:

writeNestedClassInfo in interface ClassWriter

getClassDoc

public ClassDoc getClassDoc()

Return the classDoc being documented.

Specified by:

getClassDoc in interface ClassWriter

Returns:

the classDoc being documented.

completeMemberSummaryBuild

public void completeMemberSummaryBuild()

Perform any operations that are necessary when the member summary finished building.

Specified by:

completeMemberSummaryBuild in interface ClassWriter