Modifier and Type	Class and Description
public static class	ClassTree.Hierarchy A "hierarchy" provides the subtypes of all the supertypes of a set of leaf elements, together with the root supertype(s).
private static enum	ClassTree.HierarchyKind The kind of hierarchy.
private static class	ClassTree.SubtypeMap A map giving the subtypes for each of a collection of type elements.

Modifier and Type	Field and Description
private final BaseConfiguration	configuration
private final Map<ClassTree.HierarchyKind, ClassTree.Hierarchy>	hierarchies The collection of hierarchies, indexed by kind.
private final ClassTree.SubtypeMap	implementingClasses Mapping for each interface with classes that implement it.
private final Utils	utils

Access	Constructor and Description
public	ClassTree(BaseConfiguration the configuration of the doclet configuration) Constructor.
public	ClassTree(SortedSet<TypeElement> a set of classes classesSet, BaseConfiguration The current configuration of the doclet. configuration) Constructor.

Method Summary

Modifier and Type	Method and Description
public ClassTree.Hierarchy	Returns: the hierarchy for which the leaf nodes are annotation interfaces annotationInterfaces() Returns the hierarchy for which the leaf nodes are annotation interfaces.
private void	buildTree(Iterable<TypeElement> the type elements typeElements) Generate the hierarchies for the given type elements.
public ClassTree.Hierarchy	Returns: the hierarchy for which the leaf nodes are plain classes classes() Returns the hierarchy for which the leaf nodes are plain classes.
public ClassTree.Hierarchy	Returns: the hierarchy for which the leaf nodes are enum classes enumClasses() Returns the hierarchy for which the leaf nodes are enum classes.
public ClassTree.Hierarchy	hierarchy(TypeElement typeElement)
public SortedSet<TypeElement>	implementingClasses(TypeElement interface whose implementing-classes set is required. typeElement) Return the set of classes which implement the interface passed.
public ClassTree.Hierarchy	Returns: the hierarchy for which the leaf nodes are plain interfaces interfaces() Returns the hierarchy for which the leaf nodes are plain interfaces.
private void	processInterface(TypeElement Interface under consideration. typeElement) For the interface passed get the interfaces which it extends, and then put this interface in the subinterface set of those interfaces.
private void	processType(TypeElement for which the hierarchy is to be generated typeElement, ClassTree.Hierarchy the hierarchy hierarchy) Adds details for a type element into a given hierarchy.
public ClassTree.Hierarchy	Returns: the hierarchy for which the leaf nodes are record classes recordClasses() Returns the hierarchy for which the leaf nodes are record classes.
public SortedSet<TypeElement>	subClasses(TypeElement class whose subclass set is required. typeElement) Return the subclass set for the class passed.
public SortedSet<TypeElement>	subInterfaces(TypeElement interface whose subinterface set is required. typeElement) Return the subinterface set for the interface passed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

configuration	back to summary
private final BaseConfiguration configuration

hierarchies	back to summary
private final Map<ClassTree.HierarchyKind, ClassTree.Hierarchy> hierarchies The collection of hierarchies, indexed by kind.

implementingClasses	back to summary
private final ClassTree.SubtypeMap implementingClasses Mapping for each interface with classes that implement it.

utils	back to summary
private final Utils utils

Constructor Detail

ClassTree	back to summary
public ClassTree(BaseConfiguration configuration) Constructor. Build the tree for all the included type elements. Parameters configuration:BaseConfiguration the configuration of the doclet

ClassTree

back to summary

public ClassTree(BaseConfiguration configuration)

Constructor. Build the tree for all the included type elements.

Parameters

configuration:BaseConfiguration: the configuration of the doclet

ClassTree	back to summary
public ClassTree(SortedSet<TypeElement> classesSet, BaseConfiguration configuration) Constructor. Build the tree for the given collection of classes. Parameters classesSet:SortedSet<TypeElement> a set of classes configuration:BaseConfiguration The current configuration of the doclet.

ClassTree

back to summary

public ClassTree(SortedSet<TypeElement> classesSet, BaseConfiguration configuration)

Constructor. Build the tree for the given collection of classes.

Parameters

classesSet:SortedSet<TypeElement>: a set of classes
configuration:BaseConfiguration: The current configuration of the doclet.

Method Detail

annotationInterfaces	back to summary
public ClassTree.Hierarchy annotationInterfaces() Returns the hierarchy for which the leaf nodes are annotation interfaces. Returns:ClassTree.Hierarchy the hierarchy for which the leaf nodes are annotation interfaces

annotationInterfaces

back to summary

public ClassTree.Hierarchy annotationInterfaces()

