org.freehep.tools.doclet
Class AbstractSubWriter

java.lang.Object
  org.freehep.tools.doclet.AbstractSubWriter

Direct Known Subclasses:

ClassSubWriter, ExecutableMemberSubWriter, FieldSubWriter

public abstract class AbstractSubWriter

extends Object

Author:

Robert Field, Atul M Dambalkar

Source Code:

AbstractSubWriter.java

Field Summary

protected com.sun.javadoc.ClassDoc	classdoc
boolean	nodepr
protected boolean	printedSummaryHeader
List	visibleClasses
com.sun.tools.doclets.VisibleMemberMap	visibleMemberMap
protected SubWriterHolderWriter	writer

Constructor Summary

AbstractSubWriter(SubWriterHolderWriter writer)

AbstractSubWriter(SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc)

Method Summary

protected void	bold(String str)
void	buildVisibleMemberMap()
ConfigurationStandard	configuration()
com.sun.javadoc.ProgramElementDoc[]	eligibleMembers(com.sun.javadoc.ProgramElementDoc[] members)
abstract int	getMemberKind() abstracts
protected boolean	isInherited(com.sun.javadoc.ProgramElementDoc ped) Return true if the given ProgramElement is inherited by the class that is being documented.
protected String	makeSpace(int len)
List	members(com.sun.javadoc.ClassDoc cd)
protected String	modifierString(com.sun.javadoc.MemberDoc member) Return a string describing the access modifier flags.
com.sun.tools.doclets.MessageRetriever	msg()
protected String	name(com.sun.javadoc.ProgramElementDoc member)
protected void	navDetailLink()
protected void	navSummaryLink()
protected void	print(char ch)
protected void	print(String str)
protected abstract void	printBodyHtmlEnd(com.sun.javadoc.ClassDoc cd)
protected void	printComment(com.sun.javadoc.ProgramElementDoc member)
protected void	printCommentAndTags(com.sun.javadoc.ProgramElementDoc member)
protected void	printDeprecated(com.sun.javadoc.ProgramElementDoc member)
protected void	printDeprecatedAPI(List deprmembers, String headingKey) Generate the code for listing the deprecated APIs.
protected void	printDeprecatedClassComment(com.sun.javadoc.ProgramElementDoc member)
protected abstract void	printDeprecatedLink(com.sun.javadoc.ProgramElementDoc member)
protected void	printFullComment(com.sun.javadoc.ProgramElementDoc member)
protected void	printHead(com.sun.javadoc.MemberDoc member)
protected abstract void	printHeader(com.sun.javadoc.ClassDoc cd)
void	printInheritedMembersSummary()
abstract void	printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc cd)
void	printInheritedSummaryFooter(com.sun.javadoc.ClassDoc cd) Forward to containing writer
void	printInheritedSummaryHeader(com.sun.javadoc.ClassDoc cd) Forward to containing writer
abstract void	printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)
protected abstract void	printInheritedSummaryLink(com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)
void	printInheritedSummaryMember(com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member) Forward to containing writer
protected abstract void	printMember(com.sun.javadoc.ProgramElementDoc elem)
void	printMembers()
void	printMembersSummary()
protected void	printModifier(com.sun.javadoc.ProgramElementDoc member)
protected void	printModifierAndType(com.sun.javadoc.ProgramElementDoc member, com.sun.javadoc.Type type)
protected void	printModifiers(com.sun.javadoc.MemberDoc member)
protected abstract void	printNavDetailLink(boolean link)
protected abstract void	printNavSummaryLink(com.sun.javadoc.ClassDoc cd, boolean link)
protected void	printStaticAndType(boolean isStatic, com.sun.javadoc.Type type) Print 'static' if static and type link.
abstract void	printSummaryAnchor(com.sun.javadoc.ClassDoc cd)
void	printSummaryFooter(com.sun.javadoc.ClassDoc cd) Forward to containing writer
void	printSummaryHeader(com.sun.javadoc.ClassDoc cd) Forward to containing writer
abstract void	printSummaryLabel(com.sun.javadoc.ClassDoc cd)
protected abstract void	printSummaryLink(com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)
void	printSummaryMember(com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member) Forward to containing writer
protected abstract void	printSummaryType(com.sun.javadoc.ProgramElementDoc member)
protected void	printTags(com.sun.javadoc.ProgramElementDoc member)
protected void	printTypedName(com.sun.javadoc.Type type, String name)
protected void	printTypeLink(com.sun.javadoc.Type type)
protected void	printTypeLinkNoDimension(com.sun.javadoc.Type type)
protected void	printUseInfo(Object mems, String heading) Print use info.
protected void	serialWarning(com.sun.javadoc.SourcePosition pos, String key, String a1, String a2)
protected String	typeString(com.sun.javadoc.MemberDoc 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 com.sun.javadoc.ClassDoc classdoc

nodepr

public final boolean nodepr

visibleMemberMap

public com.sun.tools.doclets.VisibleMemberMap visibleMemberMap

visibleClasses

public List visibleClasses

Constructor Detail

AbstractSubWriter

public AbstractSubWriter(SubWriterHolderWriter writer,
                         com.sun.javadoc.ClassDoc classdoc)

AbstractSubWriter

public AbstractSubWriter(SubWriterHolderWriter writer)

Method Detail

getMemberKind

public abstract int getMemberKind()

abstracts

printSummaryLabel

public abstract void printSummaryLabel(com.sun.javadoc.ClassDoc cd)

printInheritedSummaryLabel

public abstract void printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)

