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

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

Direct Known Subclasses:

AbstractExecutableMemberWriter, AnnotationTypeRequiredMemberWriterImpl, EnumConstantWriterImpl, FieldWriterImpl, NestedClassWriterImpl

public abstract class AbstractMemberWriter
extends java.lang.Object

The base class for member writers.

Field Summary

protected ClassDoc	classdoc
boolean	nodepr
protected boolean	printedSummaryHeader
protected SubWriterHolderWriter	writer

Constructor Summary

AbstractMemberWriter(SubWriterHolderWriter writer)

AbstractMemberWriter(SubWriterHolderWriter writer, ClassDoc classdoc)

Method Summary

ConfigurationImpl	configuration()
ProgramElementDoc[]	eligibleMembers(ProgramElementDoc[] members)
protected boolean	isInherited(ProgramElementDoc ped) Return true if the given ProgramElement is inherited by the class that is being documented.
protected java.lang.String	makeSpace(int len)
protected java.lang.String	modifierString(MemberDoc member) Return a string describing the access modifier flags.
protected java.lang.String	name(ProgramElementDoc member)
protected void	navDetailLink(java.util.List<?> members)
protected void	navSummaryLink(java.util.List<?> members, VisibleMemberMap visibleMemberMap)
protected void	print(char ch)
protected void	print(java.lang.String str)
protected void	printComment(ProgramElementDoc member)
protected void	printCommentAndTags(ProgramElementDoc member)
protected void	printDeprecatedAPI(java.util.List<Doc> deprmembers, java.lang.String headingKey) Generate the code for listing the deprecated APIs.
protected void	printFullComment(ProgramElementDoc member)
protected void	printHead(MemberDoc member)
abstract void	printInheritedSummaryAnchor(ClassDoc cd)
void	printInheritedSummaryFooter(ClassDoc cd) Forward to containing writer
void	printInheritedSummaryHeader(ClassDoc cd) Forward to containing writer
abstract void	printInheritedSummaryLabel(ClassDoc cd)
private void	printModifier(ProgramElementDoc member)
protected void	printModifierAndType(ProgramElementDoc member, Type type) Print the modifier and type for the member in the member summary.
protected void	printModifiers(MemberDoc member)
protected abstract void	printNavDetailLink(boolean link)
protected abstract void	printNavSummaryLink(ClassDoc cd, boolean link)
protected void	printStaticAndType(boolean isStatic, Type type) Print 'static' if static and type link.
abstract void	printSummaryAnchor(ClassDoc cd)
void	printSummaryFooter(ClassDoc cd) Forward to containing writer
void	printSummaryHeader(ClassDoc cd) Forward to containing writer
abstract void	printSummaryLabel(ClassDoc cd) abstracts
protected abstract void	printSummaryType(ProgramElementDoc member)
protected void	printUseInfo(java.util.List<? extends ProgramElementDoc> mems, java.lang.String heading) Print use info.
protected void	serialWarning(SourcePosition pos, java.lang.String key, java.lang.String a1, java.lang.String a2)
protected void	strong(java.lang.String str)
protected java.lang.String	typeString(MemberDoc member)
protected abstract void	writeDeprecatedLink(ProgramElementDoc member)
protected abstract void	writeInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member)
void	writeMemberSummary(ClassDoc classDoc, ProgramElementDoc member, Tag[] firstSentenceTags, boolean isFirst, boolean isLast)
protected void	writeSummaryLink(ClassDoc cd, ProgramElementDoc member)
protected abstract void	writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member)

Methods inherited from class java.lang.Object

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

Field Detail

printedSummaryHeader

protected boolean printedSummaryHeader

writer

protected final SubWriterHolderWriter writer

classdoc

protected final ClassDoc classdoc

nodepr

public final boolean nodepr

Constructor Detail

AbstractMemberWriter

public AbstractMemberWriter(SubWriterHolderWriter writer,
                            ClassDoc classdoc)

AbstractMemberWriter

