Class TreeWriter


  • @Deprecated
    public class TreeWriter
    extends AbstractTreeWriter
    Deprecated.
    Generate Class Hierarchy page for all the Classes in this run. Use ClassTree for building the Tree. The name of the generated file is "overview-tree.html" and it is generated in the current or the destination 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)
    • Constructor Detail

      • TreeWriter

        public TreeWriter​(ConfigurationImpl configuration,
                          DocPath filename,
                          ClassTree classtree)
                   throws IOException
        Deprecated.
        Constructor to construct TreeWriter object.
        Parameters:
        configuration - the current configuration of the doclet.
        filename - String filename
        classtree - the tree being built.
        Throws:
        IOException
    • Method Detail

      • generate

        public static void generate​(ConfigurationImpl configuration,
                                    ClassTree classtree)
        Deprecated.
        Create a TreeWriter object and use it to generate the "overview-tree.html" file.
        Parameters:
        classtree - the class tree being documented.
        Throws:
        DocletAbortException
      • generateTreeFile

        public void generateTreeFile()
                              throws IOException
        Deprecated.
        Generate the interface hierarchy and class hierarchy.
        Throws:
        IOException
      • addPackageTreeLinks

        protected void addPackageTreeLinks​(Content contentTree)
        Deprecated.
        Add the links to all the package tree files.
        Parameters:
        contentTree - the content tree to which the links will be added
      • getTreeHeader

        protected HtmlTree getTreeHeader()
        Deprecated.
        Get the tree header.
        Returns:
        a content tree for the tree header