Package org.hibernate.models.spi

Interface ClassDetails

All Superinterfaces:

AnnotationTarget, Storable<ClassDetails,SerialClassDetails>, TypeVariableScope

All Known Subinterfaces:

ClassDetailsSupport, MutableClassDetails

All Known Implementing Classes:

DynamicClassDetails, JdkClassDetails, MissingPackageInfoDetails, SimpleClassDetails

public interface ClassDetails
extends AnnotationTarget, TypeVariableScope, Storable<ClassDetails,SerialClassDetails>

Abstraction for what Hibernate understands about a "class", generally before it has access to the actual Class reference, if there is a Class at all (dynamic models).

See Also:

• ClassDetailsRegistry

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ClassDetails.ClassDetailsConsumer

Nested classes/interfaces inherited from interface org.hibernate.models.spi.AnnotationTarget

AnnotationTarget.AnnotationUsageProcessor<T,A extends Annotation>, AnnotationTarget.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static final ClassDetails	CLASS_CLASS_DETAILS	Details for Class.class
static final ClassDetails	OBJECT_CLASS_DETAILS	Details for Object.class
static final ClassDetails	VOID_CLASS_DETAILS	Details for void.class
static final ClassDetails	VOID_OBJECT_CLASS_DETAILS	Details for Void.class

Method Summary

