ConstantsSummaryBuilder.ConstantFieldBuilder

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.ConstantsSummaryBuilder.ConstantFieldBuilder

Enclosing class:: ConstantsSummaryBuilder

private class ConstantsSummaryBuilder.ConstantFieldBuilder extends Object

Print the table of constants.

Since:: 1.4

Field Summary

Fields

Modifier and Type

Field

Description

protected ClassDoc

classdoc

The classdoc that we are examining constants for.

protected VisibleMemberMap

visibleMemberMapEnumConst

The map used to get the visible variables.

protected VisibleMemberMap

visibleMemberMapFields

The map used to get the visible variables.
Constructor Summary

Constructors

Constructor

Description

ConstantFieldBuilder(ClassDoc classdoc)

Construct a ConstantFieldSubWriter.
Method Summary

Modifier and Type

Method

Description

protected void

buildMembersSummary(XMLNode node, Content classConstantTree)

Builds the table of constants for a given class.

protected List<FieldDoc>

members()

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- visibleMemberMapFields
  
  protected VisibleMemberMap visibleMemberMapFields
  
  The map used to get the visible variables.
- visibleMemberMapEnumConst
  
  protected VisibleMemberMap visibleMemberMapEnumConst
  
  The map used to get the visible variables.
- classdoc
  
  protected ClassDoc classdoc
  
  The classdoc that we are examining constants for.
Constructor Details
- ConstantFieldBuilder
  
  public ConstantFieldBuilder(ClassDoc classdoc)
  
  Construct a ConstantFieldSubWriter.
  
  Parameters:
  
  classdoc - the classdoc that we are examining constants for.
Method Details
- buildMembersSummary
  
  protected void buildMembersSummary(XMLNode node, Content classConstantTree)
  
  Builds the table of constants for a given class.
  
  Parameters:
  
  node - the XML element that specifies which components to document
  
  classConstantTree - the tree to which the class constants table will be added
- members
  
  protected List<FieldDoc> members()
  
  Return the list of visible constant fields for the given classdoc.
  
  Returns:
  
  the list of visible constant fields for the given classdoc.