public AbstractMemberWriter(SubWriterHolderWriter writer)

Method Detail

printSummaryLabel

public abstract void printSummaryLabel(ClassDoc cd)

abstracts

printInheritedSummaryLabel

public abstract void printInheritedSummaryLabel(ClassDoc cd)

printSummaryAnchor

public abstract void printSummaryAnchor(ClassDoc cd)

printInheritedSummaryAnchor

public abstract void printInheritedSummaryAnchor(ClassDoc cd)

printSummaryType

protected abstract void printSummaryType(ProgramElementDoc member)

writeSummaryLink

protected void writeSummaryLink(ClassDoc cd,
                                ProgramElementDoc member)

writeSummaryLink

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

writeInheritedSummaryLink

protected abstract void writeInheritedSummaryLink(ClassDoc cd,
                                                  ProgramElementDoc member)

writeDeprecatedLink

protected abstract void writeDeprecatedLink(ProgramElementDoc member)

printNavSummaryLink

protected abstract void printNavSummaryLink(ClassDoc cd,
                                            boolean link)

printNavDetailLink

protected abstract void printNavDetailLink(boolean link)

print

protected void print(java.lang.String str)

print

protected void print(char ch)

strong

protected void strong(java.lang.String str)

modifierString

protected java.lang.String modifierString(MemberDoc member)

Return a string describing the access modifier flags. Don't include native or synchronized. The modifier names are returned in canonical order, as specified by The Java Language Specification.

typeString

protected java.lang.String typeString(MemberDoc member)

printModifiers

protected void printModifiers(MemberDoc member)

makeSpace

protected java.lang.String makeSpace(int len)

printStaticAndType

protected void printStaticAndType(boolean isStatic,
                                  Type type)

Print 'static' if static and type link.

printModifierAndType

protected void printModifierAndType(ProgramElementDoc member,
                                    Type type)

Print the modifier and type for the member in the member summary.

Parameters:

member - the member to print the type for.

type - the type to print.

printModifier

private void printModifier(ProgramElementDoc member)

printComment

protected void printComment(ProgramElementDoc member)

name

protected java.lang.String name(ProgramElementDoc member)

printHead

protected void printHead(MemberDoc member)

printFullComment

protected void printFullComment(ProgramElementDoc member)

printCommentAndTags

protected void printCommentAndTags(ProgramElementDoc member)

printSummaryHeader

public void printSummaryHeader(ClassDoc cd)

Forward to containing writer

printInheritedSummaryHeader

public void printInheritedSummaryHeader(ClassDoc cd)

Forward to containing writer

printInheritedSummaryFooter

public void printInheritedSummaryFooter(ClassDoc cd)

Forward to containing writer

printSummaryFooter

public void printSummaryFooter(ClassDoc cd)

Forward to containing writer

isInherited

protected boolean isInherited(ProgramElementDoc ped)

Return true if the given ProgramElement is inherited by the class that is being documented.

Parameters:

ped - The ProgramElement being checked. return true if the ProgramElement is being inherited and false otherwise.

printDeprecatedAPI

protected void printDeprecatedAPI(java.util.List<Doc> deprmembers,
                                  java.lang.String headingKey)

Generate the code for listing the deprecated APIs. Create the table format for listing the API. Call methods from the sub-class to complete the generation.

printUseInfo

protected void printUseInfo(java.util.List<? extends ProgramElementDoc> mems,
                            java.lang.String heading)

Print use info.

navDetailLink

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

navSummaryLink

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

serialWarning

protected void serialWarning(SourcePosition pos,
                             java.lang.String key,
                             java.lang.String a1,
                             java.lang.String a2)

eligibleMembers

public ProgramElementDoc[] eligibleMembers(ProgramElementDoc[] members)

configuration

public ConfigurationImpl configuration()

writeMemberSummary

public void writeMemberSummary(ClassDoc classDoc,
                               ProgramElementDoc member,
                               Tag[] firstSentenceTags,
                               boolean isFirst,
                               boolean isLast)