Package org.hibernate.models.internal

Class AbstractAnnotationDescriptor<A extends Annotation>

java.lang.Object

org.hibernate.models.internal.AbstractAnnotationTarget

org.hibernate.models.internal.AbstractAnnotationDescriptor<A>

All Implemented Interfaces:

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

Direct Known Subclasses:

OrmAnnotationDescriptor, StandardAnnotationDescriptor

public abstract class AbstractAnnotationDescriptor<A extends Annotation>
extends AbstractAnnotationTarget
implements AnnotationDescriptor<A>

Base support for AnnotationDescriptor implementations

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
AbstractAnnotationDescriptor(Class<A> annotationType, EnumSet<AnnotationTarget.Kind> allowableTargets, boolean inherited, AnnotationDescriptor<?> repeatableContainer)

Method Summary

Modifier and Type	Method	Description
<X extends Annotation> AnnotationDescriptor<X>	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.
EnumSet<AnnotationTarget.Kind>	getAllowableTargets()	The places the described annotation can be used
Class<A>	getAnnotationType()	The annotation type
Collection<? extends Annotation>	getDirectAnnotationUsages()	Access to all the annotations used on this target.
String	getName()	A descriptive name for the target used mostly for logging
AnnotationDescriptor<?>	getRepeatableContainer()	If the described annotation is repeatable, returns the descriptor for the container annotation.
<X extends Annotation> X[]	getRepeatedAnnotationUsages(Class<X> type, ModelsContext modelContext)	Form of AnnotationTarget.getRepeatedAnnotationUsages(AnnotationDescriptor, ModelsContext) accepting the annotation Class
<X extends Annotation> X[]	getRepeatedAnnotationUsages(AnnotationDescriptor<X> type, ModelsContext modelContext)	Get all usages of the specified annotationType in this scope.
boolean	isInherited()	Whether the annotation defined as inherited

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

as, createUsage, createUsage, createUsage, findAttribute, getAttribute, getAttributes, getContainer, getKind, isRepeatable, toStorableForm

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

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

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

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

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

applyAnnotationUsage, replaceAnnotationUsage

Constructor Details

AbstractAnnotationDescriptor

public AbstractAnnotationDescriptor(Class<A> annotationType,
 EnumSet<AnnotationTarget.Kind> allowableTargets,
 boolean inherited,
 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>

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

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>

getDirectAnnotationUsages

public Collection<? extends Annotation> getDirectAnnotationUsages()

Description copied from interface: AnnotationTarget

Access to all the annotations used on this target.

Specified by:

getDirectAnnotationUsages in interface AnnotationTarget

Specified by:

getDirectAnnotationUsages in interface AnnotationTargetSupport

getRepeatedAnnotationUsages

public <X extends Annotation> X[] getRepeatedAnnotationUsages(AnnotationDescriptor<X> type,
 ModelsContext modelContext)

Description copied from interface: AnnotationTarget

Get all usages of the specified annotationType in this scope.

Specified by:

getRepeatedAnnotationUsages in interface AnnotationTarget

Specified by:

getRepeatedAnnotationUsages in interface AnnotationTargetSupport

getRepeatedAnnotationUsages

public <X extends Annotation> X[] getRepeatedAnnotationUsages(Class<X> type,
 ModelsContext modelContext)

Description copied from interface: AnnotationTarget

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

Specified by:

getRepeatedAnnotationUsages in interface AnnotationTarget

asAnnotationDescriptor

public <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 AnnotationDescriptor<A extends Annotation>

Specified by:

asAnnotationDescriptor in interface AnnotationTarget

Specified by:

asAnnotationDescriptor in interface AnnotationTargetSupport

asClassDetails

public MutableClassDetails asClassDetails()

Description copied from interface: AnnotationTarget

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

Specified by:

asClassDetails in interface AnnotationDescriptor<A extends Annotation>

Specified by:

asClassDetails in interface AnnotationTarget

Specified by:

asClassDetails in interface AnnotationTargetSupport

Specified by:

asClassDetails in interface MutableAnnotationTarget

asMemberDetails

public 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 AnnotationDescriptor<A extends Annotation>

Specified by:

asMemberDetails in interface AnnotationTarget

Specified by:

asMemberDetails in interface AnnotationTargetSupport

Specified by:

asMemberDetails in interface MutableAnnotationTarget

asFieldDetails

public FieldDetails asFieldDetails()

Description copied from interface: AnnotationTarget

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

Specified by:

asFieldDetails in interface AnnotationDescriptor<A extends Annotation>

Specified by:

asFieldDetails in interface AnnotationTarget

Specified by:

asFieldDetails in interface AnnotationTargetSupport

asMethodDetails

public MethodDetails asMethodDetails()

Description copied from interface: AnnotationTarget

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

Specified by:

asMethodDetails in interface AnnotationDescriptor<A extends Annotation>

Specified by:

asMethodDetails in interface AnnotationTarget

Specified by:

asMethodDetails in interface AnnotationTargetSupport

asRecordComponentDetails

public RecordComponentDetails asRecordComponentDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a record component.

Specified by:

asRecordComponentDetails in interface AnnotationDescriptor<A extends Annotation>

Specified by:

asRecordComponentDetails in interface AnnotationTarget

Specified by:

asRecordComponentDetails in interface AnnotationTargetSupport