Class ClassUseWriter


  • @Deprecated
    public class ClassUseWriter
    extends SubWriterHolderWriter
    Deprecated.
    Generate class 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.
        The HTML tree for main tag.
    • Method Detail

      • generateClassUseFile

        protected void generateClassUseFile()
                                     throws IOException
        Deprecated.
        Generate the class use list.
        Throws:
        IOException
      • addClassUse

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

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

        protected void addPackageAnnotationList​(Content contentTree)
                                         throws IOException
        Deprecated.
        Add the package annotation list.
        Parameters:
        contentTree - the content tree to which the package annotation list will be added
        Throws:
        IOException
      • addClassList

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

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

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

        protected HtmlTree getClassUseHeader()
        Deprecated.
        Get the header for the class use Listing.
        Returns:
        a content tree representing the class use header
      • getNavLinkClass

        protected Content getNavLinkClass()
        Deprecated.
        Get class page link.
        Overrides:
        getNavLinkClass in class HtmlDocletWriter
        Returns:
        a content tree for the class page link