OpenJDK 27 · jdk.javadoc.internal.doclets.toolkit.util.ClassUseMapper

Field Summary

Modifier and Type	Field and Description
public final Map<TypeElement, List<VariableElement>>	annotationToField The mapping of TypeElements representing annotation to fields that use them.
public final Map<TypeElement, Set<TypeElement>>	classToClass Mapping of TypeElements to a set of TypeElements used by that class.
public final Map<TypeElement, List<TypeElement>>	classToClassAnnotations The mapping of TypeElement representing annotation to TypeElements that use them.
public final Map<TypeElement, List<TypeElement>>	classToClassTypeParam The mapping of TypeElement to TypeElement that use them as type parameters.
public final Map<TypeElement, List<ExecutableElement>>	classToConstructorAnnotations The mapping of TypeElements representing annotations to constructors that use them.
public final Map<TypeElement, List<ExecutableElement>>	classToConstructorArgs Mapping of TypeElements to list of ExecutableElements (constructors) having that class as an arg.
public final Map<TypeElement, List<ExecutableElement>>	classToConstructorArgTypeParam The mapping of TypeElements to constructor arguments that use them as type parameters.
public final Map<TypeElement, List<ExecutableElement>>	classToConstructorParamAnnotation The mapping of TypeElement representing annotations to constructor parameters that use them.
public final Map<TypeElement, List<ExecutableElement>>	classToConstructorThrows Mapping of TypeElements to list of constructors which throws that class.
public final Map<TypeElement, List<VariableElement>>	classToField Mapping of TypeElements to list of VariableElements declared as that class.
public final Map<TypeElement, List<VariableElement>>	classToFieldTypeParam The mapping of TypeElements to fields that use them as type parameters.
public final Map<TypeElement, List<TypeElement>>	classToImplementingClass Mapping of TypeElements to list of TypeElements which implement this interface.
public final Map<TypeElement, List<TypeElement>>	classToImplementsTypeParam Mapping of TypeElements to list of TypeElements which use them in implemented interface type parameters.
public final Map<TypeElement, List<ExecutableElement>>	classToMethodAnnotations The mapping of TypeElement representing annotation to methods that use them.
public final Map<TypeElement, List<ExecutableElement>>	classToMethodArgs Mapping of TypeElements to list of ExecutableElements having that class as an arg.
public final Map<TypeElement, List<ExecutableElement>>	classToMethodArgTypeParam The mapping of TypeElement to method arguments that use them as type parameters.
public final Map<TypeElement, List<ExecutableElement>>	classToMethodParamAnnotation The mapping of TypeElements representing annotations to method parameters that use them.
public final Map<TypeElement, List<ExecutableElement>>	classToMethodReturn Mapping of TypeElements to list of ExecutableElements returning that class.
public final Map<TypeElement, List<ExecutableElement>>	classToMethodReturnTypeParam The mapping of TypeElements to methods that have return type with type parameters of that class.
public final Map<TypeElement, List<ExecutableElement>>	classToMethodThrows Mapping of TypeElements to list of ExecutableElements which throws that class.
public final Map<TypeElement, List<ExecutableElement>>	classToMethodTypeParam The mapping of TypeElement to methods that use them as type parameters.
public final Map<TypeElement, Set<PackageElement>>	classToPackage Mapping of TypeElements to set of PackageElements used by that class.
public final Map<TypeElement, List<PackageElement>>	classToPackageAnnotations Mapping of TypeElements representing annotations to a set of PackageElements that use the annotation.
public final Map<TypeElement, List<TypeElement>>	classToSubclass Mapping of TypeElements to a list of TypeElements which are direct or indirect subClasses of that class.
public final Map<TypeElement, List<TypeElement>>	classToSubclassTypeParam Mapping of TypeElements to list of TypeElements which use them in superclass type parameters.
public final Map<TypeElement, List<TypeElement>>	classToSubinterface Mapping of TypeElements to list of TypeElements which are direct or indirect subInterfaces of that interface.
public final Map<TypeElement, List<TypeElement>>	classToSubinterfaceTypeParam Mapping of TypeElements to list of TypeElements which use them in superinterface type parameters.
private final ClassTree	classTree
private final Comparators	comparators
private final DocletEnvironment	docEnv
private final Elements	elementUtils
private final Types	typeUtils
private final Utils	utils

