Package org.hibernate.models.internal

Interface AnnotationTargetSupport

All Superinterfaces:

AnnotationTarget, MutableAnnotationTarget

All Known Subinterfaces:

ClassDetailsSupport

All Known Implementing Classes:

AbstractAnnotationDescriptor, AbstractAnnotationTarget, AbstractAnnotationTarget, AbstractJdkAnnotationTarget, DynamicClassDetails, DynamicFieldDetails, JdkClassDetails, JdkFieldDetails, JdkMethodDetails, JdkRecordComponentDetails, OrmAnnotationDescriptor, StandardAnnotationDescriptor

public interface AnnotationTargetSupport
extends MutableAnnotationTarget

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 <X extends Annotation> void	addAnnotationUsage(X annotationUsage)	Add an annotation usage to this target
default <A extends Annotation> AnnotationDescriptor<A>	asAnnotationDescriptor()	Safe cast method for cases when the target is an annotation.
MutableClassDetails	asClassDetails()	Safe cast method for cases when the target is a class.
FieldDetails	asFieldDetails()	Safe cast method for cases when the target is a field.
MutableMemberDetails	asMemberDetails()	Safe cast method for cases when the target is a field, method or record component.
MethodDetails	asMethodDetails()	Safe cast method for cases when the target is a method.
RecordComponentDetails	asRecordComponentDetails()	Safe cast method for cases when the target is a record component.
default void	clearAnnotationUsages()	Removes all annotation usages currently associated with this target.
default <A extends Annotation, C extends Annotation> void	forEachRepeatedAnnotationUsages(Class<A> repeatableType, Class<C> containerType, ModelsContext modelContext, Consumer<A> consumer)
default <A extends Annotation, C extends Annotation> void	forEachRepeatedAnnotationUsages(AnnotationDescriptor<A> repeatableDescriptor, ModelsContext modelContext, Consumer<A> consumer)
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.
default <A extends Annotation> A	getDirectAnnotationUsage(Class<A> type)	Form of AnnotationTarget.getDirectAnnotationUsage(AnnotationDescriptor) accepting the annotation Class
default <A extends Annotation> A	getDirectAnnotationUsage(AnnotationDescriptor<A> descriptor)	Form of AnnotationTarget.getAnnotationUsage(AnnotationDescriptor, ModelsContext) which returns null instead of throwing AnnotationAccessException when more than one usage of the requested annotation exists.
default Collection<? extends Annotation>	getDirectAnnotationUsages()	Access to all the annotations used on this target.
default <A extends Annotation> List<? extends Annotation>	getMetaAnnotated(Class<A> metaAnnotationType, ModelsContext modelContext)	Returns all Annotation usages from this target where the usage's annotation class is annotated with the given metaAnnotationType.
default <X extends Annotation> X	getNamedAnnotationUsage(Class<X> type, String matchName, String attributeToMatch, ModelsContext modelContext)	Helper form of AnnotationTarget.getNamedAnnotationUsage(AnnotationDescriptor, String, String, ModelsContext)
default <X extends Annotation> X	getNamedAnnotationUsage(Class<X> type, String matchName, ModelsContext modelContext)	Helper form of AnnotationTarget.getNamedAnnotationUsage(AnnotationDescriptor, String, ModelsContext)
default <X extends Annotation> X	getNamedAnnotationUsage(AnnotationDescriptor<X> type, String matchName, String attributeToMatch, ModelsContext modelContext)	Get a usage of the given annotation type whose attributeToMatch attribute value matches the given matchName.
default <A extends Annotation> A[]	getRepeatedAnnotationUsages(AnnotationDescriptor<A> type, ModelsContext modelContext)	Get all usages of the specified annotationType in this scope.
Map<Class<? extends Annotation>,? extends Annotation>	getUsageMap()	Access to all annotation usages on this target.
default <X extends Annotation> boolean	hasAnnotationUsage(Class<X> type, ModelsContext modelContext)	Whether the given annotation is used on this target.
default <A extends Annotation> boolean	hasDirectAnnotationUsage(Class<A> type)	Whether the given annotation is used on this target.
default <A extends Annotation> A	locateAnnotationUsage(Class<A> annotationType, ModelsContext modelContext)	Form of AnnotationTarget.getAnnotationUsage(org.hibernate.models.spi.AnnotationDescriptor<A>, org.hibernate.models.spi.ModelsContext) which also considers meta-annotations - annotations on the classes of each local annotation.
default <X extends Annotation> void	removeAnnotationUsage(AnnotationDescriptor<X> annotationType)	Remove an annotation, by type, from this target if there is such a usage.
default <S extends Annotation, P extends Annotation> P	replaceAnnotationUsage(AnnotationDescriptor<S> repeatableType, AnnotationDescriptor<P> containerType, ModelsContext modelContext)	Creates and replaces (if any) an existing usage of the given annotation.

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

forEachAnnotationUsage, forEachAnnotationUsage, forEachDirectAnnotationUsage, fromAnnotations, fromContainers, fromSelfAndContainers, getContainer, getKind, getName, getNamedAnnotationUsage, getRepeatedAnnotationUsages, walkContainers, walkSelfAndContainers

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

applyAnnotationUsage, replaceAnnotationUsage

Method Details

getUsageMap

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

Access to all annotation usages on this target.

clearAnnotationUsages

default void clearAnnotationUsages()

Description copied from interface: MutableAnnotationTarget

Removes all annotation usages currently associated with this target. Useful for complete XML mappings.

