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

java.lang.Object
  com.sun.tools.doclets.formats.html.AbstractMemberWriter
      com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter
          com.sun.tools.doclets.formats.html.ConstructorWriterImpl

All Implemented Interfaces:

ConstructorWriter, MemberSummaryWriter

public class ConstructorWriterImpl
extends AbstractExecutableMemberWriter
implements ConstructorWriter, MemberSummaryWriter

Writes constructor documentation.

Field Summary

private boolean	foundNonPubConstructor
private boolean	printedSummaryHeader

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

classdoc, nodepr, writer

Constructor Summary

ConstructorWriterImpl(SubWriterHolderWriter writer)
Construct a new ConstructorWriterImpl.

ConstructorWriterImpl(SubWriterHolderWriter writer, ClassDoc classDoc)
Construct a new ConstructorWriterImpl.

Method Summary

void	close() Close the writer.
int	getMemberKind()
protected void	navSummaryLink(java.util.List<?> members)
void	printInheritedSummaryAnchor(ClassDoc cd)
void	printInheritedSummaryLabel(ClassDoc cd)
protected void	printNavDetailLink(boolean link)
protected void	printNavSummaryLink(ClassDoc cd, boolean link)
void	printSummaryAnchor(ClassDoc cd)
void	printSummaryLabel(ClassDoc cd) abstracts
protected void	printSummaryType(ProgramElementDoc member)
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	writeInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc member, boolean isFirst, boolean isLast) Write the inherited member summary for the given class and member.
void	writeInheritedMemberSummaryFooter(ClassDoc classDoc) Write the inherited member summary footer for the given class.
void	writeInheritedMemberSummaryHeader(ClassDoc classDoc) Write the inherited member summary header for the given class.
void	writeMemberSummaryFooter(ClassDoc classDoc) Write the constructors summary footer for the given class.
void	writeMemberSummaryHeader(ClassDoc classDoc) Write the constructors summary header for the given class.
void	writeSignature(ConstructorDoc constructor) Write the signature for the given constructor.
void	writeTags(ConstructorDoc constructor) Write the tag output for the given constructor.

Methods inherited from class com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter

getErasureAnchor, getReturnTypeLength, implementsMethodInIntfac, writeDeprecatedLink, writeExceptions, writeInheritedSummaryLink, writeParam, writeParameters, writeParameters, writeSignature, writeSummaryLink, writeTypeParameters

Methods inherited from class com.sun.tools.doclets.formats.html.AbstractMemberWriter

configuration, eligibleMembers, isInherited, makeSpace, modifierString, name, navDetailLink, navSummaryLink, print, print, printComment, printCommentAndTags, printDeprecatedAPI, printFullComment, printHead, printInheritedSummaryFooter, printInheritedSummaryHeader, printModifierAndType, printModifiers, printStaticAndType, printSummaryFooter, printSummaryHeader, printUseInfo, serialWarning, strong, typeString, writeMemberSummary, writeSummaryLink

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

writeMemberSummary

Field Detail

foundNonPubConstructor

private boolean foundNonPubConstructor

printedSummaryHeader

private boolean printedSummaryHeader

Constructor Detail

ConstructorWriterImpl

public ConstructorWriterImpl(SubWriterHolderWriter writer,
                             ClassDoc classDoc)

Construct a new ConstructorWriterImpl.

Parameters:

writer - The writer for the class that the constructors belong to.

classDoc - the class being documented.

ConstructorWriterImpl

public ConstructorWriterImpl(SubWriterHolderWriter writer)

Construct a new ConstructorWriterImpl.

Parameters:

writer - The writer for the class that the constructors belong to.

Method Detail

writeMemberSummaryHeader

public void writeMemberSummaryHeader(ClassDoc classDoc)

Write the constructors summary header for the given class.

Specified by:

writeMemberSummaryHeader in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.

writeMemberSummaryFooter

public void writeMemberSummaryFooter(ClassDoc classDoc)

Write the constructors summary footer for the given class.

Specified by:

writeMemberSummaryFooter in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.

writeHeader

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

Write the header for the constructor documentation.

Specified by:

writeHeader in interface ConstructorWriter

Parameters:

