Package org.hibernate.models.internal.jdk

Class AnnotationDescriptorOrmImpl<A extends Annotation>

java.lang.Object

org.hibernate.models.internal.jdk.AnnotationDescriptorOrmImpl<A>

All Implemented Interfaces:

AnnotationDescriptor<A>, AnnotationTarget

public class AnnotationDescriptorOrmImpl<A extends Annotation>
extends Object
implements AnnotationDescriptor<A>

AnnotationDescriptor for cases where we do not want to deal with ANNOTATION_TYPE annotations, most notably, Jakarta and Hibernate annotations

Nested Class Summary

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

AnnotationTarget.AnnotationUsageProcessor<T>, AnnotationTarget.Kind

Constructor Summary

Constructors

Constructor	Description
AnnotationDescriptorOrmImpl(Class<A> annotationType, AnnotationDescriptor<?> repeatableContainer)

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
<X extends Annotation> void	forEachAnnotationUsage(AnnotationDescriptor<X> type, Consumer<AnnotationUsage<X>> consumer)	Call the consumer for each usage of the given type.
Collection<AnnotationUsage<?>>	getAllAnnotationUsages()	Access to all the annotations used on this target.
EnumSet<AnnotationTarget.Kind>	getAllowableTargets()	The places the described annotation can be used
Class<A>	getAnnotationType()	The annotation type
<X extends Annotation> AnnotationUsage<X>	getAnnotationUsage(Class<X> type)	Form of AnnotationTarget.getAnnotationUsage(AnnotationDescriptor) accepting the annotation Class
<X extends Annotation> AnnotationUsage<X>	getAnnotationUsage(AnnotationDescriptor<X> descriptor)	Get the usage of the given annotation on this target.
List<AttributeDescriptor<?>>	getAttributes()	The attributes of the annotation
<X extends Annotation> List<AnnotationUsage<? extends Annotation>>	getMetaAnnotated(Class<X> metaAnnotationType)	Returns all AnnotationUsage references from this target where the usage's annotation class is annotated with the given metaAnnotationType.
String	getName()	A descriptive name for the target used mostly for logging
<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.
AnnotationDescriptor<?>	getRepeatableContainer()	If the described annotation is repeatable, returns the descriptor for the container annotation.
<X extends Annotation> List<AnnotationUsage<X>>	getRepeatedAnnotationUsages(Class<X> type)	Form of AnnotationTarget.getRepeatedAnnotationUsages(AnnotationDescriptor) accepting the annotation Class
<X extends Annotation> List<AnnotationUsage<X>>	getRepeatedAnnotationUsages(AnnotationDescriptor<X> type)	Get all usages of the specified annotationType in this scope.
<X extends Annotation> boolean	hasAnnotationUsage(Class<X> 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	isInherited()	Whether the annotation defined as inherited
<X extends Annotation> AnnotationUsage<X>	locateAnnotationUsage(Class<X> type)	Form of AnnotationTarget.getAnnotationUsage(org.hibernate.models.spi.AnnotationDescriptor<A>) which also considers meta-annotations - annotations on the classes of each local annotation.
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.AnnotationDescriptor

createUsage, createUsage, findAttribute, getAttribute, getKind, isRepeatable

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

forAllAnnotationUsages, fromAnnotations, getNamedAnnotationUsage, getNamedAnnotationUsage, getSingleAnnotationUsage, getSingleAnnotationUsage

Constructor Details

AnnotationDescriptorOrmImpl

public AnnotationDescriptorOrmImpl(Class<A> annotationType,
 AnnotationDescriptor<?> repeatableContainer)

Method Details

getAnnotationType

public Class<A> getAnnotationType()

Description copied from interface: AnnotationDescriptor

The annotation type

Specified by:

getAnnotationType in interface AnnotationDescriptor<A extends Annotation>

getAllowableTargets

public EnumSet<AnnotationTarget.Kind> getAllowableTargets()

Description copied from interface: AnnotationDescriptor

The places the described annotation can be used

Specified by:

getAllowableTargets in interface AnnotationDescriptor<A extends Annotation>

isInherited

public boolean isInherited()

Description copied from interface: AnnotationDescriptor

Whether the annotation defined as inherited

Specified by:

isInherited in interface AnnotationDescriptor<A extends Annotation>

getRepeatableContainer

public AnnotationDescriptor<?> getRepeatableContainer()

Description copied from interface: AnnotationDescriptor

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

Specified by:

getRepeatableContainer in interface AnnotationDescriptor<A extends Annotation>

getAttributes

public List<AttributeDescriptor<?>> getAttributes()

Description copied from interface: AnnotationDescriptor

The attributes of the annotation

Specified by:

getAttributes in interface AnnotationDescriptor<A extends Annotation>

getName

public String getName()

Description copied from interface: AnnotationTarget

A descriptive name for the target used mostly for logging

Specified by:

getName in interface AnnotationTarget

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 <X extends Annotation> boolean hasAnnotationUsage(Class<X> 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 <X extends Annotation> AnnotationUsage<X> getAnnotationUsage(AnnotationDescriptor<X> 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 <X extends Annotation> AnnotationUsage<X> getAnnotationUsage(Class<X> type)

Description copied from interface: AnnotationTarget

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

Specified by:

getAnnotationUsage in interface AnnotationTarget

locateAnnotationUsage

public <X extends Annotation> AnnotationUsage<X> locateAnnotationUsage(Class<X> 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 <X extends Annotation>
List<AnnotationUsage<X>> getRepeatedAnnotationUsages(AnnotationDescriptor<X> type)

Description copied from interface: AnnotationTarget

Get all usages of the specified annotationType in this scope.

Specified by:

getRepeatedAnnotationUsages in interface AnnotationTarget

getRepeatedAnnotationUsages

public <X extends Annotation>
List<AnnotationUsage<X>> getRepeatedAnnotationUsages(Class<X> 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(AnnotationDescriptor<X> type,
 Consumer<AnnotationUsage<X>> consumer)

Description copied from interface: AnnotationTarget

Call the consumer for each usage of the given type.

Specified by:

forEachAnnotationUsage 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 <X extends Annotation>
List<AnnotationUsage<? extends Annotation>> getMetaAnnotated(Class<X> 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

toString

public String toString()

Overrides:

toString in class Object