Package org.hibernate.models.internal

Interface AnnotationTargetSupport

All Superinterfaces:

AnnotationTarget, MutableAnnotationTarget

All Known Subinterfaces:

ClassDetailsSupport

All Known Implementing Classes:

AbstractAnnotationTarget, AbstractAnnotationTarget, AbstractAnnotationTarget, AnnotationDescriptorImpl, DynamicClassDetails, DynamicFieldDetails, DynamicMethodDetails, JandexClassDetails, JandexFieldDetails, JandexMethodDetails, JandexRecordComponentDetails, JdkClassDetails, JdkFieldDetails, JdkMethodDetails, JdkRecordComponentDetails

public interface AnnotationTargetSupport
extends MutableAnnotationTarget

Nested Class Summary

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

AnnotationTarget.AnnotationUsageProcessor<T>, AnnotationTarget.Kind

Method Summary

Modifier and Type	Method	Description
default <X extends Annotation> void	forEachAnnotationUsage(Class<X> type, Consumer<AnnotationUsage<X>> consumer)	Form of AnnotationTarget.forEachAnnotationUsage(AnnotationDescriptor, Consumer) accepting the annotation Class
default Collection<AnnotationUsage<?>>	getAllAnnotationUsages()	Access to all the annotations used on this target.
default <A extends Annotation> AnnotationUsage<A>	getAnnotationUsage(Class<A> annotationType)	Form of AnnotationTarget.getAnnotationUsage(AnnotationDescriptor) accepting the annotation Class
default <A extends Annotation> AnnotationUsage<A>	getAnnotationUsage(AnnotationDescriptor<A> descriptor)	Get the usage of the given annotation on this target.
SourceModelBuildingContext	getBuildingContext()
default <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.
default <X extends Annotation> AnnotationUsage<X>	getNamedAnnotationUsage(Class<X> type, String matchName)	Helper form of AnnotationTarget.getNamedAnnotationUsage(AnnotationDescriptor, String)
default <X extends Annotation> AnnotationUsage<X>	getNamedAnnotationUsage(Class<X> type, String matchName, String attributeToMatch)	Helper form of AnnotationTarget.getNamedAnnotationUsage(AnnotationDescriptor, String, String)
default <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.
default <A extends Annotation> List<AnnotationUsage<A>>	getRepeatedAnnotationUsages(Class<A> type)	Form of AnnotationTarget.getRepeatedAnnotationUsages(AnnotationDescriptor) accepting the annotation Class
default <A extends Annotation> List<AnnotationUsage<A>>	getRepeatedAnnotationUsages(AnnotationDescriptor<A> type)	Get all usages of the specified annotationType in this scope.
Map<Class<? extends Annotation>,AnnotationUsage<? extends Annotation>>	getUsageMap()
default <A extends Annotation> boolean	hasAnnotationUsage(Class<A> type)	Whether the given annotation is used on this target.
default <A extends Annotation> boolean	hasRepeatableAnnotationUsage(Class<A> type)	Whether the given annotation is used on this target.
default <A extends Annotation> AnnotationUsage<A>	locateAnnotationUsage(Class<A> annotationType)	Form of AnnotationTarget.getAnnotationUsage(org.hibernate.models.spi.AnnotationDescriptor<A>) which also considers meta-annotations - annotations on the classes of each local annotation.

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

forAllAnnotationUsages, forEachAnnotationUsage, fromAnnotations, getKind, getName, getNamedAnnotationUsage, getSingleAnnotationUsage, getSingleAnnotationUsage

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

addAnnotationUsage, applyAnnotationUsage, applyAnnotationUsage, clearAnnotationUsages

Method Details

getBuildingContext

SourceModelBuildingContext getBuildingContext()

getUsageMap

Map<Class<? extends Annotation>,AnnotationUsage<? extends Annotation>> getUsageMap()

getAllAnnotationUsages

default Collection<AnnotationUsage<?>> getAllAnnotationUsages()

Description copied from interface: AnnotationTarget

Access to all the annotations used on this target.

Specified by:

getAllAnnotationUsages in interface AnnotationTarget

hasAnnotationUsage

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

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

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

default <A extends Annotation> AnnotationUsage<A> getAnnotationUsage(Class<A> annotationType)

Description copied from interface: AnnotationTarget

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

Specified by:

getAnnotationUsage in interface AnnotationTarget

locateAnnotationUsage

default <A extends Annotation> AnnotationUsage<A> locateAnnotationUsage(Class<A> annotationType)

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

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

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

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

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

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

Description copied from interface: AnnotationTarget

Helper form of AnnotationTarget.getNamedAnnotationUsage(AnnotationDescriptor, String)

Specified by:

getNamedAnnotationUsage in interface AnnotationTarget

getNamedAnnotationUsage

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

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