Package org.hibernate.models.internal

Class SimpleClassDetails

java.lang.Object

org.hibernate.models.internal.SimpleClassDetails

All Implemented Interfaces:

AnnotationTarget, ClassDetails, TypeVariableScope

public class SimpleClassDetails
extends Object
implements ClassDetails

Nested Class Summary

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

AnnotationTarget.AnnotationUsageProcessor<T>, AnnotationTarget.Kind

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

ClassDetails.ClassDetailsConsumer

Field Summary

Fields inherited from interface org.hibernate.models.spi.ClassDetails

CLASS_CLASS_DETAILS, OBJECT_CLASS_DETAILS, VOID_CLASS_DETAILS, VOID_OBJECT_CLASS_DETAILS

Constructor Summary

Constructors

Constructor	Description
SimpleClassDetails(Class<?> clazz)
SimpleClassDetails(Class<?> clazz, ClassDetails superClassDetails, TypeDetails genericSuperTypeDetails)

Method Summary

Modifier and Type	Method	Description
<X extends Annotation> void	forEachAnnotationUsage(Class<X> type, Consumer<AnnotationUsage<X>> consumer)	Form of AnnotationTarget.forEachAnnotationUsage(AnnotationDescriptor, Consumer) accepting the annotation Class
void	forEachField(IndexedConsumer<FieldDetails> consumer)	Visit each field
void	forEachMethod(IndexedConsumer<MethodDetails> consumer)	Visit each method
Collection<AnnotationUsage<?>>	getAllAnnotationUsages()	Access to all the annotations used on this target.
<A extends Annotation> AnnotationUsage<A>	getAnnotationUsage(Class<A> type)	Form of AnnotationTarget.getAnnotationUsage(AnnotationDescriptor) accepting the annotation Class
<A extends Annotation> AnnotationUsage<A>	getAnnotationUsage(AnnotationDescriptor<A> descriptor)	Get the usage of the given annotation on this target.
String	getClassName()	The name of the Class, or null for dynamic models.
List<FieldDetails>	getFields()	Get the fields for this class
TypeDetails	getGenericSuperType()
List<TypeDetails>	getImplementedInterfaces()	Details for the interfaces this class implements.
<A extends Annotation> List<AnnotationUsage<? extends Annotation>>	getMetaAnnotated(Class<A> metaAnnotationType)	Returns all AnnotationUsage references from this target where the usage's annotation class is annotated with the given metaAnnotationType.
List<MethodDetails>	getMethods()	Get the methods for this class
String	getName()	The name of the class.
<X extends Annotation> AnnotationUsage<X>	getNamedAnnotationUsage(Class<X> type, String matchName, String attributeToMatch)	Helper form of AnnotationTarget.getNamedAnnotationUsage(AnnotationDescriptor, String, String)
<X extends Annotation> AnnotationUsage<X>	getNamedAnnotationUsage(AnnotationDescriptor<X> type, String matchName, String attributeToMatch)	Get a usage of the given annotation type whose attributeToMatch attribute value matches the given matchName.
List<RecordComponentDetails>	getRecordComponents()	Get the record components for this class
<A extends Annotation> List<AnnotationUsage<A>>	getRepeatedAnnotationUsages(Class<A> type)	Form of AnnotationTarget.getRepeatedAnnotationUsages(AnnotationDescriptor) accepting the annotation Class
<A extends Annotation> List<AnnotationUsage<A>>	getRepeatedAnnotationUsages(AnnotationDescriptor<A> type)	Get all usages of the specified annotationType in this scope.
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.
<A extends Annotation> boolean	hasAnnotationUsage(Class<A> type)	Whether the given annotation is used on this target.
<A extends Annotation> boolean	hasRepeatableAnnotationUsage(Class<A> type)	Whether the given annotation is used on this target.
boolean	isAbstract()	Whether the class should be considered abstract.
boolean	isImplementor(Class<?> checkType)	Whether the described class is an implementor of the given checkType.
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.
<A extends Annotation> AnnotationUsage<A>	locateAnnotationUsage(Class<A> type)	Form of AnnotationTarget.getAnnotationUsage(org.hibernate.models.spi.AnnotationDescriptor<A>) which also considers meta-annotations - annotations on the classes of each local annotation.
<X> Class<X>	toJavaClass()	Know what you are doing before calling this method
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

