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

java.lang.Object
  com.sun.tools.doclets.formats.html.AbstractMemberWriter
      com.sun.tools.doclets.formats.html.EnumConstantWriterImpl

All Implemented Interfaces:

EnumConstantWriter, MemberSummaryWriter

public class EnumConstantWriterImpl
extends AbstractMemberWriter
implements EnumConstantWriter, MemberSummaryWriter

Writes enum constant documentation in HTML format.

Field Summary

private boolean

printedSummaryHeader

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

classdoc, nodepr, writer

Constructor Summary

EnumConstantWriterImpl(SubWriterHolderWriter writer)

EnumConstantWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc)

Method Summary

void	close() Close the writer.
int	getMemberKind()
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	writeComments(FieldDoc enumConstant) Write the comments for the given enum constant.
void	writeDeprecated(FieldDoc enumConstant) Write the deprecated output for the given enum constant.
protected void	writeDeprecatedLink(ProgramElementDoc member)
void	writeEnumConstantFooter() Write the enum constant footer.
void	writeEnumConstantHeader(FieldDoc enumConstant, boolean isFirst) Write the enum constant header for the given enum constant.
void	writeFooter(ClassDoc classDoc) Write the footer for the enum constant documentation.
void	writeHeader(ClassDoc classDoc, java.lang.String header) Write the header for the enum constant documentation.
void	writeInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc enumConstant, boolean isFirst, boolean isLast) Write the inherited member summary for the given class and member.
void	writeInheritedMemberSummaryFooter(ClassDoc classDoc) Write the inherited enum constant summary footer for the given class.
void	writeInheritedMemberSummaryHeader(ClassDoc classDoc) Write the inherited enum constant summary header for the given class.
protected void	writeInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member)
void	writeMemberSummaryFooter(ClassDoc classDoc) Write the enum constant summary footer for the given class.
void	writeMemberSummaryHeader(ClassDoc classDoc) Write the enum constant summary header for the given class.
void	writeSignature(FieldDoc enumConstant) Write the signature for the given enum constant.
protected void	writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member)
void	writeTags(FieldDoc enumConstant) Write the tag output for the given enum constant.

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

printedSummaryHeader

private boolean printedSummaryHeader

Constructor Detail

EnumConstantWriterImpl

public EnumConstantWriterImpl(SubWriterHolderWriter writer,
                              ClassDoc classdoc)

EnumConstantWriterImpl

public EnumConstantWriterImpl(SubWriterHolderWriter writer)

Method Detail

writeMemberSummaryHeader

public void writeMemberSummaryHeader(ClassDoc classDoc)

Write the enum constant 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 enum constant summary footer for the given class.

Specified by:

writeMemberSummaryFooter in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.

writeInheritedMemberSummaryHeader

public void writeInheritedMemberSummaryHeader(ClassDoc classDoc)

Write the inherited enum constant 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 enumConstant,
                                        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.

enumConstant - 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 enum constant summary footer for the given class.

Specified by:

writeInheritedMemberSummaryFooter 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 enum constant documentation.

Specified by:

writeHeader in interface EnumConstantWriter

Parameters:

classDoc - the class that the enum constants belong to.

header - the header to write.

writeEnumConstantHeader

public void writeEnumConstantHeader(FieldDoc enumConstant,
                                    boolean isFirst)

Write the enum constant header for the given enum constant.

Specified by:

writeEnumConstantHeader in interface EnumConstantWriter

Parameters:

enumConstant - the enum constant being documented.

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

writeSignature

public void writeSignature(FieldDoc enumConstant)

Write the signature for the given enum constant.

Specified by:

writeSignature in interface EnumConstantWriter

Parameters:

enumConstant - the enum constant being documented.

writeDeprecated

public void writeDeprecated(FieldDoc enumConstant)

Write the deprecated output for the given enum constant.

Specified by:

writeDeprecated in interface EnumConstantWriter

Parameters:

enumConstant - the enum constant being documented.

writeComments

public void writeComments(FieldDoc enumConstant)

Write the comments for the given enum constant.

Specified by:

writeComments in interface EnumConstantWriter

Parameters:

enumConstant - the enum constant being documented.

writeTags

public void writeTags(FieldDoc enumConstant)

Write the tag output for the given enum constant.

Specified by:

writeTags in interface EnumConstantWriter

Parameters:

enumConstant - the enum constant being documented.

writeEnumConstantFooter

public void writeEnumConstantFooter()

Write the enum constant footer.

Specified by:

writeEnumConstantFooter in interface EnumConstantWriter

writeFooter

public void writeFooter(ClassDoc classDoc)

Write the footer for the enum constant documentation.

Specified by:

writeFooter in interface EnumConstantWriter

Parameters:

classDoc - the class that the enum constant belong to.

close

public void close()
           throws java.io.IOException

Close the writer.

Specified by:

close in interface EnumConstantWriter

Specified by:

close in interface MemberSummaryWriter

Throws:

java.io.IOException

getMemberKind

public int getMemberKind()

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

writeSummaryLink

protected void writeSummaryLink(int context,
                                ClassDoc cd,
                                ProgramElementDoc member)

Specified by:

writeSummaryLink in class AbstractMemberWriter

writeInheritedSummaryLink

protected void writeInheritedSummaryLink(ClassDoc cd,
                                         ProgramElementDoc member)

Specified by:

writeInheritedSummaryLink in class AbstractMemberWriter

printSummaryType

protected void printSummaryType(ProgramElementDoc member)

Specified by:

printSummaryType in class AbstractMemberWriter

writeDeprecatedLink

protected void writeDeprecatedLink(ProgramElementDoc member)

Specified by:

writeDeprecatedLink in class AbstractMemberWriter

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