Package org.hibernate.models.spi

Interface AnnotationUsage<A extends Annotation>

All Known Subinterfaces:

MutableAnnotationUsage<A>

All Known Implementing Classes:

DynamicAnnotationUsage, JandexAnnotationUsage, JdkAnnotationUsage

public interface AnnotationUsage<A extends Annotation>

Describes the usage of an annotation class on one of its allowable targets.

The standard way to access values is using getAttributeValue(java.lang.String). Convenience methods have been added for the allowable annotation types. These methods may throw exceptions (generally ClassCastException, if the expected type does not match).

• getBoolean(java.lang.String)
• getByte(java.lang.String)
• getShort(java.lang.String)
• getInteger(java.lang.String)
• getLong(java.lang.String)
• getFloat(java.lang.String)
• getDouble(java.lang.String)
• getClassDetails(java.lang.String)
• getNestedUsage(java.lang.String)
• getList(java.lang.String)

API Note:

Abstracts the underlying source of the annotation information, whether that is the annotation itself, JAXB, Jandex, HCANN, etc.

Method Summary

Modifier and Type	Method	Description
<V> V	findAttributeValue(String name)	The value of the named annotation attribute
AnnotationDescriptor<A>	getAnnotationDescriptor()	Descriptor for the type of the used annotation
AnnotationTarget	getAnnotationTarget()	The target where this usage occurs
default Class<A>	getAnnotationType()	Type of the used annotation
default <V> V	getAttributeValue(String name)	The value of the named annotation attribute
default <V> V	getAttributeValue(String name, Supplier<V> defaultValueSupplier)	The value of the named annotation attribute
default <V> V	getAttributeValue(String name, V defaultValue)	The value of the named annotation attribute
default <V> V	getAttributeValue(AttributeDescriptor<V> attributeDescriptor)
default Boolean	getBoolean(String name)
default Boolean	getBoolean(String name, boolean defaultValue)
default Boolean	getBoolean(String name, Supplier<Boolean> defaultValueSupplier)
default Byte	getByte(String name)
default Byte	getByte(String name, Byte defaultValue)
default Byte	getByte(String name, Supplier<Byte> defaultValueSupplier)
default ClassDetails	getClassDetails(String name)
default ClassDetails	getClassDetails(String name, Supplier<ClassDetails> defaultValue)
default ClassDetails	getClassDetails(String name, ClassDetails defaultValue)
default Double	getDouble(String name)
default Double	getDouble(String name, Double defaultValue)
default Double	getDouble(String name, Supplier<Double> defaultValueSupplier)
default <E extends Enum<E>> E	getEnum(String name)
default <E extends Enum<E>> E	getEnum(String name, E defaultValue)
default <E extends Enum<E>> E	getEnum(String name, E defaultValue, Class<E> type)
default <E extends Enum<E>> E	getEnum(String name, Class<E> type)
default <E extends Enum<E>> E	getEnum(String name, Supplier<E> defaultValueSupplier)
default <E extends Enum<E>> E	getEnum(String name, Supplier<E> defaultValueSupplier, Class<E> type)
default Float	getFloat(String name)
default Float	getFloat(String name, Float defaultValue)
default Float	getFloat(String name, Supplier<Float> defaultValueSupplier)
default Integer	getInteger(String name)
default Integer	getInteger(String name, Integer defaultValue)
default Integer	getInteger(String name, Supplier<Integer> defaultValueSupplier)
default <E> List<E>	getList(String name)
default <E> List<E>	getList(String name, Supplier<List<E>> defaultValueSupplier)
default <E> List<E>	getList(String name, List<E> defaultValue)
default Long	getLong(String name)
default Long	getLong(String name, Long defaultValue)
default Long	getLong(String name, Supplier<Long> defaultValueSupplier)
default <X extends Annotation> AnnotationUsage<X>	getNestedUsage(String name)
default <X extends Annotation> AnnotationUsage<X>	getNestedUsage(String name, Supplier<AnnotationUsage<X>> defaultValueSupplier)
default <X extends Annotation> AnnotationUsage<X>	getNestedUsage(String name, AnnotationUsage<X> defaultValue)
default Short	getShort(String name)
default Short	getShort(String name, Short defaultValue)
default Short	getShort(String name, Supplier<Short> defaultValueSupplier)
default String	getString(String name)
default String	getString(String name, String defaultValue)
default String	getString(String name, Supplier<String> defaultValueSupplier)
A	toAnnotation()	Create the Annotation representation of this usage