forAllAnnotationUsages, forEachAnnotationUsage, fromAnnotations, getNamedAnnotationUsage, getNamedAnnotationUsage, getSingleAnnotationUsage, getSingleAnnotationUsage

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

determineRawClass, findField, findFieldByName, findRecordComponent, findRecordComponentByName, forEachSuper, forSelfAndEachSuper, getKind, isSuperclass, resolveTypeVariable

Constructor Details

SimpleClassDetails

public SimpleClassDetails(Class<?> clazz)

SimpleClassDetails

public SimpleClassDetails(Class<?> clazz,
 ClassDetails superClassDetails,
 TypeDetails genericSuperTypeDetails)

Method Details

getName

public String getName()

Description copied from interface: ClassDetails

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

Specified by:

getName in interface ClassDetails

getClassName

public String getClassName()

Description copied from interface: ClassDetails

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

Specified by:

getClassName in interface ClassDetails

getSuperClass

public ClassDetails getSuperClass()

Description copied from interface: ClassDetails

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

Specified by:

getSuperClass in interface ClassDetails

getGenericSuperType

public TypeDetails getGenericSuperType()

Specified by:

getGenericSuperType in interface ClassDetails

toJavaClass

public <X> Class<X> toJavaClass()

Description copied from interface: ClassDetails

Know what you are doing before calling this method

Specified by:

toJavaClass in interface ClassDetails

toString

public String toString()

Overrides:

toString in class Object

isResolved

public boolean isResolved()

Description copied from interface: ClassDetails

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

Specified by:

isResolved in interface ClassDetails

Returns:

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

isAbstract

public boolean isAbstract()

Description copied from interface: ClassDetails

Whether the class should be considered abstract.

Specified by:

isAbstract in interface ClassDetails

isRecord

public boolean isRecord()

Description copied from interface: ClassDetails

Where the class is a Java record

Specified by:

isRecord in interface ClassDetails

getImplementedInterfaces

public List<TypeDetails> getImplementedInterfaces()

Description copied from interface: ClassDetails

Details for the interfaces this class implements.

Specified by:

getImplementedInterfaces in interface ClassDetails

getTypeParameters

public List<TypeVariableDetails> getTypeParameters()

Description copied from interface: ClassDetails

Access to the type parameters associated with this class.

Specified by:

getTypeParameters in interface ClassDetails

isImplementor

public boolean isImplementor(Class<?> checkType)

Description copied from interface: ClassDetails

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

Specified by:

isImplementor in interface ClassDetails

getFields

public List<FieldDetails> getFields()

Description copied from interface: ClassDetails

Get the fields for this class

Specified by:

getFields in interface ClassDetails

forEachField

public void forEachField(IndexedConsumer<FieldDetails> consumer)

Description copied from interface: ClassDetails

Visit each field

Specified by:

forEachField in interface ClassDetails

getMethods

public List<MethodDetails> getMethods()

Description copied from interface: ClassDetails

Get the methods for this class

Specified by:

getMethods in interface ClassDetails

forEachMethod

public void forEachMethod(IndexedConsumer<MethodDetails> consumer)

Description copied from interface: ClassDetails

Visit each method

Specified by:

forEachMethod in interface ClassDetails

getRecordComponents

public List<RecordComponentDetails> getRecordComponents()

Description copied from interface: ClassDetails

Get the record components for this class

Specified by:

getRecordComponents in interface ClassDetails

getAllAnnotationUsages

public Collection<AnnotationUsage<?>> getAllAnnotationUsages()

Description copied from interface: AnnotationTarget

Access to all the annotations used on this target.

Specified by:

getAllAnnotationUsages in interface AnnotationTarget

hasAnnotationUsage

public <A extends Annotation> boolean hasAnnotationUsage(Class<A> type)

Description copied from interface: AnnotationTarget

Whether the given annotation is used on this target.

Specified by:

hasAnnotationUsage in interface AnnotationTarget

See Also:

• AnnotationTarget.hasRepeatableAnnotationUsage(java.lang.Class<A>)

hasRepeatableAnnotationUsage

public <A extends Annotation> boolean hasRepeatableAnnotationUsage(Class<A> type)

Description copied from interface: AnnotationTarget

Whether the given annotation is used on this target.

Specified by:

hasRepeatableAnnotationUsage in interface AnnotationTarget

See Also:

