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

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

All Implemented Interfaces:

MemberSummaryWriter, MethodWriter

Direct Known Subclasses:

HtmlSerialMethodWriter

public class MethodWriterImpl
extends AbstractExecutableMemberWriter
implements MethodWriter, MemberSummaryWriter

Writes method 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

MethodWriterImpl(SubWriterHolderWriter writer)
Construct a new MethodWriterImpl.

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

Method Summary

void	close() Close the writer.
int	getMemberKind()
protected java.lang.String	parseCodeTag(java.lang.String tag) Parse the <Code> tag and return the text.
protected static void	printImplementsInfo(HtmlDocletWriter writer, MethodDoc method)
void	printInheritedSummaryAnchor(ClassDoc cd)
void	printInheritedSummaryLabel(ClassDoc cd)
protected void	printNavDetailLink(boolean link)
protected void	printNavSummaryLink(ClassDoc cd, boolean link)
protected static void	printOverridden(HtmlDocletWriter writer, Type overriddenType, MethodDoc method)
protected void	printReturnType(MethodDoc method)
void	printSummaryAnchor(ClassDoc cd)
void	printSummaryLabel(ClassDoc cd) abstracts
protected void	printSummaryType(ProgramElementDoc member)
void	writeComments(Type holder, MethodDoc method) Write the comments for the given method.
void	writeDeprecated(MethodDoc method) Write the deprecated output for the given method.
void	writeFooter(ClassDoc classDoc) Write the footer for the method documentation.
void	writeHeader(ClassDoc classDoc, java.lang.String header) Write the header for the method documentation.
void	writeInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc method, boolean isFirst, boolean isLast) Write the inherited member summary for the given class and member.
void	writeInheritedMemberSummaryFooter(ClassDoc classDoc) Write the inherited methods summary footer for the given class.
void	writeInheritedMemberSummaryHeader(ClassDoc classDoc) Write the inherited methods summary header for the given class.
void	writeMemberSummaryFooter(ClassDoc classDoc) Write the methods summary footer for the given class.
void	writeMemberSummaryHeader(ClassDoc classDoc) Write the methods summary header for the given class.
void	writeMethodFooter() Write the method footer.
void	writeMethodHeader(MethodDoc method, boolean isFirst) Write the method header for the given method.
void	writeSignature(MethodDoc method) Write the signature for the given method.
void	writeTags(MethodDoc method) Write the tag output for the given method.

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

printedSummaryHeader

private boolean printedSummaryHeader

Constructor Detail

MethodWriterImpl

public MethodWriterImpl(SubWriterHolderWriter writer,
                        ClassDoc classDoc)

Construct a new MethodWriterImpl.

Parameters:

writer - the writer for the class that the methods belong to.

classDoc - the class being documented.

MethodWriterImpl

public MethodWriterImpl(SubWriterHolderWriter writer)

Construct a new MethodWriterImpl.

Parameters:

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

Method Detail

writeMemberSummaryHeader

public void writeMemberSummaryHeader(ClassDoc classDoc)

Write the methods 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 methods 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 methods 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 method,
                                        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.

method - 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 methods 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 method documentation.

Specified by:

writeHeader in interface MethodWriter

Parameters:

classDoc - the class that the methods belong to.

header - the header to write.

writeMethodHeader

public void writeMethodHeader(MethodDoc method,
                              boolean isFirst)

Write the method header for the given method.

Specified by:

writeMethodHeader in interface MethodWriter

Parameters:

method - the method being documented.

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

writeSignature

public void writeSignature(MethodDoc method)

Write the signature for the given method.

Specified by:

writeSignature in interface MethodWriter

Parameters:

method - the method being documented.

writeDeprecated

public void writeDeprecated(MethodDoc method)

Write the deprecated output for the given method.

Specified by:

writeDeprecated in interface MethodWriter

Parameters:

method - the method being documented.

writeComments

public void writeComments(Type holder,
                          MethodDoc method)

Write the comments for the given method.

Specified by:

writeComments in interface MethodWriter

Parameters:

method - the method being documented.

holder - the holder type (not erasure) of the method.

writeTags

public void writeTags(MethodDoc method)

Write the tag output for the given method.

Specified by:

writeTags in interface MethodWriter

Parameters:

method - the method being documented.

writeMethodFooter

public void writeMethodFooter()

Write the method footer.

Specified by:

writeMethodFooter in interface MethodWriter

writeFooter

public void writeFooter(ClassDoc classDoc)

Write the footer for the method documentation.

Specified by:

writeFooter in interface MethodWriter

Parameters:

classDoc - the class that the methods belong to.

close

public void close()
           throws java.io.IOException

Close the writer.

Specified by:

close in interface MemberSummaryWriter

Specified by:

close in interface MethodWriter

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

printSummaryType

protected void printSummaryType(ProgramElementDoc member)

Specified by:

printSummaryType in class AbstractMemberWriter

printOverridden

protected static void printOverridden(HtmlDocletWriter writer,
                                      Type overriddenType,
                                      MethodDoc method)

parseCodeTag

protected java.lang.String parseCodeTag(java.lang.String tag)

Parse the <Code> tag and return the text.

printImplementsInfo

protected static void printImplementsInfo(HtmlDocletWriter writer,
                                          MethodDoc method)

printReturnType

protected void printReturnType(MethodDoc method)

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