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

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

Direct Known Subclasses:

ConstructorWriterImpl, MethodWriterImpl

public abstract class AbstractExecutableMemberWriter
extends AbstractMemberWriter

Print method and constructor info.

Field Summary

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

classdoc, nodepr, printedSummaryHeader, writer

Constructor Summary

AbstractExecutableMemberWriter(SubWriterHolderWriter writer)

AbstractExecutableMemberWriter(SubWriterHolderWriter writer, ClassDoc classdoc)

Method Summary

protected java.lang.String	getErasureAnchor(ExecutableMemberDoc emd) For backward compatibility, include an anchor using the erasures of the parameters.
protected int	getReturnTypeLength(ExecutableMemberDoc member)
protected ClassDoc	implementsMethodInIntfac(MethodDoc method, ClassDoc[] intfacs)
protected void	writeDeprecatedLink(ProgramElementDoc member)
protected void	writeExceptions(ExecutableMemberDoc member)
protected void	writeInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member)
protected void	writeParam(ExecutableMemberDoc member, Parameter param, boolean isVarArg)
protected void	writeParameters(ExecutableMemberDoc member)
protected void	writeParameters(ExecutableMemberDoc member, boolean includeAnnotations)
protected void	writeSignature(ExecutableMemberDoc member)
protected void	writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member)
protected int	writeTypeParameters(ExecutableMemberDoc member) Write the type parameters for the executable member.

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, printInheritedSummaryAnchor, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryLabel, printModifierAndType, printModifiers, printNavDetailLink, printNavSummaryLink, printStaticAndType, printSummaryAnchor, printSummaryFooter, printSummaryHeader, printSummaryLabel, printSummaryType, printUseInfo, serialWarning, strong, typeString, writeMemberSummary, writeSummaryLink

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractExecutableMemberWriter

public AbstractExecutableMemberWriter(SubWriterHolderWriter writer,
                                      ClassDoc classdoc)

AbstractExecutableMemberWriter

public AbstractExecutableMemberWriter(SubWriterHolderWriter writer)

Method Detail

writeTypeParameters

protected int writeTypeParameters(ExecutableMemberDoc member)

Write the type parameters for the executable member.

Parameters:

member - the member to write type parameters for.

Returns:

the display length required to write this information.

writeSignature

protected void writeSignature(ExecutableMemberDoc member)

writeDeprecatedLink

protected void writeDeprecatedLink(ProgramElementDoc member)

Specified by:

writeDeprecatedLink 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

writeParam

protected void writeParam(ExecutableMemberDoc member,
                          Parameter param,
                          boolean isVarArg)

writeParameters

protected void writeParameters(ExecutableMemberDoc member)

writeParameters

protected void writeParameters(ExecutableMemberDoc member,
                               boolean includeAnnotations)

writeExceptions

protected void writeExceptions(ExecutableMemberDoc member)

getReturnTypeLength

protected int getReturnTypeLength(ExecutableMemberDoc member)

implementsMethodInIntfac

protected ClassDoc implementsMethodInIntfac(MethodDoc method,
                                            ClassDoc[] intfacs)

getErasureAnchor

protected java.lang.String getErasureAnchor(ExecutableMemberDoc emd)

For backward compatibility, include an anchor using the erasures of the parameters. NOTE: We won't need this method anymore after we fix see tags so that they use the type instead of the erasure.

Parameters:

emd - the ExecutableMemberDoc to anchor to.

Returns:

the 1.4.x style anchor for the ExecutableMemberDoc.