Modifier and Type	Method	Description
default <A extends Annotation> AnnotationDescriptor<A>	asAnnotationDescriptor()	Safe cast method for cases when the target is an annotation.
default ClassDetails	asClassDetails()	Safe cast method for cases when the target is a class.
default FieldDetails	asFieldDetails()	Safe cast method for cases when the target is a field.
default MemberDetails	asMemberDetails()	Safe cast method for cases when the target is a field, method or record component.
default MethodDetails	asMethodDetails()	Safe cast method for cases when the target is a method.
default RecordComponentDetails	asRecordComponentDetails()	Safe cast method for cases when the target is a record component.
default ClassDetails	determineRawClass()	Determine the raw class for the given type.
default FieldDetails	findField(Predicate<FieldDetails> check)	Find a field by check
default FieldDetails	findFieldByName(String name)	Find a field by name
default RecordComponentDetails	findRecordComponent(Predicate<RecordComponentDetails> check)	Find a record component by check
default RecordComponentDetails	findRecordComponentByName(String name)	Find a record component by name
void	forEachField(IndexedConsumer<FieldDetails> consumer)	Visit each field
default void	forEachMember(Consumer<MemberDetails> consumer)
void	forEachMethod(IndexedConsumer<MethodDetails> consumer)	Visit each method
default void	forEachPersistableMember(Consumer<MemberDetails> consumer)
void	forEachRecordComponent(IndexedConsumer<RecordComponentDetails> consumer)	Visit each method
default void	forEachSuper(ClassDetails.ClassDetailsConsumer consumer)	Walk our super-classes passing each to the consumer
default void	forSelfAndEachSuper(ClassDetails.ClassDetailsConsumer consumer)	Pass ourselves into the consumer and then the same for each super class
String	getClassName()	The name of the Class, or null for dynamic models.
default ClassDetails	getContainer(ModelsContext modelsContext)	Get the ClassDetails for the class which is the "container" for this target. For a member (org.hib.Thing#id), this will be the declaring type (org.hib.Thing).
List<FieldDetails>	getFields()	Get the fields for this class
TypeDetails	getGenericSuperType()	Generic type information for this class.
List<TypeDetails>	getImplementedInterfaces()	Details for the interfaces this class implements.
default AnnotationTarget.Kind	getKind()	The kind of target
List<MethodDetails>	getMethods()	Get the methods for this class
String	getName()	The name of the class.
List<RecordComponentDetails>	getRecordComponents()	Get the record components for this class
ClassDetails	getSuperClass()	Details for the class that is the super type for this class.
List<TypeVariableDetails>	getTypeParameters()	Access to the type parameters associated with this class.
boolean	isAbstract()	Whether the class should be considered abstract.
boolean	isEnum()	Whether this class is an enum
boolean	isImplementor(Class<?> checkType)	Whether the described class is an implementor of the given checkType.
boolean	isInterface()	Whether this class is an interface
boolean	isRecord()	Where the class is a Java record
boolean	isResolved()	Whether the Class, if one, represented by this ClassDetails is already loaded on the ClassLoader used for loading.
default boolean	isSuperclass(ClassDetails classDetails)	Returns true is the provided classDetails is a superclass of this class, false otherwise
default TypeDetails	resolveTypeVariable(TypeVariableDetails typeVariable)	Resolve the type of the provided type variable relative to this scope.
<X> Class<X>	toJavaClass()	Load the corresponding Class using standard ClassLoading.
<X> Class<X>	toJavaClass(ClassLoading classLoading, ModelsContext modelContext)	Load the corresponding Class using the specifiedClassLoading.

Methods inherited from interface org.hibernate.models.spi.AnnotationTarget

forEachAnnotationUsage, forEachAnnotationUsage, forEachDirectAnnotationUsage, forEachRepeatedAnnotationUsages, forEachRepeatedAnnotationUsages, fromAnnotations, fromContainers, fromSelfAndContainers, getAnnotationUsage, getAnnotationUsage, getDirectAnnotationUsage, getDirectAnnotationUsage, getDirectAnnotationUsages, getMetaAnnotated, getNamedAnnotationUsage, getNamedAnnotationUsage, getNamedAnnotationUsage, getNamedAnnotationUsage, getRepeatedAnnotationUsages, getRepeatedAnnotationUsages, hasAnnotationUsage, hasDirectAnnotationUsage, locateAnnotationUsage, walkContainers, walkSelfAndContainers

Methods inherited from interface org.hibernate.models.serial.spi.Storable

toStorableForm

Field Details

OBJECT_CLASS_DETAILS

static final ClassDetails OBJECT_CLASS_DETAILS

Details for Object.class

CLASS_CLASS_DETAILS

static final ClassDetails CLASS_CLASS_DETAILS

Details for Class.class

VOID_CLASS_DETAILS

static final ClassDetails VOID_CLASS_DETAILS

Details for void.class

VOID_OBJECT_CLASS_DETAILS

static final ClassDetails VOID_OBJECT_CLASS_DETAILS

Details for Void.class

Method Details

getKind

default AnnotationTarget.Kind getKind()

Description copied from interface: AnnotationTarget

The kind of target

Specified by:

getKind in interface AnnotationTarget

getName

String getName()

The name of the class.

Generally this is the same as the class name. But in the case of Hibernate's entity-name feature, this would be the entity-name

Specified by:

getName in interface AnnotationTarget

getClassName

String getClassName()

The name of the Class, or null for dynamic models.

API Note:

Will be null for dynamic models

getContainer

default ClassDetails getContainer(ModelsContext modelsContext)

Description copied from interface: AnnotationTarget

Get the ClassDetails for the class which is the "container" for this target.

• For a member (org.hib.Thing#id), this will be the declaring type (org.hib.Thing).
• For a class (org.hib.Thing), this will be the ClassDetails for its package (org.hib.package-info)
• For a package (org.hib.package-info), this will be the ClassDetails for the containing package (org.package-info)

Specified by:

getContainer in interface AnnotationTarget

isResolved

boolean isResolved()

Whether the Class, if one, represented by this ClassDetails is already loaded on the ClassLoader used for loading.

Returns:

true when there is a physical backing class, and it is loaded; false otherwise.

isAbstract

boolean isAbstract()

Whether the class should be considered abstract.

isInterface

boolean isInterface()

Whether this class is an interface

isEnum

boolean isEnum()

Whether this class is an enum

isRecord

boolean isRecord()

Where the class is a Java record

getSuperClass

ClassDetails getSuperClass()

Details for the class that is the super type for this class.

getGenericSuperType

TypeDetails getGenericSuperType()

Generic type information for this class.

getImplementedInterfaces

List<TypeDetails> getImplementedInterfaces()

Details for the interfaces this class implements.

getTypeParameters

List<TypeVariableDetails> getTypeParameters()

Access to the type parameters associated with this class.

forEachSuper

default void forEachSuper(ClassDetails.ClassDetailsConsumer consumer)

Walk our super-classes passing each to the consumer

forSelfAndEachSuper

default void forSelfAndEachSuper(ClassDetails.ClassDetailsConsumer consumer)

Pass ourselves into the consumer and then the same for each super class

isSuperclass

default boolean isSuperclass(ClassDetails classDetails)

Returns true is the provided classDetails is a superclass of this class, false otherwise

resolveTypeVariable

default TypeDetails resolveTypeVariable(TypeVariableDetails typeVariable)

Description copied from interface: TypeVariableScope

Resolve the type of the provided type variable relative to this scope.

For example, given

 class Thing<I extends Number> {
     I id;
 }
 

A call to this method on the Thing scope with the type variable representing I will return the I extends Number type variable definition itself.

If this scope defines a corresponding type argument, the concrete type is returned. For example, given

 class Stuff extends Thing<Integer> {
 }
 

This method will yield the Integer type details.

Specified by:

resolveTypeVariable in interface TypeVariableScope

Parameters:

typeVariable - The type variable to resolve

Returns:

The type variable's resolved type, or null if none could be found

determineRawClass

default ClassDetails determineRawClass()

Description copied from interface: TypeVariableScope

Determine the raw class for the given type. Never returns null, opting to return Object instead if the raw class is not known

Specified by:

determineRawClass in interface TypeVariableScope

Returns:

The raw class details, or Object if "not known".

isImplementor

boolean isImplementor(Class<?> checkType)

Whether the described class is an implementor of the given checkType.

getFields

List<FieldDetails> getFields()

Get the fields for this class

forEachField

void forEachField(IndexedConsumer<FieldDetails> consumer)

Visit each field

findField

default FieldDetails findField(Predicate<FieldDetails> check)

Find a field by check

findFieldByName

default FieldDetails findFieldByName(String name)

Find a field by name

getMethods

List<MethodDetails> getMethods()

Get the methods for this class

forEachMethod

void forEachMethod(IndexedConsumer<MethodDetails> consumer)

Visit each method

getRecordComponents

List<RecordComponentDetails> getRecordComponents()

Get the record components for this class

findRecordComponent

default RecordComponentDetails findRecordComponent(Predicate<RecordComponentDetails> check)

Find a record component by check

findRecordComponentByName

default RecordComponentDetails findRecordComponentByName(String name)

Find a record component by name

forEachRecordComponent

void forEachRecordComponent(IndexedConsumer<RecordComponentDetails> consumer)

Visit each method

forEachMember

default void forEachMember(Consumer<MemberDetails> consumer)

forEachPersistableMember

default void forEachPersistableMember(Consumer<MemberDetails> consumer)

toJavaClass

<X> Class<X> toJavaClass()

Load the corresponding Class using standard ClassLoading.

Throws:

DynamicClassException - If this ClassDetails does not correspond to a Java class (generally meaning getClassName() returns null).

See Also:

• ModelsContext.getClassLoading()

API Note:

Know what you are doing before calling this method

toJavaClass

<X> Class<X> toJavaClass(ClassLoading classLoading,
 ModelsContext modelContext)

Load the corresponding Class using the specifiedClassLoading.

Parameters:

classLoading - Where to load the class from/into

modelContext - The model context

Throws:

DynamicClassException - If this ClassDetails does not correspond to a Java class (generally meaning getClassName() returns null).

asClassDetails

default ClassDetails asClassDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a class.

Specified by:

asClassDetails in interface AnnotationTarget

asAnnotationDescriptor

default <A extends Annotation>
AnnotationDescriptor<A> asAnnotationDescriptor()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is an annotation.

Specified by:

asAnnotationDescriptor in interface AnnotationTarget

asMemberDetails

default MemberDetails asMemberDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a field, method or record component.

Specified by:

asMemberDetails in interface AnnotationTarget

asFieldDetails

default FieldDetails asFieldDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a field.

Specified by:

asFieldDetails in interface AnnotationTarget

asMethodDetails

default MethodDetails asMethodDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a method.

Specified by:

asMethodDetails in interface AnnotationTarget

asRecordComponentDetails

default RecordComponentDetails asRecordComponentDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a record component.

Specified by:

asRecordComponentDetails in interface AnnotationTarget