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

All Known Implementing Classes:

ClassWriterImpl

public interface ClassWriter

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	completeMemberSummaryBuild() Perform any operations that are necessary when the member summary finished building.
ClassDoc	getClassDoc() Return the classDoc being documented.
void	writeClassDeprecationInfo() If this class is deprecated, write the appropriate information.
void	writeClassDescription() Build the class description.
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() Write the class tree documentation.
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 an interface, write all classes that implement this interface.
void	writeNestedClassInfo() If this is an inner class or interface, write the enclosing class or interface.
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.
void	writeTypeParamInfo() Write the type parameter information.

Method Detail

writeHeader

void writeHeader(java.lang.String header)

Write the header of the page.

Parameters:

header - the header to write.

writeClassTree

void writeClassTree()

Write the class tree documentation.

writeImplementedInterfacesInfo

void writeImplementedInterfacesInfo()

Write all implemented interfaces if this is a class.

writeSuperInterfacesInfo

void writeSuperInterfacesInfo()

Write all super interfaces if this is an interface.

writeTypeParamInfo

void writeTypeParamInfo()

Write the type parameter information.

writeSubClassInfo

void writeSubClassInfo()

Write all the classes that extend this one.

writeSubInterfacesInfo

void writeSubInterfacesInfo()

Write all the interfaces that extend this one.

writeInterfaceUsageInfo

void writeInterfaceUsageInfo()

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

writeNestedClassInfo

void writeNestedClassInfo()

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

writeClassDeprecationInfo

void writeClassDeprecationInfo()

If this class is deprecated, write the appropriate information.

writeClassSignature

void writeClassSignature(java.lang.String modifiers)

Write the signature of the current class.

Parameters:

modifiers - the modifiers for the signature.

writeClassDescription

void writeClassDescription()

Build the class description.

writeClassTagInfo

void writeClassTagInfo()

Write the tag information for the current class.

writeFooter

void writeFooter()

Write the footer of the page.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException

getClassDoc

ClassDoc getClassDoc()

Return the classDoc being documented.

Returns:

the classDoc being documented.

completeMemberSummaryBuild

void completeMemberSummaryBuild()

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