classDoc - the class that the constructors belong to.

header - the header to write.

writeConstructorHeader

public void writeConstructorHeader(ConstructorDoc constructor,
                                   boolean isFirst)

Write the constructor header for the given constructor.

Specified by:

writeConstructorHeader in interface ConstructorWriter

Parameters:

constructor - the constructor being documented.

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

writeSignature

public void writeSignature(ConstructorDoc constructor)

Write the signature for the given constructor.

Specified by:

writeSignature in interface ConstructorWriter

Parameters:

constructor - the constructor being documented.

writeDeprecated

public void writeDeprecated(ConstructorDoc constructor)

Write the deprecated output for the given constructor.

Specified by:

writeDeprecated in interface ConstructorWriter

Parameters:

constructor - the constructor being documented.

writeComments

public void writeComments(ConstructorDoc constructor)

Write the comments for the given constructor.

Specified by:

writeComments in interface ConstructorWriter

Parameters:

constructor - the constructor being documented.

writeTags

public void writeTags(ConstructorDoc constructor)

Write the tag output for the given constructor.

Specified by:

writeTags in interface ConstructorWriter

Parameters:

constructor - the constructor being documented.

writeConstructorFooter

public void writeConstructorFooter()

Write the constructor footer.

Specified by:

writeConstructorFooter in interface ConstructorWriter

writeFooter

public void writeFooter(ClassDoc classDoc)

Write the footer for the constructor documentation.

Specified by:

writeFooter in interface ConstructorWriter

Parameters:

classDoc - the class that the constructors belong to.

close

public void close()
           throws java.io.IOException

Close the writer.

Specified by:

close in interface ConstructorWriter

Specified by:

close in interface MemberSummaryWriter

Throws:

java.io.IOException

setFoundNonPubConstructor

public void setFoundNonPubConstructor(boolean foundNonPubConstructor)

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

Specified by:

setFoundNonPubConstructor in interface ConstructorWriter

Parameters:

foundNonPubConstructor - true if we found a non public constructor.

printSummaryLabel

public void printSummaryLabel(ClassDoc cd)

Description copied from class: AbstractMemberWriter

abstracts

Specified by:

printSummaryLabel in class AbstractMemberWriter

printSummaryAnchor

public void printSummaryAnchor(ClassDoc cd)

Specified by:

printSummaryAnchor in class AbstractMemberWriter

printInheritedSummaryAnchor

public void printInheritedSummaryAnchor(ClassDoc cd)

Specified by:

printInheritedSummaryAnchor in class AbstractMemberWriter

printInheritedSummaryLabel

public void printInheritedSummaryLabel(ClassDoc cd)

Specified by:

printInheritedSummaryLabel in class AbstractMemberWriter

getMemberKind

public int getMemberKind()

navSummaryLink

protected void navSummaryLink(java.util.List<?> members)

printNavSummaryLink

protected void printNavSummaryLink(ClassDoc cd,
                                   boolean link)

Specified by:

printNavSummaryLink in class AbstractMemberWriter

printNavDetailLink

protected void printNavDetailLink(boolean link)

Specified by:

printNavDetailLink in class AbstractMemberWriter

printSummaryType

protected void printSummaryType(ProgramElementDoc member)

Specified by:

printSummaryType in class AbstractMemberWriter

writeInheritedMemberSummaryHeader

public void writeInheritedMemberSummaryHeader(ClassDoc classDoc)

Write the inherited member summary header for the given class.

Specified by:

writeInheritedMemberSummaryHeader in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.

writeInheritedMemberSummary

public void writeInheritedMemberSummary(ClassDoc classDoc,
                                        ProgramElementDoc member,
                                        boolean isFirst,
                                        boolean isLast)

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

Specified by:

writeInheritedMemberSummary in interface MemberSummaryWriter

Parameters:

classDoc - the class the inherited member belongs to.

member - the inherited member that I am summarizing.

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

isLast - true if this is the last member in the list.

writeInheritedMemberSummaryFooter

public void writeInheritedMemberSummaryFooter(ClassDoc classDoc)

Write the inherited member summary footer for the given class.

Specified by:

writeInheritedMemberSummaryFooter in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.