Package org.hibernate.models.internal

Interface ClassDetailsSupport

All Superinterfaces:

AnnotationTarget, AnnotationTargetSupport, ClassDetails, MutableAnnotationTarget, MutableClassDetails, Storable<ClassDetails,SerialClassDetails>, TypeVariableScope

All Known Implementing Classes:

DynamicClassDetails, JdkClassDetails

public interface ClassDetailsSupport
extends MutableClassDetails, AnnotationTargetSupport

Nested Class Summary

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

AnnotationTarget.AnnotationUsageProcessor<T,A extends Annotation>, 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

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 MutableClassDetails	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 MutableMemberDetails	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 void	forEachField(IndexedConsumer<FieldDetails> consumer)	Visit each field
default void	forEachMethod(IndexedConsumer<MethodDetails> consumer)	Visit each method
default void	forEachRecordComponent(IndexedConsumer<RecordComponentDetails> consumer)	Visit each method
default <A extends Annotation> A	getAnnotationUsage(Class<A> annotationType, ModelsContext modelContext)	Form of AnnotationTarget.getAnnotationUsage(AnnotationDescriptor, ModelsContext) accepting the annotation Class
default <A extends Annotation> A	getAnnotationUsage(AnnotationDescriptor<A> descriptor, ModelsContext modelContext)	Get the usage of the given annotation on this target.

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

forEachAnnotationUsage, forEachAnnotationUsage, forEachDirectAnnotationUsage, fromAnnotations, fromContainers, fromSelfAndContainers, getNamedAnnotationUsage, getRepeatedAnnotationUsages, walkContainers, walkSelfAndContainers

Methods inherited from interface org.hibernate.models.internal.AnnotationTargetSupport

addAnnotationUsage, clearAnnotationUsages, forEachRepeatedAnnotationUsages, forEachRepeatedAnnotationUsages, getDirectAnnotationUsage, getDirectAnnotationUsage, getDirectAnnotationUsages, getMetaAnnotated, getNamedAnnotationUsage, getNamedAnnotationUsage, getNamedAnnotationUsage, getRepeatedAnnotationUsages, getUsageMap, hasAnnotationUsage, hasDirectAnnotationUsage, locateAnnotationUsage, removeAnnotationUsage, replaceAnnotationUsage

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

determineRawClass, findField, findFieldByName, findRecordComponent, findRecordComponentByName, forEachMember, forEachPersistableMember, forEachSuper, forSelfAndEachSuper, getClassName, getContainer, getFields, getGenericSuperType, getImplementedInterfaces, getKind, getMethods, getName, getRecordComponents, getSuperClass, getTypeParameters, isAbstract, isEnum, isImplementor, isInterface, isRecord, isResolved, isSuperclass, resolveTypeVariable, toJavaClass, toJavaClass

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

applyAnnotationUsage, replaceAnnotationUsage

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

addField, addMethod, clearMemberAnnotationUsages

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

toStorableForm

Method Details

forEachField

default void forEachField(IndexedConsumer<FieldDetails> consumer)

Description copied from interface: ClassDetails

Visit each field

Specified by:

forEachField in interface ClassDetails

forEachMethod

default void forEachMethod(IndexedConsumer<MethodDetails> consumer)

Description copied from interface: ClassDetails

Visit each method

Specified by:

forEachMethod in interface ClassDetails

forEachRecordComponent

default void forEachRecordComponent(IndexedConsumer<RecordComponentDetails> consumer)

Description copied from interface: ClassDetails

Visit each method

Specified by:

forEachRecordComponent in interface ClassDetails

getAnnotationUsage

default <A extends Annotation> A getAnnotationUsage(AnnotationDescriptor<A> descriptor,
 ModelsContext modelContext)

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, ModelsContext).

Specified by:

getAnnotationUsage in interface AnnotationTarget

Specified by:

getAnnotationUsage in interface AnnotationTargetSupport

Returns:

The usage or null

getAnnotationUsage

default <A extends Annotation> A getAnnotationUsage(Class<A> annotationType,
 ModelsContext modelContext)

Description copied from interface: AnnotationTarget

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

Specified by:

getAnnotationUsage in interface AnnotationTarget

Specified by:

getAnnotationUsage in interface AnnotationTargetSupport

asClassDetails

default MutableClassDetails asClassDetails()

Description copied from interface: AnnotationTarget

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

Specified by:

asClassDetails in interface AnnotationTarget

Specified by:

asClassDetails in interface AnnotationTargetSupport

Specified by:

asClassDetails in interface ClassDetails

Specified by:

asClassDetails in interface MutableAnnotationTarget

Specified by:

asClassDetails in interface MutableClassDetails

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

Specified by:

asAnnotationDescriptor in interface AnnotationTargetSupport

Specified by:

asAnnotationDescriptor in interface ClassDetails

Specified by:

asAnnotationDescriptor in interface MutableClassDetails

asMemberDetails

default MutableMemberDetails 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

Specified by:

asMemberDetails in interface AnnotationTargetSupport

Specified by:

asMemberDetails in interface ClassDetails

Specified by:

asMemberDetails in interface MutableAnnotationTarget

Specified by:

asMemberDetails in interface MutableClassDetails

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

Specified by:

asFieldDetails in interface AnnotationTargetSupport

Specified by:

asFieldDetails in interface ClassDetails

Specified by:

asFieldDetails in interface MutableClassDetails

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

Specified by:

asMethodDetails in interface AnnotationTargetSupport

Specified by:

asMethodDetails in interface ClassDetails

Specified by:

asMethodDetails in interface MutableClassDetails

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

Specified by:

asRecordComponentDetails in interface AnnotationTargetSupport

Specified by:

asRecordComponentDetails in interface ClassDetails

Specified by:

asRecordComponentDetails in interface MutableClassDetails