Class ClassTree


  • @Deprecated
    public class ClassTree
    extends Object
    Deprecated.
    Build Class Hierarchy for all the Classes. This class builds the Class Tree and the Interface Tree separately.

    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
    See Also:
    HashMap, List, Type, ClassDoc
    • Constructor Detail

      • ClassTree

        public ClassTree​(Configuration configuration,
                         boolean noDeprecated)
        Deprecated.
        Constructor. Build the Tree using the Root of this Javadoc run.
        Parameters:
        configuration - the configuration of the doclet.
        noDeprecated - Don't add deprecated classes in the class tree, if true.
      • ClassTree

        public ClassTree​(RootDoc root,
                         Configuration configuration)
        Deprecated.
        Constructor. Build the Tree using the Root of this Javadoc run.
        Parameters:
        root - Root of the Document.
        configuration - The current configuration of the doclet.
      • ClassTree

        public ClassTree​(ClassDoc[] classes,
                         Configuration configuration)
        Deprecated.
        Constructor. Build the tree for the given array of classes.
        Parameters:
        classes - Array of classes.
        configuration - The current configuration of the doclet.
    • Method Detail

      • subclasses

        public SortedSet<ClassDoc> subclasses​(ClassDoc cd)
        Deprecated.
        Return the sub-class list for the class passed.
        Parameters:
        cd - class whose sub-class list is required.
      • subinterfaces

        public SortedSet<ClassDoc> subinterfaces​(ClassDoc cd)
        Deprecated.
        Return the sub-interface list for the interface passed.
        Parameters:
        cd - interface whose sub-interface list is required.
      • implementingclasses

        public SortedSet<ClassDoc> implementingclasses​(ClassDoc cd)
        Deprecated.
        Return the list of classes which implement the interface passed.
        Parameters:
        cd - interface whose implementing-classes list is required.
      • subs

        public SortedSet<ClassDoc> subs​(ClassDoc cd,
                                        boolean isEnum)
        Deprecated.
        Return the sub-class/interface list for the class/interface passed.
        Parameters:
        cd - class/interface whose sub-class/interface list is required.
        isEnum - true if the subclasses should be forced to come from the enum tree.
      • allSubs

        public SortedSet<ClassDoc> allSubs​(ClassDoc cd,
                                           boolean isEnum)
        Deprecated.
        Return a list of all direct or indirect, sub-classes and subinterfaces of the ClassDoc argument.
        Parameters:
        cd - ClassDoc whose sub-classes or sub-interfaces are requested.
        isEnum - true if the subclasses should be forced to come from the enum tree.
      • baseclasses

        public SortedSet<ClassDoc> baseclasses()
        Deprecated.
        Return the base-classes list. This will have only one element namely thw classdoc for java.lang.Object, since this is the base class for all classes.
      • baseinterfaces

        public SortedSet<ClassDoc> baseinterfaces()
        Deprecated.
        Return the list of base interfaces. This is the list of interfaces which do not have super-interface.
      • baseEnums

        public SortedSet<ClassDoc> baseEnums()
        Deprecated.
        Return the list of base enums. This is the list of enums which do not have super-enums.
      • baseAnnotationTypes

        public SortedSet<ClassDoc> baseAnnotationTypes()
        Deprecated.
        Return the list of base annotation types. This is the list of annotation types which do not have super-annotation types.