Class AbstractTreeWriter

Direct Known Subclasses:
PackageTreeWriter, TreeWriter

@Deprecated public abstract class AbstractTreeWriter extends HtmlDocletWriter
Deprecated.
Abstract class to print the class hierarchy page for all the Classes. This is sub-classed by PackageTreeWriter and TreeWriter to generate the Package Tree and global Tree(for all the classes and packages) pages.

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.

  • Field Details

    • classtree

      protected final ClassTree classtree
      Deprecated.
      The class and interface tree built by using ClassTree
  • Constructor Details

    • AbstractTreeWriter

      protected AbstractTreeWriter(ConfigurationImpl configuration, DocPath filename, ClassTree classtree) throws IOException
      Deprecated.
      Constructor initializes classtree variable. This constructor will be used while generating global tree file "overview-tree.html".
      Parameters:
      configuration - The current configuration
      filename - File to be generated.
      classtree - Tree built by ClassTree.
      Throws:
      IOException
      DocletAbortException
  • Method Details

    • addLevelInfo

      protected void addLevelInfo(ClassDoc parent, Collection<ClassDoc> list, boolean isEnum, Content contentTree)
      Deprecated.
      Add each level of the class tree. For each sub-class or sub-interface indents the next level information. Recurses itself to add subclasses info.
      Parameters:
      parent - the superclass or superinterface of the list
      list - list of the sub-classes at this level
      isEnum - true if we are generating a tree for enums
      contentTree - the content tree to which the level information will be added
    • addTree

      protected void addTree(SortedSet<ClassDoc> list, String heading, HtmlTree div)
      Deprecated.
      Add the heading for the tree depending upon tree type if it's a Class Tree or Interface tree.
      Parameters:
      list - List of classes which are at the most base level, all the other classes in this run will derive from these classes
      heading - heading for the tree
      div - the content tree to which the tree will be added
    • addExtendsImplements

      protected void addExtendsImplements(ClassDoc parent, ClassDoc cd, Content contentTree)
      Deprecated.
      Add information regarding the classes which this class extends or implements.
      Parameters:
      parent - the parent class of the class being documented
      cd - the classdoc under consideration
      contentTree - the content tree to which the information will be added
    • addPartialInfo

      protected void addPartialInfo(ClassDoc cd, Content contentTree)
      Deprecated.
      Add information about the class kind, if it's a "class" or "interface".
      Parameters:
      cd - the class being documented
      contentTree - the content tree to which the information will be added
    • getNavLinkTree

      protected Content getNavLinkTree()
      Deprecated.
      Get the tree label for the navigation bar.
      Overrides:
      getNavLinkTree in class HtmlDocletWriter
      Returns:
      a content tree for the tree label