Returns the hierarchy for which the leaf nodes are annotation interfaces.

Returns:ClassTree.Hierarchy: the hierarchy for which the leaf nodes are annotation interfaces

buildTree	back to summary
private void buildTree(Iterable<TypeElement> typeElements) Generate the hierarchies for the given type elements. Parameters typeElements:Iterable<TypeElement> the type elements

buildTree

back to summary

private void buildTree(Iterable<TypeElement> typeElements)

Generate the hierarchies for the given type elements.

Parameters

typeElements:Iterable<TypeElement>: the type elements

classes	back to summary
public ClassTree.Hierarchy classes() Returns the hierarchy for which the leaf nodes are plain classes. Returns:ClassTree.Hierarchy the hierarchy for which the leaf nodes are plain classes

classes

back to summary

public ClassTree.Hierarchy classes()

Returns the hierarchy for which the leaf nodes are plain classes.

Returns:ClassTree.Hierarchy: the hierarchy for which the leaf nodes are plain classes

enumClasses	back to summary
public ClassTree.Hierarchy enumClasses() Returns the hierarchy for which the leaf nodes are enum classes. Returns:ClassTree.Hierarchy the hierarchy for which the leaf nodes are enum classes

enumClasses

back to summary

public ClassTree.Hierarchy enumClasses()

Returns the hierarchy for which the leaf nodes are enum classes.

Returns:ClassTree.Hierarchy: the hierarchy for which the leaf nodes are enum classes

hierarchy	back to summary
public ClassTree.Hierarchy hierarchy(TypeElement typeElement)

implementingClasses	back to summary
public SortedSet<TypeElement> implementingClasses(TypeElement typeElement) Return the set of classes which implement the interface passed. Parameters typeElement:TypeElement interface whose implementing-classes set is required.

implementingClasses

back to summary

public SortedSet<TypeElement> implementingClasses(TypeElement typeElement)

Return the set of classes which implement the interface passed.

Parameters

typeElement:TypeElement: interface whose implementing-classes set is required.

interfaces	back to summary
public ClassTree.Hierarchy interfaces() Returns the hierarchy for which the leaf nodes are plain interfaces. Returns:ClassTree.Hierarchy the hierarchy for which the leaf nodes are plain interfaces

interfaces

back to summary

public ClassTree.Hierarchy interfaces()

Returns the hierarchy for which the leaf nodes are plain interfaces.

Returns:ClassTree.Hierarchy: the hierarchy for which the leaf nodes are plain interfaces

processInterface	back to summary
private void processInterface(TypeElement typeElement) For the interface passed get the interfaces which it extends, and then put this interface in the subinterface set of those interfaces. Do it recursively. If an interface doesn't have superinterface just attach that interface in the set of all the baseInterfaces. Parameters typeElement:TypeElement Interface under consideration.

processInterface

back to summary

private void processInterface(TypeElement typeElement)

For the interface passed get the interfaces which it extends, and then put this interface in the subinterface set of those interfaces. Do it recursively. If an interface doesn't have superinterface just attach that interface in the set of all the baseInterfaces.

Parameters

typeElement:TypeElement: Interface under consideration.

processType	back to summary
private void processType(TypeElement typeElement, ClassTree.Hierarchy hierarchy) Adds details for a type element into a given hierarchy. The subtypes are updated for the transitive closure of all supertypes of this type element. If this type element has no superclass or superinterfaces, it is marked as a root. Parameters typeElement:TypeElement for which the hierarchy is to be generated hierarchy:ClassTree.Hierarchy the hierarchy

processType

back to summary

private void processType(TypeElement typeElement, ClassTree.Hierarchy hierarchy)

Adds details for a type element into a given hierarchy. The subtypes are updated for the transitive closure of all supertypes of this type element. If this type element has no superclass or superinterfaces, it is marked as a root.

Parameters

typeElement:TypeElement: for which the hierarchy is to be generated
hierarchy:ClassTree.Hierarchy: the hierarchy

recordClasses	back to summary
public ClassTree.Hierarchy recordClasses() Returns the hierarchy for which the leaf nodes are record classes. Returns:ClassTree.Hierarchy the hierarchy for which the leaf nodes are record classes

recordClasses

back to summary

public ClassTree.Hierarchy recordClasses()

Returns the hierarchy for which the leaf nodes are record classes.

Returns:ClassTree.Hierarchy: the hierarchy for which the leaf nodes are record classes

subClasses	back to summary
public SortedSet<TypeElement> subClasses(TypeElement typeElement) Return the subclass set for the class passed. Parameters typeElement:TypeElement class whose subclass set is required.

subClasses

back to summary