Method Details

getAnnotationDescriptor

AnnotationDescriptor<A> getAnnotationDescriptor()

Descriptor for the type of the used annotation

getAnnotationType

default Class<A> getAnnotationType()

Type of the used annotation

getAnnotationTarget

AnnotationTarget getAnnotationTarget()

The target where this usage occurs

toAnnotation

A toAnnotation()

Create the Annotation representation of this usage

findAttributeValue

<V> V findAttributeValue(String name)

The value of the named annotation attribute

getAttributeValue

default <V> V getAttributeValue(String name)

The value of the named annotation attribute

getAttributeValue

default <V> V getAttributeValue(String name,
 V defaultValue)

The value of the named annotation attribute

getAttributeValue

default <V> V getAttributeValue(String name,
 Supplier<V> defaultValueSupplier)

The value of the named annotation attribute

getAttributeValue

default <V> V getAttributeValue(AttributeDescriptor<V> attributeDescriptor)

getString

default String getString(String name)

getString

default String getString(String name,
 String defaultValue)

getString

default String getString(String name,
 Supplier<String> defaultValueSupplier)

getBoolean

default Boolean getBoolean(String name)

getBoolean

default Boolean getBoolean(String name,
 boolean defaultValue)

getBoolean

default Boolean getBoolean(String name,
 Supplier<Boolean> defaultValueSupplier)

getByte

default Byte getByte(String name)

getByte

default Byte getByte(String name,
 Byte defaultValue)

getByte

default Byte getByte(String name,
 Supplier<Byte> defaultValueSupplier)

getShort

default Short getShort(String name)

getShort

default Short getShort(String name,
 Short defaultValue)

getShort

default Short getShort(String name,
 Supplier<Short> defaultValueSupplier)

getInteger

default Integer getInteger(String name)

getInteger

default Integer getInteger(String name,
 Integer defaultValue)

getInteger

default Integer getInteger(String name,
 Supplier<Integer> defaultValueSupplier)

getLong

default Long getLong(String name)

getLong

default Long getLong(String name,
 Long defaultValue)

getLong

default Long getLong(String name,
 Supplier<Long> defaultValueSupplier)

getFloat

default Float getFloat(String name)

getFloat

default Float getFloat(String name,
 Float defaultValue)

getFloat

default Float getFloat(String name,
 Supplier<Float> defaultValueSupplier)

getDouble

default Double getDouble(String name)

getDouble

default Double getDouble(String name,
 Double defaultValue)

getDouble

default Double getDouble(String name,
 Supplier<Double> defaultValueSupplier)

getEnum

default <E extends Enum<E>> E getEnum(String name)

getEnum

default <E extends Enum<E>> E getEnum(String name,
 Class<E> type)

getEnum

default <E extends Enum<E>> E getEnum(String name,
 E defaultValue)

getEnum

default <E extends Enum<E>> E getEnum(String name,
 Supplier<E> defaultValueSupplier)

getEnum

default <E extends Enum<E>> E getEnum(String name,
 E defaultValue,
 Class<E> type)

getEnum

default <E extends Enum<E>> E getEnum(String name,
 Supplier<E> defaultValueSupplier,
 Class<E> type)

getClassDetails

default ClassDetails getClassDetails(String name)

getClassDetails

default ClassDetails getClassDetails(String name,
 ClassDetails defaultValue)

getClassDetails

default ClassDetails getClassDetails(String name,
 Supplier<ClassDetails> defaultValue)

getNestedUsage

default <X extends Annotation> AnnotationUsage<X> getNestedUsage(String name)

getNestedUsage

default <X extends Annotation> AnnotationUsage<X> getNestedUsage(String name,
 AnnotationUsage<X> defaultValue)

getNestedUsage

default <X extends Annotation> AnnotationUsage<X> getNestedUsage(String name,
 Supplier<AnnotationUsage<X>> defaultValueSupplier)

getList

default <E> List<E> getList(String name)

getList

default <E> List<E> getList(String name,
 List<E> defaultValue)

getList

default <E> List<E> getList(String name,
 Supplier<List<E>> defaultValueSupplier)