org.freehep.tools.doclet
Class ConstantFieldSubWriter

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

public class ConstantFieldSubWriter

extends FieldSubWriter

Print the table of constants.

Since:

1.4

Author:

Jamie Ho

Source Code:

ConstantFieldSubWriter.java

Field Summary

com.sun.tools.doclets.VisibleMemberMap

visibleMemberMap The map used to get the visible variables.

Fields inherited from class org.freehep.tools.doclet.AbstractSubWriter

nodepr, printedSummaryHeader, visibleClasses

Constructor Summary

ConstantFieldSubWriter(SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc)
Construct a ConstantFieldSubWriter.

Method Summary

List	members(com.sun.javadoc.ClassDoc cd) Return the list of visible constant fields for the given classdoc.
void	printMembersSummary() Print the table of constants.
protected void	printNameColumn(com.sun.javadoc.FieldDoc member) Print the name of the given member in a column.
protected void	printSummaryMember(com.sun.javadoc.FieldDoc member) Print the row in the constant table for the given member.
protected void	printTypeColumn(com.sun.javadoc.FieldDoc member) Print the type of the given member in a column.
protected void	printValue(com.sun.javadoc.FieldDoc member) Print the constant value of the given member in a column.

Methods inherited from class org.freehep.tools.doclet.FieldSubWriter

getMemberKind, printBodyHtmlEnd, printDeprecatedLink, printHeader, printInheritedSummaryAnchor, printInheritedSummaryLabel, printInheritedSummaryLink, printMember, printNavDetailLink, printNavSummaryLink, printSummaryAnchor, printSummaryLabel, printSummaryLink, printSummaryType

Methods inherited from class org.freehep.tools.doclet.AbstractSubWriter

bold, buildVisibleMemberMap, configuration, eligibleMembers, isInherited, makeSpace, modifierString, msg, name, navDetailLink, navSummaryLink, print, print, printComment, printCommentAndTags, printDeprecated, printDeprecatedAPI, printDeprecatedClassComment, printFullComment, printHead, printInheritedMembersSummary, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMembers, printModifier, printModifierAndType, printModifiers, printStaticAndType, printSummaryFooter, printSummaryHeader, printSummaryMember, printTags, printTypedName, printTypeLink, printTypeLinkNoDimension, printUseInfo, serialWarning, typeString

Methods inherited from class java.lang.Object

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

Field Detail

visibleMemberMap

public com.sun.tools.doclets.VisibleMemberMap visibleMemberMap

The map used to get the visible variables.

Constructor Detail

ConstantFieldSubWriter

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

Construct a ConstantFieldSubWriter.

Parameters:

writer - the writer to output the constants information.

classdoc - the classdoc that we are examining constants for.

Method Detail

printMembersSummary

public void printMembersSummary()

Print the table of constants.

Overrides:

printMembersSummary in class AbstractSubWriter

printSummaryMember

protected void printSummaryMember(com.sun.javadoc.FieldDoc member)

Print the row in the constant table for the given member.

Parameters:

member - the member to print information for.

printTypeColumn

protected void printTypeColumn(com.sun.javadoc.FieldDoc member)

Print the type of the given member in a column.

Parameters:

member - the member to print information for.

printNameColumn

protected void printNameColumn(com.sun.javadoc.FieldDoc member)

Print the name of the given member in a column.

Parameters:

member - the member to print information for.

printValue

protected void printValue(com.sun.javadoc.FieldDoc member)

Print the constant value of the given member in a column.

Parameters:

member - the member to print information for.

members

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

Return the list of visible constant fields for the given classdoc.

Overrides:

members in class AbstractSubWriter

Parameters:

cd - the classdoc to examine.

Returns:

the list of visible constant fields for the given classdoc.