public SortedSet<TypeElement> subClasses(TypeElement typeElement)

Return the subclass set for the class passed.

Parameters

typeElement:TypeElement: class whose subclass set is required.

subInterfaces	back to summary
public SortedSet<TypeElement> subInterfaces(TypeElement typeElement) Return the subinterface set for the interface passed. Parameters typeElement:TypeElement interface whose subinterface set is required.

subInterfaces

back to summary

public SortedSet<TypeElement> subInterfaces(TypeElement typeElement)

Return the subinterface set for the interface passed.

Parameters

typeElement:TypeElement: interface whose subinterface set is required.

jdk.javadoc.internal.doclets.toolkit.util back to summary

public Class ClassTree.Hierarchy

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.toolkit.util.ClassTree.Hierarchy

A "hierarchy" provides the subtypes of all the supertypes of a set of leaf elements, together with the root supertype(s).

Field Summary

Modifier and Type	Field and Description
private final Comparator<Element>	comparator
private final SortedSet<TypeElement>	roots
private final ClassTree.SubtypeMap	subtypes

Constructor Summary

Access	Constructor and Description
pack-priv	Hierarchy(Comparator<Element> comparator)

Method Summary

Modifier and Type	Method and Description
public SortedSet<TypeElement>	Returns: the set of all subtypes of the given type element, or an empty set if there are none allSubtypes(TypeElement the type element typeElement) Returns the set of all subtypes of the given type element, or an empty set if there are none.
public SortedSet<TypeElement>	Returns: the roots of the hierarchy roots() Returns the roots of the hierarchy.
public SortedSet<TypeElement>	Returns: the immediate subtypes of the given type element, or an empty set if there are none subtypes(TypeElement the type element typeElement) Returns the immediate subtypes of the given type element, or an empty set if there are none.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

comparator	back to summary
private final Comparator<Element> comparator

roots	back to summary
private final SortedSet<TypeElement> roots

subtypes	back to summary
private final ClassTree.SubtypeMap subtypes

Constructor Detail

Hierarchy	back to summary
pack-priv Hierarchy(Comparator<Element> comparator)

Method Detail

allSubtypes	back to summary
public SortedSet<TypeElement> allSubtypes(TypeElement typeElement) Returns the set of all subtypes of the given type element, or an empty set if there are none. The set of all subtypes is the transitive closure of the immediate subtypes of the given type element. Parameters typeElement:TypeElement the type element Returns:SortedSet<TypeElement> the set of all subtypes of the given type element, or an empty set if there are none

allSubtypes

back to summary

public SortedSet<TypeElement> allSubtypes(TypeElement typeElement)

Returns the set of all subtypes of the given type element, or an empty set if there are none. The set of all subtypes is the transitive closure of the immediate subtypes of the given type element.

Parameters

typeElement:TypeElement: the type element

Returns:SortedSet<TypeElement>

the set of all subtypes of the given type element, or an empty set if there are none

roots back to summary

roots	back to summary
public SortedSet<TypeElement> roots() Returns the roots of the hierarchy. Each root is a class or interface with no superclass or superinterfaces. If the hierarchy just contains classes, the root will be `java.lang.Object`. Returns:SortedSet<TypeElement> the roots of the hierarchy

public SortedSet<TypeElement> roots()

Returns the roots of the hierarchy. Each root is a class or interface with no superclass or superinterfaces. If the hierarchy just contains classes, the root will be java.lang.Object.

Returns:SortedSet<TypeElement>: the roots of the hierarchy

subtypes	back to summary
public SortedSet<TypeElement> subtypes(TypeElement typeElement) Returns the immediate subtypes of the given type element, or an empty set if there are none. Parameters typeElement:TypeElement the type element Returns:SortedSet<TypeElement> the immediate subtypes of the given type element, or an empty set if there are none

subtypes

back to summary

public SortedSet<TypeElement> subtypes(TypeElement typeElement)

Returns the immediate subtypes of the given type element, or an empty set if there are none.

Parameters

typeElement:TypeElement: the type element

Returns:SortedSet<TypeElement>

the immediate subtypes of the given type element, or an empty set if there are none

jdk.javadoc.internal.doclets.toolkit.util back to summary

private final Enum ClassTree.HierarchyKind

Class Inheritance

extends Enum<ClassTree.HierarchyKind>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.doclets.toolkit.util.ClassTree.HierarchyKind

The kind of hierarchy. Currently, the kinds correspond to the kinds of declared types, although other partitions could be possible.

Field Summary

