Class PackageTreeWriter


  • @Deprecated
    public class PackageTreeWriter
    extends AbstractTreeWriter
    Deprecated.
    Class to generate Tree page for a package. The name of the file generated is "package-tree.html" and it is generated in the respective package directory.

    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:
    Atul M Dambalkar, Bhavesh Patel (Modified)
    • Field Detail

      • packagedoc

        protected PackageDoc packagedoc
        Deprecated.
        Package for which tree is to be generated.
      • prev

        protected PackageDoc prev
        Deprecated.
        The previous package name in the alpha-order list.
      • next

        protected PackageDoc next
        Deprecated.
        The next package name in the alpha-order list.
    • Method Detail

      • generate

        public static void generate​(ConfigurationImpl configuration,
                                    PackageDoc pkg,
                                    PackageDoc prev,
                                    PackageDoc next,
                                    boolean noDeprecated)
        Deprecated.
        Construct a PackageTreeWriter object and then use it to generate the package tree page.
        Parameters:
        pkg - Package for which tree file is to be generated.
        prev - Previous package in the alpha-ordered list.
        next - Next package in the alpha-ordered list.
        noDeprecated - If true, do not generate any information for deprecated classe or interfaces.
        Throws:
        DocletAbortException
      • generatePackageTreeFile

        protected void generatePackageTreeFile()
                                        throws IOException
        Deprecated.
        Generate a separate tree file for each package.
        Throws:
        IOException
      • getPackageTreeHeader

        protected HtmlTree getPackageTreeHeader()
        Deprecated.
        Get the package tree header.
        Returns:
        a content tree for the header
      • addLinkToMainTree

        protected void addLinkToMainTree​(Content div)
        Deprecated.
        Add a link to the tree for all the packages.
        Parameters:
        div - the content tree to which the link will be added
      • getNavLinkPrevious

        protected Content getNavLinkPrevious()
        Deprecated.
        Get link for the previous package tree file.
        Overrides:
        getNavLinkPrevious in class HtmlDocletWriter
        Returns:
        a content tree for the link
      • getNavLinkNext

        protected Content getNavLinkNext()
        Deprecated.
        Get link for the next package tree file.
        Overrides:
        getNavLinkNext in class HtmlDocletWriter
        Returns:
        a content tree for the link
      • getNavLinkPackage

        protected Content getNavLinkPackage()
        Deprecated.
        Get link to the package summary page for the package of this tree.
        Overrides:
        getNavLinkPackage in class HtmlDocletWriter
        Returns:
        a content tree for the package link