Constructor Summary

Access	Constructor and Description
public	ClassUseMapper(BaseConfiguration configuration, ClassTree classTree)

Method Summary

Modifier and Type	Method and Description
private <T extends Element> void	add(Map<TypeElement, List<T>> map, TypeElement te, T ref)
private void	addAll(Map<TypeElement, List<TypeElement>> map, TypeElement te, Collection<TypeElement> refs)
private <T extends Element> void	addTypeParameterToMap(final Map<TypeElement, List<T>> map, TypeMirror type, final T holder)
private Set<TypeElement>	classSet(TypeElement te)
private Collection<TypeElement>	implementingClasses(TypeElement te) Return all implementing classes of an interface (including all subClasses of implementing classes and all classes implementing subInterfaces) AND fill-in both classToImplementingClass and classToSubinterface maps.
private <T extends Element> void	mapAnnotations(final Map<TypeElement, List<T>> the map the insert the information into. map, Element whose type parameters are being checked. e, final T owning the type parameters. holder) Map the AnnotationType to the members that use them as type parameters.
private void	mapExecutable(ExecutableElement ee) Determine classes used by a method or constructor, so they can be inverse mapped.
private <T extends Element> void	mapTypeParameters(final Map<TypeElement, List<T>> the map the insert the information into. map, Element the te whose type parameters are being checked. element, final T the holder that owns the type parameters. holder) Map the TypeElements to the members that use them as type parameters.
private <T extends Element> void	mapTypeParameters(final Map<TypeElement, List<T>> map, TypeMirror aType, final T holder)
private Set<PackageElement>	packageSet(TypeElement te)
private <T> List<T>	refList(Map<TypeElement, List<T>> map, TypeElement element)
private Collection<TypeElement>	subclasses(TypeElement te) Return all subClasses of a class AND fill-in classToSubclass map.
private Collection<TypeElement>	subinterfaces(TypeElement te) Return all subInterfaces of an interface AND fill-in classToSubinterface map.

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

Field Detail

annotationToField	back to summary
public final Map<TypeElement, List<VariableElement>> annotationToField The mapping of TypeElements representing annotation to fields that use them.

classToClass	back to summary
public final Map<TypeElement, Set<TypeElement>> classToClass Mapping of TypeElements to a set of TypeElements used by that class.

classToClassAnnotations	back to summary
public final Map<TypeElement, List<TypeElement>> classToClassAnnotations The mapping of TypeElement representing annotation to TypeElements that use them.

classToClassTypeParam	back to summary
public final Map<TypeElement, List<TypeElement>> classToClassTypeParam The mapping of TypeElement to TypeElement that use them as type parameters.

classToConstructorAnnotations	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToConstructorAnnotations The mapping of TypeElements representing annotations to constructors that use them.

classToConstructorArgs	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToConstructorArgs Mapping of TypeElements to list of ExecutableElements (constructors) having that class as an arg.

classToConstructorArgTypeParam	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToConstructorArgTypeParam The mapping of TypeElements to constructor arguments that use them as type parameters.

classToConstructorParamAnnotation	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToConstructorParamAnnotation The mapping of TypeElement representing annotations to constructor parameters that use them.

classToConstructorThrows	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToConstructorThrows Mapping of TypeElements to list of constructors which throws that class.

classToField	back to summary
public final Map<TypeElement, List<VariableElement>> classToField Mapping of TypeElements to list of VariableElements declared as that class.

classToFieldTypeParam	back to summary
public final Map<TypeElement, List<VariableElement>> classToFieldTypeParam The mapping of TypeElements to fields that use them as type parameters.

classToImplementingClass	back to summary
public final Map<TypeElement, List<TypeElement>> classToImplementingClass Mapping of TypeElements to list of TypeElements which implement this interface.

classToImplementsTypeParam	back to summary
public final Map<TypeElement, List<TypeElement>> classToImplementsTypeParam Mapping of TypeElements to list of TypeElements which use them in implemented interface type parameters.

classToMethodAnnotations	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToMethodAnnotations The mapping of TypeElement representing annotation to methods that use them.

classToMethodArgs	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToMethodArgs Mapping of TypeElements to list of ExecutableElements having that class as an arg.

classToMethodArgTypeParam	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToMethodArgTypeParam The mapping of TypeElement to method arguments that use them as type parameters.

