Package org.hibernate.models.spi

Interface AnnotationDescriptor<A extends Annotation>

All Superinterfaces:

AnnotationTarget, Storable<AnnotationDescriptor<A>,SerialAnnotationDescriptor<A>>

All Known Subinterfaces:

MutableAnnotationDescriptor<A,C>

All Known Implementing Classes:

AbstractAnnotationDescriptor, OrmAnnotationDescriptor, StandardAnnotationDescriptor

public interface AnnotationDescriptor<A extends Annotation>
extends AnnotationTarget, Storable<AnnotationDescriptor<A>,SerialAnnotationDescriptor<A>>

Describes an annotation type (the Class)

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
default <S> S	as(Class<S> type)
default <X extends Annotation> AnnotationDescriptor<X>	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.
A	createUsage(A jdkAnnotation, ModelsContext context)	Create a usage from the JDK representation.
default A	createUsage(Map<String,Object> attributeValues, ModelsContext context)	Create a usage from the JDK representation.
A	createUsage(ModelsContext context)	Create an empty usage.
default <V> AttributeDescriptor<V>	findAttribute(String name)	Get an attribute descriptor by name, returning null if the name is not an attribute of the described annotation.
EnumSet<AnnotationTarget.Kind>	getAllowableTargets()	The places the described annotation can be used
Class<A>	getAnnotationType()	The annotation type
default <V> AttributeDescriptor<V>	getAttribute(String name)	Get an attribute descriptor by name.
List<AttributeDescriptor<?>>	getAttributes()	The attributes of the annotation
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).
default AnnotationTarget.Kind	getKind()	The kind of target
AnnotationDescriptor<?>	getRepeatableContainer()	If the described annotation is repeatable, returns the descriptor for the container annotation.
boolean	isInherited()	Whether the annotation defined as inherited
default boolean	isRepeatable()	Whether the annotation is repeatable.
default SerialAnnotationDescriptor<A>	toStorableForm()

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

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

Method Details

getKind

default AnnotationTarget.Kind getKind()

Description copied from interface: AnnotationTarget

The kind of target

Specified by:

getKind in interface AnnotationTarget

getAnnotationType

Class<A> getAnnotationType()

The annotation type

as

default <S> S as(Class<S> type)

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

createUsage

A createUsage(ModelsContext context)

Create an empty usage. Used when there is no source form, such as XML processing.

createUsage

A createUsage(A jdkAnnotation,
 ModelsContext context)

Create a usage from the JDK representation. This will often just return the passed annotation, although for Hibernate and JPA annotations we generally want wrappers to be able to manipulate the values.

createUsage

default A createUsage(Map<String,Object> attributeValues,
 ModelsContext context)

Create a usage from the JDK representation. This will often just return the passed annotation, although for Hibernate and JPA annotations we generally want wrappers to be able to manipulate the values.

getAllowableTargets

EnumSet<AnnotationTarget.Kind> getAllowableTargets()

The places the described annotation can be used

isInherited

boolean isInherited()

Whether the annotation defined as inherited

isRepeatable

default boolean isRepeatable()

Whether the annotation is repeatable.

getRepeatableContainer

AnnotationDescriptor<?> getRepeatableContainer()

If the described annotation is repeatable, returns the descriptor for the container annotation.

getAttributes

List<AttributeDescriptor<?>> getAttributes()

The attributes of the annotation

findAttribute

default <V> AttributeDescriptor<V> findAttribute(String name)

Get an attribute descriptor by name, returning null if the name is not an attribute of the described annotation.

getAttribute

default <V> AttributeDescriptor<V> getAttribute(String name)

Get an attribute descriptor by name.

Throws:

UnknownAnnotationAttributeException - if the name is not an attribute of the described annotation.

asAnnotationDescriptor

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

Description copied from interface: AnnotationTarget

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

Specified by:

asAnnotationDescriptor in interface AnnotationTarget

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

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

toStorableForm

default SerialAnnotationDescriptor<A> toStorableForm()

Specified by:

toStorableForm in interface Storable<AnnotationDescriptor<A extends Annotation>,SerialAnnotationDescriptor<A extends Annotation>>