Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class ConstantsSummaryWriterImpl

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.ConstantsSummaryWriterImpl
All Implemented Interfaces:
ConstantsSummaryWriter
@Deprecated public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements ConstantsSummaryWriter
Deprecated.
Write the Constants Summary Page in HTML format.

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.4

  • Field Details

    • configuration

      ConfigurationImpl configuration
      Deprecated.
      The configuration used in this run of the standard doclet.

    • currentClassDoc

      private ClassDoc currentClassDoc
      Deprecated.
      The current class being documented.

    • constantsTableSummary

      private final String constantsTableSummary
      Deprecated.

    • constantsTableHeader

      private final String[] constantsTableHeader
      Deprecated.

    • mainTree

      private HtmlTree mainTree
      Deprecated.
      The HTML tree for main tag.

    • summaryTree

      private HtmlTree summaryTree
      Deprecated.
      The HTML tree for constant values summary.

  • Constructor Details

    • ConstantsSummaryWriterImpl

      public ConstantsSummaryWriterImpl(ConfigurationImpl configuration) throws IOException
      Deprecated.
      Construct a ConstantsSummaryWriter.
      Parameters:
      configuration - the configuration used in this run of the standard doclet.
      Throws:
      IOException

  • Method Details

    • getHeader

      public Content getHeader()
      Deprecated.
      Get the header for the constant summary documentation.
      Specified by:
      getHeader in interface ConstantsSummaryWriter
      Returns:
      header that needs to be added to the documentation

    • getContentsHeader

      public Content getContentsHeader()
      Deprecated.
      Get the header for the constant content list.
      Specified by:
      getContentsHeader in interface ConstantsSummaryWriter
      Returns:
      content header that needs to be added to the documentation

    • addLinkToPackageContent

      public void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName, Set<String> printedPackageHeaders, Content contentListTree)
      Deprecated.
      Adds the given package name link to the constant content list tree.
      Specified by:
      addLinkToPackageContent in interface ConstantsSummaryWriter
      Parameters:
      pkg - the PackageDoc to index.
      parsedPackageName - the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.
      printedPackageHeaders - the set of package headers that have already been indexed. We don't want to index something more than once.
      contentListTree - the content tree to which the link will be added

    • addContentsList

      public void addContentsList(Content contentTree, Content contentListTree)
      Deprecated.
      Add the content list to the documentation tree.
      Specified by:
      addContentsList in interface ConstantsSummaryWriter
      Parameters:
      contentTree - the tree to which the contents list will be added
      contentListTree - the content that will be added to the list

    • getConstantSummaries

      public Content getConstantSummaries()
      Deprecated.
      Get the constant summaries for the document.
      Specified by:
      getConstantSummaries in interface ConstantsSummaryWriter
      Returns:
      constant summaries header to be added to the documentation tree

    • addPackageName

      public void addPackageName(String parsedPackageName, Content summariesTree, boolean first)
      Deprecated.
      Adds the given package name.
      Specified by:
      addPackageName in interface ConstantsSummaryWriter
      Parameters:
      parsedPackageName - the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.
      summariesTree - the summaries documentation tree
      first - true if the first package is listed be written

    • getClassConstantHeader

      public Content getClassConstantHeader()
      Deprecated.
      Get the class summary header for the constants summary.
      Specified by:
      getClassConstantHeader in interface ConstantsSummaryWriter
      Returns:
      the header content for the class constants summary

    • addClassConstant

      public void addClassConstant(Content summariesTree, Content classConstantTree)
      Deprecated.
      Add the content list to the documentation summaries tree.
      Specified by:
      addClassConstant in interface ConstantsSummaryWriter
      Parameters:
      summariesTree - the tree to which the class constants list will be added
      classConstantTree - the class constant tree that will be added to the list

    • getConstantMembersHeader

      public Content getConstantMembersHeader(ClassDoc cd)
      Deprecated.
      Get the table caption and header for the constant summary table
      Parameters:
      cd - classdoc to be documented
      Returns:
      constant members header content

    • getClassName

      protected Content getClassName(Content classStr)
      Deprecated.
      Get the class name in the table caption and the table header.
      Parameters:
      classStr - the class name to print.
      Returns:
      the table caption and header

    • addConstantMembers

      public void addConstantMembers(ClassDoc cd, List<FieldDoc> fields, Content classConstantTree)
      Deprecated.
      Adds the constant member table to the documentation tree.
      Specified by:
      addConstantMembers in interface ConstantsSummaryWriter
      Parameters:
      cd - the class whose constants are being documented.
      fields - the constants being documented.
      classConstantTree - the documentation tree to which theconstant member table content will be added

    • addConstantMember

      private void addConstantMember(FieldDoc member, HtmlTree trTree)
      Deprecated.
      Add the row for the constant summary table.
      Parameters:
      member - the field to be documented.
      trTree - an htmltree object for the table row

    • getTypeColumn

      private Content getTypeColumn(FieldDoc member)
      Deprecated.
      Get the type column for the constant summary table row.
      Parameters:
      member - the field to be documented.
      Returns:
      the type column of the constant table row

    • getNameColumn

      private Content getNameColumn(FieldDoc member)
      Deprecated.
      Get the name column for the constant summary table row.
      Parameters:
      member - the field to be documented.
      Returns:
      the name column of the constant table row

    • getValue

      private Content getValue(FieldDoc member)
      Deprecated.
      Get the value column for the constant summary table row.
      Parameters:
      member - the field to be documented.
      Returns:
      the value column of the constant table row

    • addConstantSummaries

      public void addConstantSummaries(Content contentTree, Content summariesTree)
      Deprecated.
      Add the summaries list to the content tree.
      Specified by:
      addConstantSummaries in interface ConstantsSummaryWriter
      Parameters:
      contentTree - the tree to which the summaries list will be added
      summariesTree - the summaries content tree that will be added to the list

    • addFooter

      public void addFooter(Content contentTree)
      Deprecated.
      Adds the footer for the summary documentation.
      Specified by:
      addFooter in interface ConstantsSummaryWriter
      Parameters:
      contentTree - content tree to which the footer will be added

    • printDocument

      public void printDocument(Content contentTree) throws IOException
      Deprecated.
      Print the constants summary document.
      Specified by:
      printDocument in interface ConstantsSummaryWriter
      Parameters:
      contentTree - content tree which should be printed
      Throws:
      IOException