Specified by:

clearAnnotationUsages in interface MutableAnnotationTarget

addAnnotationUsage

default <X extends Annotation> void addAnnotationUsage(X annotationUsage)

Description copied from interface: MutableAnnotationTarget

Add an annotation usage to this target

Specified by:

addAnnotationUsage in interface MutableAnnotationTarget

removeAnnotationUsage

default <X extends Annotation> void removeAnnotationUsage(AnnotationDescriptor<X> annotationType)

Description copied from interface: MutableAnnotationTarget

Remove an annotation, by type, from this target if there is such a usage.

Specified by:

removeAnnotationUsage in interface MutableAnnotationTarget

getDirectAnnotationUsages

default Collection<? extends Annotation> getDirectAnnotationUsages()

Description copied from interface: AnnotationTarget

Access to all the annotations used on this target.

Specified by:

getDirectAnnotationUsages in interface AnnotationTarget

getDirectAnnotationUsage

default <A extends Annotation> A getDirectAnnotationUsage(AnnotationDescriptor<A> descriptor)

Description copied from interface: AnnotationTarget

Form of AnnotationTarget.getAnnotationUsage(AnnotationDescriptor, ModelsContext) which returns null instead of throwing AnnotationAccessException when more than one usage of the requested annotation exists.

Specified by:

getDirectAnnotationUsage in interface AnnotationTarget

getDirectAnnotationUsage

default <A extends Annotation> A getDirectAnnotationUsage(Class<A> type)

Description copied from interface: AnnotationTarget

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

Specified by:

getDirectAnnotationUsage in interface AnnotationTarget

hasDirectAnnotationUsage

default <A extends Annotation> boolean hasDirectAnnotationUsage(Class<A> type)

Description copied from interface: AnnotationTarget

Whether the given annotation is used on this target.

Specified by:

hasDirectAnnotationUsage in interface AnnotationTarget

See Also:

• AnnotationTarget.hasAnnotationUsage(java.lang.Class<A>, org.hibernate.models.spi.ModelsContext)

hasAnnotationUsage

default <X extends Annotation> boolean hasAnnotationUsage(Class<X> type,
 ModelsContext modelContext)

Description copied from interface: AnnotationTarget

Whether the given annotation is used on this target.

Specified by:

hasAnnotationUsage in interface AnnotationTarget

See Also:

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

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

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

getRepeatedAnnotationUsages

default <A extends Annotation> A[] getRepeatedAnnotationUsages(AnnotationDescriptor<A> type,
 ModelsContext modelContext)

Description copied from interface: AnnotationTarget

Get all usages of the specified annotationType in this scope.

Specified by:

getRepeatedAnnotationUsages in interface AnnotationTarget

forEachRepeatedAnnotationUsages

default <A extends Annotation,
C extends Annotation>
void forEachRepeatedAnnotationUsages(Class<A> repeatableType,
 Class<C> containerType,
 ModelsContext modelContext,
 Consumer<A> consumer)

Specified by:

forEachRepeatedAnnotationUsages in interface AnnotationTarget

forEachRepeatedAnnotationUsages

default <A extends Annotation,
C extends Annotation>
void forEachRepeatedAnnotationUsages(AnnotationDescriptor<A> repeatableDescriptor,
 ModelsContext modelContext,
 Consumer<A> consumer)

Specified by:

forEachRepeatedAnnotationUsages in interface AnnotationTarget

locateAnnotationUsage

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

Description copied from interface: AnnotationTarget

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

Specified by:

locateAnnotationUsage in interface AnnotationTarget

getMetaAnnotated

default <A extends Annotation>
List<? extends Annotation> getMetaAnnotated(Class<A> metaAnnotationType,
 ModelsContext modelContext)

Description copied from interface: AnnotationTarget

Returns all Annotation usages 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> X getNamedAnnotationUsage(Class<X> type,
 String matchName,
 ModelsContext modelContext)

Description copied from interface: AnnotationTarget

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

Specified by:

getNamedAnnotationUsage in interface AnnotationTarget

getNamedAnnotationUsage

default <X extends Annotation> X getNamedAnnotationUsage(AnnotationDescriptor<X> type,
 String matchName,
 String attributeToMatch,
 ModelsContext modelContext)

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

Parameters:

matchName - The name to match.

attributeToMatch - Name of the attribute to match on.

getNamedAnnotationUsage

default <X extends Annotation> X getNamedAnnotationUsage(Class<X> type,
 String matchName,
 String attributeToMatch,
 ModelsContext modelContext)

Description copied from interface: AnnotationTarget

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

Specified by:

getNamedAnnotationUsage in interface AnnotationTarget

replaceAnnotationUsage

default <S extends Annotation,
P extends Annotation>
P replaceAnnotationUsage(AnnotationDescriptor<S> repeatableType,
 AnnotationDescriptor<P> containerType,
 ModelsContext modelContext)

Description copied from interface: MutableAnnotationTarget

Creates and replaces (if any) an existing usage of the given annotation.

For repeatable annotations, use Applies a usage of the given annotationType to this target. Will return an existing usage, if one, or create a new usage.

Specified by:

replaceAnnotationUsage in interface MutableAnnotationTarget

See Also:

• MutableAnnotationTarget.replaceAnnotationUsage(AnnotationDescriptor, ModelsContext)

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

asFieldDetails

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

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

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

asClassDetails

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 MutableAnnotationTarget

asMemberDetails

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 MutableAnnotationTarget