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

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

All Implemented Interfaces:

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

public class ConstantsSummaryWriterImpl
extends HtmlDocletWriter
implements ConstantsSummaryWriter

Write the Constants Summary Page in HTML format.

Since:

1.4

Field Summary

(package private) ConfigurationImpl	configuration The configuration used in this run of the standard doclet.
private ClassDoc	currentClassDoc The current class being documented.

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

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

ConstantsSummaryWriterImpl(ConfigurationImpl configuration)
Construct a ConstantsSummaryWriter.

Method Summary

private void	tableFooter(boolean isHeader)
protected void	writeClassName(java.lang.String classStr) Print the class name in the table heading.
private void	writeConstantMember(FieldDoc member)
void	writeConstantMembers(ClassDoc cd, java.util.List<FieldDoc> fields) Document the given constants.
void	writeConstantMembersFooter(ClassDoc cd) Document the given constants.
void	writeConstantMembersHeader(ClassDoc cd) Write the heading for the current table of constants for a given class.
void	writeContentsFooter() Write the footer for the index.
void	writeContentsHeader() Write the header for the index.
void	writeFooter() Write the footer for the summary.
void	writeHeader() Write the header for the summary.
void	writeLinkToPackageContent(PackageDoc pkg, java.lang.String parsedPackageName, java.util.Set<java.lang.String> printedPackageHeaders) Add the given package name to the index.
private void	writeNameColumn(FieldDoc member)
void	writePackageName(PackageDoc pkg, java.lang.String parsedPackageName) Write the given package name.
private void	writeTypeColumn(FieldDoc member)
private void	writeValue(FieldDoc member)

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, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, 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, printSummaryDetailLinks, 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.ConstantsSummaryWriter

close

Field Detail

configuration

ConfigurationImpl configuration

The configuration used in this run of the standard doclet.

currentClassDoc

private ClassDoc currentClassDoc

The current class being documented.

Constructor Detail

ConstantsSummaryWriterImpl

public ConstantsSummaryWriterImpl(ConfigurationImpl configuration)
                           throws java.io.IOException

Construct a ConstantsSummaryWriter.

Parameters:

configuration - the configuration used in this run of the standard doclet.

Throws:

java.io.IOException

Method Detail

writeHeader

public void writeHeader()

Write the header for the summary.

Specified by:

writeHeader in interface ConstantsSummaryWriter

writeFooter

public void writeFooter()

Write the footer for the summary.

Specified by:

writeFooter in interface ConstantsSummaryWriter

writeContentsHeader

public void writeContentsHeader()

Write the header for the index.

Specified by:

writeContentsHeader in interface ConstantsSummaryWriter

writeContentsFooter

public void writeContentsFooter()

Write the footer for the index.

Specified by:

writeContentsFooter in interface ConstantsSummaryWriter

writeLinkToPackageContent

public void writeLinkToPackageContent(PackageDoc pkg,
                                      java.lang.String parsedPackageName,
                                      java.util.Set<java.lang.String> printedPackageHeaders)

Add the given package name to the index.

Specified by:

writeLinkToPackageContent in interface ConstantsSummaryWriter

Parameters:

pkg - the PackageDoc to index.

parsedPackageName - the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.

printedPackageHeaders - the set of package headers that have already been indexed. We don't want to index something more than once.

writeConstantMembersHeader

public void writeConstantMembersHeader(ClassDoc cd)

Write the heading for the current table of constants for a given class.

Specified by:

writeConstantMembersHeader in interface ConstantsSummaryWriter

Parameters:

cd - the class whose constants are being documented.

writeConstantMembersFooter

public void writeConstantMembersFooter(ClassDoc cd)

Document the given constants.

Specified by:

writeConstantMembersFooter in interface ConstantsSummaryWriter

Parameters:

cd - the class whose constants are being documented.

writeClassName

protected void writeClassName(java.lang.String classStr)

Print the class name in the table heading.

Parameters:

classStr - the heading to print.

tableFooter

private void tableFooter(boolean isHeader)

writePackageName

public void writePackageName(PackageDoc pkg,
                             java.lang.String parsedPackageName)

Write the given package name.

Specified by:

writePackageName in interface ConstantsSummaryWriter

Parameters:

pkg - the PackageDoc to index.

parsedPackageName - the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.

writeConstantMembers

public void writeConstantMembers(ClassDoc cd,
                                 java.util.List<FieldDoc> fields)

Document the given constants.

Specified by:

writeConstantMembers in interface ConstantsSummaryWriter

Parameters:

cd - the class whose constants are being documented.

fields - the constants being documented.

writeConstantMember

private void writeConstantMember(FieldDoc member)

writeTypeColumn

private void writeTypeColumn(FieldDoc member)

writeNameColumn

private void writeNameColumn(FieldDoc member)

writeValue

private void writeValue(FieldDoc member)