printSummaryAnchor

public abstract void printSummaryAnchor(com.sun.javadoc.ClassDoc cd)

printInheritedSummaryAnchor

public abstract void printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc cd)

printSummaryType

protected abstract void printSummaryType(com.sun.javadoc.ProgramElementDoc member)

printSummaryLink

protected abstract void printSummaryLink(com.sun.javadoc.ClassDoc cd,
                                         com.sun.javadoc.ProgramElementDoc member)

printInheritedSummaryLink

protected abstract void printInheritedSummaryLink(com.sun.javadoc.ClassDoc cd,
                                                  com.sun.javadoc.ProgramElementDoc member)

printHeader

protected abstract void printHeader(com.sun.javadoc.ClassDoc cd)

printBodyHtmlEnd

protected abstract void printBodyHtmlEnd(com.sun.javadoc.ClassDoc cd)

printMember

protected abstract void printMember(com.sun.javadoc.ProgramElementDoc elem)

printDeprecatedLink

protected abstract void printDeprecatedLink(com.sun.javadoc.ProgramElementDoc member)

printNavSummaryLink

protected abstract void printNavSummaryLink(com.sun.javadoc.ClassDoc cd,
                                            boolean link)

printNavDetailLink

protected abstract void printNavDetailLink(boolean link)

print

protected void print(String str)

print

protected void print(char ch)

bold

protected void bold(String str)

printTypeLinkNoDimension

protected void printTypeLinkNoDimension(com.sun.javadoc.Type type)

printTypeLink

protected void printTypeLink(com.sun.javadoc.Type type)

modifierString

protected String modifierString(com.sun.javadoc.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 String typeString(com.sun.javadoc.MemberDoc member)

printModifiers

protected void printModifiers(com.sun.javadoc.MemberDoc member)

printTypedName

protected void printTypedName(com.sun.javadoc.Type type,
                              String name)

makeSpace

protected String makeSpace(int len)

printStaticAndType

protected void printStaticAndType(boolean isStatic,
                                  com.sun.javadoc.Type type)

Print 'static' if static and type link.

printModifierAndType

protected void printModifierAndType(com.sun.javadoc.ProgramElementDoc member,
                                    com.sun.javadoc.Type type)

printModifier

protected void printModifier(com.sun.javadoc.ProgramElementDoc member)

printComment

protected void printComment(com.sun.javadoc.ProgramElementDoc member)

printTags

protected void printTags(com.sun.javadoc.ProgramElementDoc member)

name

protected String name(com.sun.javadoc.ProgramElementDoc member)

printDeprecated

protected void printDeprecated(com.sun.javadoc.ProgramElementDoc member)

printDeprecatedClassComment

protected void printDeprecatedClassComment(com.sun.javadoc.ProgramElementDoc member)

printHead

protected void printHead(com.sun.javadoc.MemberDoc member)

printFullComment

protected void printFullComment(com.sun.javadoc.ProgramElementDoc member)

printCommentAndTags

protected void printCommentAndTags(com.sun.javadoc.ProgramElementDoc member)

printSummaryHeader

public void printSummaryHeader(com.sun.javadoc.ClassDoc cd)

Forward to containing writer

printInheritedSummaryHeader

public void printInheritedSummaryHeader(com.sun.javadoc.ClassDoc cd)

Forward to containing writer

printInheritedSummaryFooter

public void printInheritedSummaryFooter(com.sun.javadoc.ClassDoc cd)

Forward to containing writer

printSummaryFooter

public void printSummaryFooter(com.sun.javadoc.ClassDoc cd)

Forward to containing writer

printSummaryMember

public void printSummaryMember(com.sun.javadoc.ClassDoc cd,
                               com.sun.javadoc.ProgramElementDoc member)

Forward to containing writer

printInheritedSummaryMember

public void printInheritedSummaryMember(com.sun.javadoc.ClassDoc cd,
                                        com.sun.javadoc.ProgramElementDoc member)

Forward to containing writer

printMembersSummary

public void printMembersSummary()

isInherited

protected boolean isInherited(com.sun.javadoc.ProgramElementDoc ped)

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

Parameters:

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

printInheritedMembersSummary

public void printInheritedMembersSummary()

printMembers

public void printMembers()

printDeprecatedAPI

protected void printDeprecatedAPI(List deprmembers,
                                  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(Object mems,
                            String heading)

Print use info.

navSummaryLink

protected void navSummaryLink()

navDetailLink

protected void navDetailLink()

serialWarning

protected void serialWarning(com.sun.javadoc.SourcePosition pos,
                             String key,
                             String a1,
                             String a2)

buildVisibleMemberMap

public void buildVisibleMemberMap()

eligibleMembers

public com.sun.javadoc.ProgramElementDoc[] eligibleMembers(com.sun.javadoc.ProgramElementDoc[] members)

members

public List members(com.sun.javadoc.ClassDoc cd)

configuration

public ConfigurationStandard configuration()

msg

public com.sun.tools.doclets.MessageRetriever msg()