classToMethodParamAnnotation	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToMethodParamAnnotation The mapping of TypeElements representing annotations to method parameters that use them.

classToMethodReturn	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToMethodReturn Mapping of TypeElements to list of ExecutableElements returning that class.

classToMethodReturnTypeParam	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToMethodReturnTypeParam The mapping of TypeElements to methods that have return type with type parameters of that class.

classToMethodThrows	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToMethodThrows Mapping of TypeElements to list of ExecutableElements which throws that class.

classToMethodTypeParam	back to summary
public final Map<TypeElement, List<ExecutableElement>> classToMethodTypeParam The mapping of TypeElement to methods that use them as type parameters.

classToPackage	back to summary
public final Map<TypeElement, Set<PackageElement>> classToPackage Mapping of TypeElements to set of PackageElements used by that class.

classToPackageAnnotations	back to summary
public final Map<TypeElement, List<PackageElement>> classToPackageAnnotations Mapping of TypeElements representing annotations to a set of PackageElements that use the annotation.

classToSubclass	back to summary
public final Map<TypeElement, List<TypeElement>> classToSubclass Mapping of TypeElements to a list of TypeElements which are direct or indirect subClasses of that class.

classToSubclassTypeParam	back to summary
public final Map<TypeElement, List<TypeElement>> classToSubclassTypeParam Mapping of TypeElements to list of TypeElements which use them in superclass type parameters.

classToSubinterface	back to summary
public final Map<TypeElement, List<TypeElement>> classToSubinterface Mapping of TypeElements to list of TypeElements which are direct or indirect subInterfaces of that interface.

classToSubinterfaceTypeParam	back to summary
public final Map<TypeElement, List<TypeElement>> classToSubinterfaceTypeParam Mapping of TypeElements to list of TypeElements which use them in superinterface type parameters.

classTree	back to summary
private final ClassTree classTree

comparators	back to summary
private final Comparators comparators

docEnv	back to summary
private final DocletEnvironment docEnv

elementUtils	back to summary
private final Elements elementUtils

typeUtils	back to summary
private final Types typeUtils

utils	back to summary
private final Utils utils

Constructor Detail

ClassUseMapper	back to summary
public ClassUseMapper(BaseConfiguration configuration, ClassTree classTree)

Method Detail

add	back to summary
private <T extends Element> void add(Map<TypeElement, List<T>> map, TypeElement te, T ref)

addAll	back to summary
private void addAll(Map<TypeElement, List<TypeElement>> map, TypeElement te, Collection<TypeElement> refs)

addTypeParameterToMap	back to summary
private <T extends Element> void addTypeParameterToMap(final Map<TypeElement, List<T>> map, TypeMirror type, final T holder)

classSet	back to summary
private Set<TypeElement> classSet(TypeElement te)

implementingClasses	back to summary
private Collection<TypeElement> implementingClasses(TypeElement te) Return all implementing classes of an interface (including all subClasses of implementing classes and all classes implementing subInterfaces) AND fill-in both classToImplementingClass and classToSubinterface maps.

mapAnnotations	back to summary
private <T extends Element> void mapAnnotations(final Map<TypeElement, List<T>> map, Element e, final T holder) Map the AnnotationType to the members that use them as type parameters. Parameters map:Map<TypeElement, List<T>> the map the insert the information into. e:Element whose type parameters are being checked. holder:T owning the type parameters.

mapAnnotations

back to summary

private <T extends Element> void mapAnnotations(final Map<TypeElement, List<T>> map, Element e, final T holder)

Map the AnnotationType to the members that use them as type parameters.

Parameters

map:Map<TypeElement, List<T>>: the map the insert the information into.
e:Element: whose type parameters are being checked.
holder:T: owning the type parameters.

mapExecutable	back to summary
private void mapExecutable(ExecutableElement ee) Determine classes used by a method or constructor, so they can be inverse mapped.

mapTypeParameters	back to summary
private <T extends Element> void mapTypeParameters(final Map<TypeElement, List<T>> map, Element element, final T holder) Map the TypeElements to the members that use them as type parameters. Parameters map:Map<TypeElement, List<T>> the map the insert the information into. element:Element the te whose type parameters are being checked. holder:T the holder that owns the type parameters.

mapTypeParameters