• AnnotationTarget.hasAnnotationUsage(java.lang.Class<A>)

getAnnotationUsage

public <A extends Annotation> AnnotationUsage<A> getAnnotationUsage(AnnotationDescriptor<A> descriptor)

Description copied from interface: AnnotationTarget

Get the usage of the given annotation on this target.

For repeatable annotation types (e.g. @NamedQuery), this method will either-

• if a single repeatable annotation itself is present, it is returned.
• if the "containing annotation" is present (e.g. @NamedQueries),
  • if the container contains just a single repeatable, that one is returned
  • if the container contains multiple repeatables, AnnotationAccessException will be thrown

For also checking across meta-annotations, see AnnotationTarget.locateAnnotationUsage(Class).

Specified by:

getAnnotationUsage in interface AnnotationTarget

Returns:

The usage or null

getAnnotationUsage

public <A extends Annotation> AnnotationUsage<A> getAnnotationUsage(Class<A> type)

Description copied from interface: AnnotationTarget

Form of AnnotationTarget.getAnnotationUsage(AnnotationDescriptor) accepting the annotation Class

Specified by:

getAnnotationUsage in interface AnnotationTarget

locateAnnotationUsage

public <A extends Annotation> AnnotationUsage<A> locateAnnotationUsage(Class<A> type)

Description copied from interface: AnnotationTarget

Form of AnnotationTarget.getAnnotationUsage(org.hibernate.models.spi.AnnotationDescriptor<A>) which also considers meta-annotations - annotations on the classes of each local annotation.

Specified by:

locateAnnotationUsage in interface AnnotationTarget

getRepeatedAnnotationUsages

public <A extends Annotation>
List<AnnotationUsage<A>> getRepeatedAnnotationUsages(AnnotationDescriptor<A> type)

Description copied from interface: AnnotationTarget

Get all usages of the specified annotationType in this scope.

Specified by:

getRepeatedAnnotationUsages in interface AnnotationTarget

getRepeatedAnnotationUsages

public <A extends Annotation>
List<AnnotationUsage<A>> getRepeatedAnnotationUsages(Class<A> type)

Description copied from interface: AnnotationTarget

Form of AnnotationTarget.getRepeatedAnnotationUsages(AnnotationDescriptor) accepting the annotation Class

Specified by:

getRepeatedAnnotationUsages in interface AnnotationTarget

forEachAnnotationUsage

public <X extends Annotation> void forEachAnnotationUsage(Class<X> type,
 Consumer<AnnotationUsage<X>> consumer)

Description copied from interface: AnnotationTarget

Form of AnnotationTarget.forEachAnnotationUsage(AnnotationDescriptor, Consumer) accepting the annotation Class

Specified by:

forEachAnnotationUsage in interface AnnotationTarget

getMetaAnnotated

public <A extends Annotation>
List<AnnotationUsage<? extends Annotation>> getMetaAnnotated(Class<A> metaAnnotationType)

Description copied from interface: AnnotationTarget

Returns all AnnotationUsage references from this target where the usage's annotation class is annotated with the given metaAnnotationType.

E.g., given the following class and annotations

     @interface TheMeta {
         ...
     }

     @TheMeta(...)
     @interface TheAnnotation {
         ...
     }

     @TheAnnotation
     class TheClass {
         ...
     }
 

a call to this method passing TheMeta on ClassDetails(TheClass) will return the usage of @TheAnnotation on TheClass.

Specified by:

getMetaAnnotated in interface AnnotationTarget

getNamedAnnotationUsage

public <X extends Annotation> AnnotationUsage<X> getNamedAnnotationUsage(AnnotationDescriptor<X> type,
 String matchName,
 String attributeToMatch)

Description copied from interface: AnnotationTarget

Get a usage of the given annotation type whose attributeToMatch attribute value matches the given matchName.

Specified by:

getNamedAnnotationUsage in interface AnnotationTarget

matchName - The name to match.

attributeToMatch - Name of the attribute to match on.

getNamedAnnotationUsage

public <X extends Annotation> AnnotationUsage<X> getNamedAnnotationUsage(Class<X> type,
 String matchName,
 String attributeToMatch)

Description copied from interface: AnnotationTarget

Helper form of AnnotationTarget.getNamedAnnotationUsage(AnnotationDescriptor, String, String)

Specified by:

getNamedAnnotationUsage in interface AnnotationTarget