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

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:
    List

    • Field Detail

      • ANCHORS

        private static final java.lang.String[] ANCHORS
        Deprecated.

      • HEADING_KEYS

        private static final java.lang.String[] HEADING_KEYS
        Deprecated.

      • SUMMARY_KEYS

        private static final java.lang.String[] SUMMARY_KEYS
        Deprecated.

      • HEADER_KEYS

        private static final java.lang.String[] HEADER_KEYS
        Deprecated.

    • Constructor Detail

      • DeprecatedListWriter

        public DeprecatedListWriter​(ConfigurationImpl configuration,
                            DocPath filename)
                     throws java.io.IOException
        Deprecated.
        Constructor.
        Parameters:
        filename - the file to be generated.
        Throws:
        java.io.IOException

    • Method Detail

      • 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 java.io.IOException
        Deprecated.
        Generate the deprecated API list.
        Parameters:
        deprapi - list of deprecated API built already.
        Throws:
        java.io.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