Class ConstantsSummaryBuilder

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.ConstantsSummaryBuilder
@Deprecated public class ConstantsSummaryBuilder extends AbstractBuilder
Deprecated.
Builds the Constants Summary Page.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:
1.5

  • Field Details

    • ROOT

      public static final String ROOT
      Deprecated.
      The root element of the constant summary XML is "ConstantSummary".
      See Also:

    • MAX_CONSTANT_VALUE_INDEX_LENGTH

      public static final int MAX_CONSTANT_VALUE_INDEX_LENGTH
      Deprecated.
      The maximum number of package directories shown in the constant value index.
      See Also:

    • writer

      protected final ConstantsSummaryWriter writer
      Deprecated.
      The writer used to write the results.

    • classDocsWithConstFields

      protected final Set<ClassDoc> classDocsWithConstFields
      Deprecated.
      The set of ClassDocs that have constant fields.

    • printedPackageHeaders

      protected Set<String> printedPackageHeaders
      Deprecated.
      The set of printed package headers.

    • currentPackage

      private PackageDoc currentPackage
      Deprecated.
      The current package being documented.

    • currentClass

      private ClassDoc currentClass
      Deprecated.
      The current class being documented.

    • contentTree

      private Content contentTree
      Deprecated.
      The content tree for the constant summary documentation.

    • first

      private boolean first
      Deprecated.
      True if first package is listed.

  • Constructor Details

    • ConstantsSummaryBuilder

      private ConstantsSummaryBuilder(AbstractBuilder.Context context, ConstantsSummaryWriter writer)
      Deprecated.
      Construct a new ConstantsSummaryBuilder.
      Parameters:
      context - the build context.
      writer - the writer for the summary.

  • Method Details

    • getInstance

      public static ConstantsSummaryBuilder getInstance(AbstractBuilder.Context context, ConstantsSummaryWriter writer)
      Deprecated.
      Construct a ConstantsSummaryBuilder.
      Parameters:
      context - the build context.
      writer - the writer for the summary.

    • build

      public void build() throws IOException
      Deprecated.
      Build the documentation.
      Specified by:
      build in class AbstractBuilder
      Throws:
      IOException - if there is a problem writing the output

    • getName

      public String getName()
      Deprecated.
      Return the name of this builder.
      Specified by:
      getName in class AbstractBuilder
      Returns:
      the name of the builder.

    • buildConstantSummary

      public void buildConstantSummary(XMLNode node, Content contentTree) throws Exception
      Deprecated.
      Build the constant summary.
      Parameters:
      node - the XML element that specifies which components to document
      contentTree - the content tree to which the documentation will be added
      Throws:
      Exception

    • buildContents

      public void buildContents(XMLNode node, Content contentTree)
      Deprecated.
      Build the list of packages.
      Parameters:
      node - the XML element that specifies which components to document
      contentTree - the content tree to which the content list will be added

    • buildConstantSummaries

      public void buildConstantSummaries(XMLNode node, Content contentTree)
      Deprecated.
      Build the summary for each documented package.
      Parameters:
      node - the XML element that specifies which components to document
      contentTree - the tree to which the summaries will be added

    • buildPackageHeader

      public void buildPackageHeader(XMLNode node, Content summariesTree)
      Deprecated.
      Build the header for the given package.
      Parameters:
      node - the XML element that specifies which components to document
      summariesTree - the tree to which the package header will be added

    • buildClassConstantSummary

      public void buildClassConstantSummary(XMLNode node, Content summariesTree)
      Deprecated.
      Build the summary for the current class.
      Parameters:
      node - the XML element that specifies which components to document
      summariesTree - the tree to which the class constant summary will be added

    • buildConstantMembers

      public void buildConstantMembers(XMLNode node, Content classConstantTree)
      Deprecated.
      Build the summary of constant members in the class.
      Parameters:
      node - the XML element that specifies which components to document
      classConstantTree - the tree to which the constant members table will be added

    • hasConstantField

      private boolean hasConstantField(PackageDoc pkg)
      Deprecated.
      Return true if the given package has constant fields to document.
      Parameters:
      pkg - the package being checked.
      Returns:
      true if the given package has constant fields to document.

    • hasConstantField

      private boolean hasConstantField(ClassDoc classDoc)
      Deprecated.
      Return true if the given class has constant fields to document.
      Parameters:
      classDoc - the class being checked.
      Returns:
      true if the given package has constant fields to document.

    • hasPrintedPackageIndex

      private boolean hasPrintedPackageIndex(String pkgname)
      Deprecated.
      Return true if the given package name has been printed. Also return true if the root of this package has been printed.
      Parameters:
      pkgname - the name of the package to check.

    • parsePackageName

      private String parsePackageName(String pkgname)
      Deprecated.
      Parse the package name. We only want to display package name up to 2 levels.