Class DeprecatedListWriter


@Deprecated public class DeprecatedListWriter extends SubWriterHolderWriter
Deprecated.
Generate File to list all the deprecated classes and class members with the appropriate links.

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.

See Also:
  • Field Details

    • ANCHORS

      private static final String[] ANCHORS
      Deprecated.
    • HEADING_KEYS

      private static final String[] HEADING_KEYS
      Deprecated.
    • SUMMARY_KEYS

      private static final String[] SUMMARY_KEYS
      Deprecated.
    • HEADER_KEYS

      private static final String[] HEADER_KEYS
      Deprecated.
    • writers

      private AbstractMemberWriter[] writers
      Deprecated.
    • configuration

      private ConfigurationImpl configuration
      Deprecated.
  • Constructor Details

  • Method Details

    • generate

      public static void generate(ConfigurationImpl configuration)
      Deprecated.
      Get list of all the deprecated classes and members in all the Packages specified on the Command Line. Then instantiate DeprecatedListWriter and generate File.
      Parameters:
      configuration - the current configuration of the doclet.
    • generateDeprecatedListFile

      protected void generateDeprecatedListFile(DeprecatedAPIListBuilder deprapi) throws IOException
      Deprecated.
      Generate the deprecated API list.
      Parameters:
      deprapi - list of deprecated API built already.
      Throws:
      IOException
    • addIndexLink

      private void addIndexLink(DeprecatedAPIListBuilder builder, int type, Content contentTree)
      Deprecated.
      Add the index link.
      Parameters:
      builder - the deprecated list builder
      type - the type of list being documented
      contentTree - the content tree to which the index link will be added
    • getContentsList

      public Content getContentsList(DeprecatedAPIListBuilder deprapi)
      Deprecated.
      Get the contents list.
      Parameters:
      deprapi - the deprecated list builder
      Returns:
      a content tree for the contents list
    • addAnchor

      private void addAnchor(DeprecatedAPIListBuilder builder, int type, Content htmlTree)
      Deprecated.
      Add the anchor.
      Parameters:
      builder - the deprecated list builder
      type - the type of list being documented
      htmlTree - the content tree to which the anchor will be added
    • getHeader

      public HtmlTree getHeader()
      Deprecated.
      Get the header for the deprecated API Listing.
      Returns:
      a content tree for the header
    • getNavLinkDeprecated

      protected Content getNavLinkDeprecated()
      Deprecated.
      Get the deprecated label.
      Overrides:
      getNavLinkDeprecated in class HtmlDocletWriter
      Returns:
      a content tree for the deprecated label