Class ClassTree
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.ClassTree
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionDeprecated.Deprecated.List of baseclasses.Deprecated.Deprecated.List of base-interfaces.private final Comparator<Doc>
Deprecated.private final Configuration
Deprecated.Deprecated.Mapping for each Interface with classes who implement it.Deprecated.Deprecated.Mapping for each Class with their SubClassesDeprecated.Deprecated.Mapping for each Interface with their SubInterfacesprivate final Utils
Deprecated. -
Constructor Summary
ConstructorsConstructorDescriptionClassTree
(ClassDoc[] classes, Configuration configuration) Deprecated.Constructor.ClassTree
(RootDoc root, Configuration configuration) Deprecated.Constructor.ClassTree
(Configuration configuration, boolean noDeprecated) Deprecated.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
Deprecated.Adjust the Class Tree.Deprecated.Return a list of all direct or indirect, sub-classes and subinterfaces of the ClassDoc argument.Deprecated.Return the list of base annotation types.Deprecated.Return the base-classes list.Deprecated.Return the list of base enums.Deprecated.Return the list of base interfaces.private void
Deprecated.Generate mapping for the sub-classes for every class in this run.Deprecated.From the map return the list of sub-classes or sub-interfaces.Deprecated.Return the list of classes which implement the interface passed.private void
Deprecated.For the interface passed get the interfaces which it extends, and then put this interface in the sub-interface list of those interfaces.private void
processType
(ClassDoc cd, Configuration configuration, Collection<ClassDoc> bases, Map<ClassDoc, SortedSet<ClassDoc>> subs) Deprecated.For the class passed map it to it's own sub-class listing.subclasses
(ClassDoc cd) Deprecated.Return the sub-class list for the class passed.Deprecated.Return the sub-interface list for the interface passed.Deprecated.Return the sub-class/interface list for the class/interface passed.
-
Field Details
-
baseclasses
Deprecated.List of baseclasses. Contains only java.lang.Object. Can be used to get the mapped listing of sub-classes. -
subclasses
Deprecated.Mapping for each Class with their SubClasses -
baseinterfaces
Deprecated.List of base-interfaces. Contains list of all the interfaces who do not have super-interfaces. Can be used to get the mapped listing of sub-interfaces. -
subinterfaces
Deprecated.Mapping for each Interface with their SubInterfaces -
baseEnums
Deprecated. -
subEnums
Deprecated. -
baseAnnotationTypes
Deprecated. -
subAnnotationTypes
Deprecated. -
implementingclasses
Deprecated.Mapping for each Interface with classes who implement it. -
configuration
Deprecated. -
utils
Deprecated. -
comparator
Deprecated.
-
-
Constructor Details
-
ClassTree
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
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
Deprecated.Constructor. Build the tree for the given array of classes.- Parameters:
classes
- Array of classes.configuration
- The current configuration of the doclet.
-
-
Method Details
-
buildTree
Deprecated.Generate mapping for the sub-classes for every class in this run. Return the sub-class list for java.lang.Object which will be having sub-class listing for itself and also for each sub-class itself will have their own sub-class lists.- Parameters:
classes
- all the classes in this run.configuration
- the current configuration of the doclet.
-
processType
private void processType(ClassDoc cd, Configuration configuration, Collection<ClassDoc> bases, Map<ClassDoc, SortedSet<ClassDoc>> subs) Deprecated.For the class passed map it to it's own sub-class listing. For the Class passed, get the super class, if superclass is non null, (it is not "java.lang.Object") get the "value" from the hashmap for this key Class if entry not found create one and get that. add this Class as a sub class in the list Recurse till hits java.lang.Object Null SuperClass.- Parameters:
cd
- class for which sub-class mapping to be generated.configuration
- the current configurtation of the doclet.
-
processInterface
Deprecated.For the interface passed get the interfaces which it extends, and then put this interface in the sub-interface list of those interfaces. Do it recursively. If a interface doesn't have super-interface just attach that interface in the list of all the baseinterfaces.- Parameters:
cd
- Interface under consideration.
-
add
Deprecated.Adjust the Class Tree. Add the class interface in to it's super-class' or super-interface's sub-interface list.- Parameters:
map
- the entire map.superclass
- java.lang.Object or the super-interface.cd
- sub-interface to be mapped.
-
get
Deprecated.From the map return the list of sub-classes or sub-interfaces. If list is null create a new one and return it.- Parameters:
map
- The entire map.cd
- class for which the sub-class list is requested.
-
subclasses
Deprecated.Return the sub-class list for the class passed.- Parameters:
cd
- class whose sub-class list is required.
-
subinterfaces
Deprecated.Return the sub-interface list for the interface passed.- Parameters:
cd
- interface whose sub-interface list is required.
-
implementingclasses
Deprecated.Return the list of classes which implement the interface passed.- Parameters:
cd
- interface whose implementing-classes list is required.
-
subs
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
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
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
Deprecated.Return the list of base interfaces. This is the list of interfaces which do not have super-interface. -
baseEnums
Deprecated.Return the list of base enums. This is the list of enums which do not have super-enums. -
baseAnnotationTypes
Deprecated.Return the list of base annotation types. This is the list of annotation types which do not have super-annotation types.
-