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

All Known Implementing Classes:

ConstructorWriterImpl

public interface ConstructorWriter

The interface for writing constructor 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	setFoundNonPubConstructor(boolean foundNonPubConstructor) Let the writer know whether a non public constructor was found.
void	writeComments(ConstructorDoc constructor) Write the comments for the given constructor.
void	writeConstructorFooter() Write the constructor footer.
void	writeConstructorHeader(ConstructorDoc constructor, boolean isFirst) Write the constructor header for the given constructor.
void	writeDeprecated(ConstructorDoc constructor) Write the deprecated output for the given constructor.
void	writeFooter(ClassDoc classDoc) Write the footer for the constructor documentation.
void	writeHeader(ClassDoc classDoc, java.lang.String header) Write the header for the constructor documentation.
void	writeSignature(ConstructorDoc constructor) Write the signature for the given constructor.
void	writeTags(ConstructorDoc constructor) Write the tag output for the given constructor.

Method Detail

writeHeader

void writeHeader(ClassDoc classDoc,
                 java.lang.String header)

Write the header for the constructor documentation.

Parameters:

classDoc - the class that the constructors belong to.

header - the header to write.

writeConstructorHeader

void writeConstructorHeader(ConstructorDoc constructor,
                            boolean isFirst)

Write the constructor header for the given constructor.

Parameters:

constructor - the constructor being documented.

isFirst - the flag to indicate whether or not the constructor is the first to be documented.

writeSignature

void writeSignature(ConstructorDoc constructor)

Write the signature for the given constructor.

Parameters:

constructor - the constructor being documented.

writeDeprecated

void writeDeprecated(ConstructorDoc constructor)

Write the deprecated output for the given constructor.

Parameters:

constructor - the constructor being documented.

writeComments

void writeComments(ConstructorDoc constructor)

Write the comments for the given constructor.

Parameters:

constructor - the constructor being documented.

writeTags

void writeTags(ConstructorDoc constructor)

Write the tag output for the given constructor.

Parameters:

constructor - the constructor being documented.

writeConstructorFooter

void writeConstructorFooter()

Write the constructor footer.

writeFooter

void writeFooter(ClassDoc classDoc)

Write the footer for the constructor documentation.

Parameters:

classDoc - the class that the constructors belong to.

setFoundNonPubConstructor

void setFoundNonPubConstructor(boolean foundNonPubConstructor)

Let the writer know whether a non public constructor was found.

Parameters:

foundNonPubConstructor - true if we found a non public constructor.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException