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

public interface NestedClassWriter

The interface for writing class 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	writeInheritedNestedClassSummary(ClassDoc classDoc, ClassDoc nestedClass, boolean isFirst) Write the inherited nested class summary for the given class and nested class.
void	writeInheritedNestedClassSummaryFooter(ClassDoc nestedClass) Write the inherited classes summary footer for the given class.
void	writeInheritedNestedClassSummaryHeader(ClassDoc nestedClass) Write the inherited classes summary header for the given class.
void	writeNestedClassSummary(ClassDoc classDoc, ClassDoc nestedClass) Write the class summary for the given class and class.
void	writeNestedClassSummaryFooter(ClassDoc nestedClass) Write the classes summary footer for the given class.
void	writeNestedClassSummaryHeader(ClassDoc nestedClass) Write the classes summary header for the given class.

Method Detail

writeNestedClassSummaryHeader

void writeNestedClassSummaryHeader(ClassDoc nestedClass)

Write the classes summary header for the given class.

Parameters:

nestedClass - the class the summary belongs to.

writeNestedClassSummary

void writeNestedClassSummary(ClassDoc classDoc,
                             ClassDoc nestedClass)

Write the class summary for the given class and class.

Parameters:

classDoc - the class the summary belongs to.

nestedClass - the nested class that I am summarizing.

writeNestedClassSummaryFooter

void writeNestedClassSummaryFooter(ClassDoc nestedClass)

Write the classes summary footer for the given class.

Parameters:

nestedClass - the class the summary belongs to.

writeInheritedNestedClassSummaryHeader

void writeInheritedNestedClassSummaryHeader(ClassDoc nestedClass)

Write the inherited classes summary header for the given class.

Parameters:

nestedClass - the class the summary belongs to.

writeInheritedNestedClassSummary

void writeInheritedNestedClassSummary(ClassDoc classDoc,
                                      ClassDoc nestedClass,
                                      boolean isFirst)

Write the inherited nested class summary for the given class and nested class.

Parameters:

classDoc - the class the inherited nested class belongs to.

nestedClass - the inherited nested class that I am summarizing.

isFirst - true if this is the first member in the list.

writeInheritedNestedClassSummaryFooter

void writeInheritedNestedClassSummaryFooter(ClassDoc nestedClass)

Write the inherited classes summary footer for the given class.

Parameters:

nestedClass - the class the summary belongs to.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException