OpenJDK 27 · java.lang.classfile.ClassHierarchyResolver

Modifier and Type	Class and Description
public static interface	ClassHierarchyResolver.ClassHierarchyInfo Information about a resolved class.

Method Summary

Modifier and Type	Method and Description
public default ClassHierarchyResolver	Returns: a `ClassHierarchyResolver` that caches class hierarchy information from this resolver cached(Supplier<Map<ClassDesc, ClassHierarchyResolver.ClassHierarchyInfo>> the factory for the cache cacheFactory) Returns a `ClassHierarchyResolver` that caches class hierarchy information from this resolver.
public default ClassHierarchyResolver	Returns: a `ClassHierarchyResolver` that caches class hierarchy information from this resolver cached() Returns a `ClassHierarchyResolver` that caches class hierarchy information from this resolver.
public static ClassHierarchyResolver	Returns: the default instance of `ClassHierarchyResolver` that gets `ClassHierarchyInfo` from system class loader with reflection defaultResolver() Returns the default instance of `ClassHierarchyResolver` that gets `ClassHierarchyInfo` from system class loader with reflection.
public ClassHierarchyResolver.ClassHierarchyInfo	Returns: the `ClassHierarchyInfo` for a given class name, or `null` if the name is unknown to the resolver getClassInfo(ClassDesc descriptor of the class classDesc) Returns the `ClassHierarchyInfo` for a given class name, or `null` if the name is unknown to the resolver.
public static ClassHierarchyResolver	Returns: a `ClassHierarchyResolver` that extracts class hierarchy information from collections of class hierarchy metadata of(Collection<ClassDesc> a collection of classes known to be interfaces interfaces, Map<ClassDesc, ClassDesc> a map from classes to their super classes classToSuperClass) Returns a `ClassHierarchyResolver` that extracts class hierarchy information from collections of class hierarchy metadata.
public static ClassHierarchyResolver	Returns: a `ClassHierarchyResolver` that extracts class hierarchy information via classes loaded by a class loader with reflection ofClassLoading(ClassLoader the class loader loader) Returns a `ClassHierarchyResolver` that extracts class hierarchy information via classes loaded by a class loader with reflection.
public static ClassHierarchyResolver	Returns: a `ClassHierarchyResolver` that extracts class hierarchy information via classes accessible to a `MethodHandles.Lookup` with reflection ofClassLoading(MethodHandles.Lookup the lookup, must be able to access classes to resolve lookup) Returns a `ClassHierarchyResolver` that extracts class hierarchy information via classes accessible to a `MethodHandles.Lookup` with reflection.
public static ClassHierarchyResolver	Returns: a `ClassHierarchyResolver` that extracts class hierarchy information from `class` files returned by a mapping function ofResourceParsing(Function<ClassDesc, InputStream> maps class descriptors to `class` file input streams classStreamResolver) Returns a `ClassHierarchyResolver` that extracts class hierarchy information from `class` files returned by a mapping function.
public static ClassHierarchyResolver	Returns: a `ClassHierarchyResolver` that extracts class hierarchy information from `class` files located by a class loader ofResourceParsing(ClassLoader the class loader, to find class files loader) Returns a `ClassHierarchyResolver` that extracts class hierarchy information from `class` files located by a class loader.
public default ClassHierarchyResolver	Returns: the chained resolver orElse(ClassHierarchyResolver the other resolver other) Chains this `ClassHierarchyResolver` with another to be consulted if this resolver does not know about the specified class.

Method Detail

cached back to summary

cached	back to summary
public default ClassHierarchyResolver cached(Supplier<Map<ClassDesc, ClassHierarchyResolver.ClassHierarchyInfo>> cacheFactory) Returns a `ClassHierarchyResolver` that caches class hierarchy information from this resolver. The returned resolver will not update if the query results from this resolver changed over time. The thread safety of the returned resolver depends on the thread safety of the map returned by the `cacheFactory`. Implementation Specification The default implementation returns a resolver holding an instance of the cache map provided by the `cacheFactory`. It looks up in the cache map, or if a class name has not yet been queried, queries this resolver and caches the result, including a `null` that indicates unknown class names. The cache map may refuse `null` keys and values. Parameters cacheFactory:Supplier<Map<ClassDesc, ClassHierarchyResolver.ClassHierarchyInfo>> the factory for the cache Returns:ClassHierarchyResolver a `ClassHierarchyResolver` that caches class hierarchy information from this resolver

public default ClassHierarchyResolver cached(Supplier<Map<ClassDesc, ClassHierarchyResolver.ClassHierarchyInfo>> cacheFactory)

Returns a ClassHierarchyResolver that caches class hierarchy information from this resolver. The returned resolver will not update if the query results from this resolver changed over time. The thread safety of the returned resolver depends on the thread safety of the map returned by the cacheFactory.

Implementation Specification

The default implementation returns a resolver holding an instance of the cache map provided by the cacheFactory. It looks up in the cache map, or if a class name has not yet been queried, queries this resolver and caches the result, including a null that indicates unknown class names. The cache map may refuse null keys and values.

Parameters

cacheFactory:Supplier<Map<ClassDesc, ClassHierarchyResolver.ClassHierarchyInfo>>: the factory for the cache

Returns:ClassHierarchyResolver

a ClassHierarchyResolver that caches class hierarchy information from this resolver

cached back to summary

cached	back to summary
public default ClassHierarchyResolver cached() Returns a `ClassHierarchyResolver` that caches class hierarchy information from this resolver. The returned resolver will not update if the query results from this resolver changed over time. The returned resolver is not thread-safe. `MethodHandles.Lookup lookup = MethodHandles.lookup(); ClassHierarchyResolver resolver = ClassHierarchyResolver.ofClassLoading(lookup).cached();` MethodHandles.Lookup lookup = ...; ClassHierarchyResolver resolver = ClassHierarchyResolver.ofClassLoading(lookup).cached(); Implementation Specification The default implementation calls `cached(Supplier)` with `HashMap` supplier as `cacheFactory`. Returns:ClassHierarchyResolver a `ClassHierarchyResolver` that caches class hierarchy information from this resolver

public default ClassHierarchyResolver cached()

MethodHandles.Lookup lookup = ...;
ClassHierarchyResolver resolver = ClassHierarchyResolver.ofClassLoading(lookup).cached();

Implementation Specification

The default implementation calls cached(Supplier) with HashMap supplier as cacheFactory.

Returns:ClassHierarchyResolver: a ClassHierarchyResolver that caches class hierarchy information from this resolver

defaultResolver back to summary

defaultResolver	back to summary
public static ClassHierarchyResolver defaultResolver() Returns the default instance of `ClassHierarchyResolver` that gets `ClassHierarchyInfo` from system class loader with reflection. This default instance cannot load classes from other class loaders, such as the caller's class loader; it also loads the system classes if they are not yet loaded, which makes it unsuitable for instrumentation. Returns:ClassHierarchyResolver the default instance of `ClassHierarchyResolver` that gets `ClassHierarchyInfo` from system class loader with reflection

public static ClassHierarchyResolver defaultResolver()

Returns the default instance of ClassHierarchyResolver that gets ClassHierarchyInfo from system class loader with reflection. This default instance cannot load classes from other class loaders, such as the caller's class loader; it also loads the system classes if they are not yet loaded, which makes it unsuitable for instrumentation.

Returns:ClassHierarchyResolver: the default instance of ClassHierarchyResolver that gets ClassHierarchyInfo from system class loader with reflection

getClassInfo back to summary

getClassInfo	back to summary
public ClassHierarchyResolver.ClassHierarchyInfo getClassInfo(ClassDesc classDesc) Returns the `ClassHierarchyInfo` for a given class name, or `null` if the name is unknown to the resolver. This method is called by the Class-File API to obtain the hierarchy information of a class or interface; users should not call this method. The symbolic descriptor passed by the Class-File API always represents a class or interface. Parameters classDesc:ClassDesc descriptor of the class Returns:ClassHierarchyResolver.ClassHierarchyInfo the `ClassHierarchyInfo` for a given class name, or `null` if the name is unknown to the resolver Exceptions IllegalArgumentException: if a class shouldn't be queried for hierarchy, such as when it is inaccessible

public ClassHierarchyResolver.ClassHierarchyInfo getClassInfo(ClassDesc classDesc)

Returns the ClassHierarchyInfo for a given class name, or null if the name is unknown to the resolver.

This method is called by the Class-File API to obtain the hierarchy information of a class or interface; users should not call this method. The symbolic descriptor passed by the Class-File API always represents a class or interface.

Parameters

classDesc:ClassDesc: descriptor of the class

Returns:ClassHierarchyResolver.ClassHierarchyInfo

the ClassHierarchyInfo for a given class name, or null if the name is unknown to the resolver

Exceptions

IllegalArgumentException:: if a class shouldn't be queried for hierarchy, such as when it is inaccessible

of back to summary

of	back to summary
public static ClassHierarchyResolver of(Collection<ClassDesc> interfaces, Map<ClassDesc, ClassDesc> classToSuperClass) Returns a `ClassHierarchyResolver` that extracts class hierarchy information from collections of class hierarchy metadata. Parameters interfaces:Collection<ClassDesc> a collection of classes known to be interfaces classToSuperClass:Map<ClassDesc, ClassDesc> a map from classes to their super classes Returns:ClassHierarchyResolver a `ClassHierarchyResolver` that extracts class hierarchy information from collections of class hierarchy metadata

public static ClassHierarchyResolver of(Collection<ClassDesc> interfaces, Map<ClassDesc, ClassDesc> classToSuperClass)

Returns a ClassHierarchyResolver that extracts class hierarchy information from collections of class hierarchy metadata.

Parameters

interfaces:Collection<ClassDesc>: a collection of classes known to be interfaces
classToSuperClass:Map<ClassDesc, ClassDesc>: a map from classes to their super classes

Returns:ClassHierarchyResolver

a ClassHierarchyResolver that extracts class hierarchy information from collections of class hierarchy metadata

ofClassLoading back to summary

ofClassLoading	back to summary
public static ClassHierarchyResolver ofClassLoading(ClassLoader loader) Returns a `ClassHierarchyResolver` that extracts class hierarchy information via classes loaded by a class loader with reflection. Parameters loader:ClassLoader the class loader Returns:ClassHierarchyResolver a `ClassHierarchyResolver` that extracts class hierarchy information via classes loaded by a class loader with reflection

public static ClassHierarchyResolver ofClassLoading(ClassLoader loader)

Returns a ClassHierarchyResolver that extracts class hierarchy information via classes loaded by a class loader with reflection.

Parameters

loader:ClassLoader: the class loader

Returns:ClassHierarchyResolver

a ClassHierarchyResolver that extracts class hierarchy information via classes loaded by a class loader with reflection

ofClassLoading back to summary

ofClassLoading	back to summary
public static ClassHierarchyResolver ofClassLoading(MethodHandles.Lookup lookup) Returns a `ClassHierarchyResolver` that extracts class hierarchy information via classes accessible to a `MethodHandles.Lookup` with reflection. If the class resolved is inaccessible to the given lookup, `getClassInfo(ClassDesc)` throws `IllegalArgumentException` instead of returning `null`. Parameters lookup:MethodHandles.Lookup the lookup, must be able to access classes to resolve Returns:ClassHierarchyResolver a `ClassHierarchyResolver` that extracts class hierarchy information via classes accessible to a `MethodHandles.Lookup` with reflection

public static ClassHierarchyResolver ofClassLoading(MethodHandles.Lookup lookup)

Returns a ClassHierarchyResolver that extracts class hierarchy information via classes accessible to a MethodHandles.Lookup with reflection. If the class resolved is inaccessible to the given lookup, getClassInfo(ClassDesc) throws IllegalArgumentException instead of returning null.

Parameters

lookup:MethodHandles.Lookup: the lookup, must be able to access classes to resolve

Returns:ClassHierarchyResolver

a ClassHierarchyResolver that extracts class hierarchy information via classes accessible to a MethodHandles.Lookup with reflection

ofResourceParsing back to summary

ofResourceParsing	back to summary
public static ClassHierarchyResolver ofResourceParsing(Function<ClassDesc, InputStream> classStreamResolver) Returns a `ClassHierarchyResolver` that extracts class hierarchy information from `class` files returned by a mapping function. The mapping function should return `null` if it cannot provide a `class` file for a class name. Any `IOException` from the provided input stream is rethrown as an `UncheckedIOException` in `getClassInfo(ClassDesc)`. Parameters classStreamResolver:Function<ClassDesc, InputStream> maps class descriptors to `class` file input streams Returns:ClassHierarchyResolver a `ClassHierarchyResolver` that extracts class hierarchy information from `class` files returned by a mapping function

public static ClassHierarchyResolver ofResourceParsing(Function<ClassDesc, InputStream> classStreamResolver)

Returns a ClassHierarchyResolver that extracts class hierarchy information from class files returned by a mapping function. The mapping function should return null if it cannot provide a class file for a class name. Any IOException from the provided input stream is rethrown as an UncheckedIOException in getClassInfo(ClassDesc).

Parameters

classStreamResolver:Function<ClassDesc, InputStream>: maps class descriptors to class file input streams

Returns:ClassHierarchyResolver

a ClassHierarchyResolver that extracts class hierarchy information from class files returned by a mapping function

ofResourceParsing back to summary

ofResourceParsing	back to summary
public static ClassHierarchyResolver ofResourceParsing(ClassLoader loader) Returns a `ClassHierarchyResolver` that extracts class hierarchy information from `class` files located by a class loader. Parameters loader:ClassLoader the class loader, to find class files Returns:ClassHierarchyResolver a `ClassHierarchyResolver` that extracts class hierarchy information from `class` files located by a class loader

public static ClassHierarchyResolver ofResourceParsing(ClassLoader loader)

Returns a ClassHierarchyResolver that extracts class hierarchy information from class files located by a class loader.

Parameters

loader:ClassLoader: the class loader, to find class files

Returns:ClassHierarchyResolver

a ClassHierarchyResolver that extracts class hierarchy information from class files located by a class loader

orElse back to summary

orElse	back to summary
public default ClassHierarchyResolver orElse(ClassHierarchyResolver other) Chains this `ClassHierarchyResolver` with another to be consulted if this resolver does not know about the specified class. Implementation Specification The default implementation returns resolver implemented to query `other` resolver in case this resolver returns `null`. Parameters other:ClassHierarchyResolver the other resolver Returns:ClassHierarchyResolver the chained resolver

public default ClassHierarchyResolver orElse(ClassHierarchyResolver other)

Chains this ClassHierarchyResolver with another to be consulted if this resolver does not know about the specified class.

Implementation Specification

The default implementation returns resolver implemented to query other resolver in case this resolver returns null.

Parameters

other:ClassHierarchyResolver: the other resolver

Returns:ClassHierarchyResolver

the chained resolver

Modifier and Type	Method and Description
public static ClassHierarchyResolver.ClassHierarchyInfo	Returns: the info indicating the super class ofClass(ClassDesc descriptor of the super class, may be `null` superClass) Indicates that a class is a declared class, with the specific given super class.
public static ClassHierarchyResolver.ClassHierarchyInfo	Returns: the info indicating an interface ofInterface() Indicates that a class is an interface.

public Interface ClassHierarchyResolver

Nested and Inner Type Summary

Method Summary

Method Detail

public sealed Interface ClassHierarchyResolver.ClassHierarchyInfo

Method Summary

Method Detail