Modifier and Type	Field and Description
public static final ClassTree.HierarchyKind	ANNOTATION_INTERFACES
public static final ClassTree.HierarchyKind	CLASSES
public static final ClassTree.HierarchyKind	ENUM_CLASSES
public static final ClassTree.HierarchyKind	INTERFACES
public static final ClassTree.HierarchyKind	RECORD_CLASSES

Constructor Summary

Access	Constructor and Description
private	HierarchyKind()

Method Summary

Modifier and Type	Method and Description
public static ClassTree.HierarchyKind	valueOf(String name)
public static ClassTree.HierarchyKind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ANNOTATION_INTERFACES	back to summary
public static final ClassTree.HierarchyKind ANNOTATION_INTERFACES

CLASSES	back to summary
public static final ClassTree.HierarchyKind CLASSES

ENUM_CLASSES	back to summary
public static final ClassTree.HierarchyKind ENUM_CLASSES

INTERFACES	back to summary
public static final ClassTree.HierarchyKind INTERFACES

RECORD_CLASSES	back to summary
public static final ClassTree.HierarchyKind RECORD_CLASSES

Constructor Detail

HierarchyKind	back to summary
private HierarchyKind()

Method Detail

valueOf	back to summary
public static ClassTree.HierarchyKind valueOf(String name)

values	back to summary
public static ClassTree.HierarchyKind[] values()

jdk.javadoc.internal.doclets.toolkit.util back to summary

private Class ClassTree.SubtypeMap

Class Inheritance

extends HashMap<TypeElement, SortedSet<TypeElement>>

java.lang.Object
java.util.AbstractMap
java.util.HashMap
jdk.javadoc.internal.doclets.toolkit.util.ClassTree.SubtypeMap

Annotations

@SuppressWarnings:serial

A map giving the subtypes for each of a collection of type elements. The subtypes may be subclasses or subinterfaces, depending on the context. The subtypes are recorded by calling addSubtype.

Field Summary

Modifier and Type	Field and Description
private final Comparator<Element>	comparator

Constructor Summary

Access	Constructor and Description
pack-priv	SubtypeMap(Comparator<Element> the comparator comparator) Creates a map to provide the subtypes of a type element, sorted according to a given comparator.

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	Returns: `true` if this set did not already contain the specified element addSubtype(TypeElement the type element typeElement, TypeElement the subtype subtype) Adds a subtype into the set of subtypes for a type element
pack-priv SortedSet<TypeElement>	Returns: the subtypes for a type element, or an empty set if there are none getSubtypes(TypeElement the type element typeElement) Returns the subtypes for a type element, or an empty set if there are none.

Field Detail

comparator	back to summary
private final Comparator<Element> comparator

Constructor Detail

SubtypeMap	back to summary
pack-priv SubtypeMap(Comparator<Element> comparator) Creates a map to provide the subtypes of a type element, sorted according to a given comparator. An alternate implementation would be to store the subtypes unsorted, and to lazily sort them when needed, such as when generating documentation. Parameters comparator:Comparator<Element> the comparator

SubtypeMap

back to summary

pack-priv SubtypeMap(Comparator<Element> comparator)

Creates a map to provide the subtypes of a type element, sorted according to a given comparator. An alternate implementation would be to store the subtypes unsorted, and to lazily sort them when needed, such as when generating documentation.

Parameters

comparator:Comparator<Element>: the comparator

Method Detail

addSubtype back to summary

addSubtype	back to summary
pack-priv boolean addSubtype(TypeElement typeElement, TypeElement subtype) Adds a subtype into the set of subtypes for a type element Parameters typeElement:TypeElement the type element subtype:TypeElement the subtype Returns:boolean `true` if this set did not already contain the specified element

pack-priv boolean addSubtype(TypeElement typeElement, TypeElement subtype)

Adds a subtype into the set of subtypes for a type element

Parameters

typeElement:TypeElement: the type element
subtype:TypeElement: the subtype

Returns:boolean

true if this set did not already contain the specified element

getSubtypes	back to summary
pack-priv SortedSet<TypeElement> getSubtypes(TypeElement typeElement) Returns the subtypes for a type element, or an empty set if there are none. Parameters typeElement:TypeElement the type element Returns:SortedSet<TypeElement> the subtypes for a type element, or an empty set if there are none

getSubtypes

back to summary

pack-priv SortedSet<TypeElement> getSubtypes(TypeElement typeElement)

Returns the subtypes for a type element, or an empty set if there are none.

Parameters

typeElement:TypeElement: the type element

Returns:SortedSet<TypeElement>

the subtypes for a type element, or an empty set if there are none

public Class ClassTree

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ClassTree.Hierarchy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum ClassTree.HierarchyKind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ClassTree.SubtypeMap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail