com.sun.tools.doclets.internal.toolkit
Interface ConstantsSummaryWriter

All Known Implementing Classes:

ConstantsSummaryWriterImpl

public interface ConstantsSummaryWriter

The interface for writing constants summary output. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API

Since:

1.5

Method Summary

void	close() Close the writer.
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> WriteedPackageHeaders) Add the given package name to the index.
void	writePackageName(PackageDoc pkg, java.lang.String parsedPackageName) Write the given package name.

Method Detail

writeHeader

void writeHeader()

Write the header for the summary.

writeFooter

void writeFooter()

Write the footer for the summary.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException

writeContentsHeader

void writeContentsHeader()

Write the header for the index.

writeContentsFooter

void writeContentsFooter()

Write the footer for the index.

writeLinkToPackageContent

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

Add the given package name to the index.

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

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

writePackageName

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

Write the given package name.

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

writeConstantMembersHeader

void writeConstantMembersHeader(ClassDoc cd)

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

Parameters:

cd - the class whose constants are being documented.

writeConstantMembers

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

Document the given constants.

Parameters:

cd - the class whose constants are being documented.

fields - the constants being documented.

writeConstantMembersFooter

void writeConstantMembersFooter(ClassDoc cd)

Document the given constants.

Parameters:

cd - the class whose constants are being documented.