Class PackageUseWriter


  • @Deprecated
    public class PackageUseWriter
    extends SubWriterHolderWriter
    Deprecated.
    Generate package usage information.

    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.

    Author:
    Robert G. Field, Bhavesh Patel (Modified)
    • Field Detail

      • mainTree

        protected HtmlTree mainTree
        Deprecated.
    • Method Detail

      • generate

        public static void generate​(ConfigurationImpl configuration,
                                    ClassUseMapper mapper,
                                    PackageDoc pkgdoc)
        Deprecated.
        Generate a class page.
        Parameters:
        configuration - the current configuration of the doclet.
        mapper - the mapping of the class usage.
        pkgdoc - the package doc being documented.
      • generatePackageUseFile

        protected void generatePackageUseFile()
                                       throws IOException
        Deprecated.
        Generate the package use list.
        Throws:
        IOException
      • addPackageUse

        protected void addPackageUse​(Content contentTree)
                              throws IOException
        Deprecated.
        Add the package use information.
        Parameters:
        contentTree - the content tree to which the package use information will be added
        Throws:
        IOException
      • addPackageList

        protected void addPackageList​(Content contentTree)
                               throws IOException
        Deprecated.
        Add the list of packages that use the given package.
        Parameters:
        contentTree - the content tree to which the package list will be added
        Throws:
        IOException
      • addClassList

        protected void addClassList​(Content contentTree)
                             throws IOException
        Deprecated.
        Add the list of classes that use the given package.
        Parameters:
        contentTree - the content tree to which the class list will be added
        Throws:
        IOException
      • addClassRow

        protected void addClassRow​(ClassDoc usedClass,
                                   PackageDoc pkg,
                                   Content contentTree)
        Deprecated.
        Add a row for the class that uses the given package.
        Parameters:
        usedClass - the class that uses the given package
        pkg - the package to which the class belongs
        contentTree - the content tree to which the row will be added
      • addPackageUse

        protected void addPackageUse​(PackageDoc pkg,
                                     Content contentTree)
                              throws IOException
        Deprecated.
        Add the package use information.
        Parameters:
        pkg - the package that used the given package
        contentTree - the content tree to which the information will be added
        Throws:
        IOException
      • getPackageUseHeader

        protected HtmlTree getPackageUseHeader()
        Deprecated.
        Get the header for the package use listing.
        Returns:
        a content tree representing the package use header