DefaultAnnotationMetadata (javadoc 2.2.3 API)

java.lang.Object
- io.micronaut.inject.annotation.DefaultAnnotationMetadata

All Implemented Interfaces:

AnnotationMetadata, AnnotationSource, java.lang.Cloneable
```
@Internal
public class DefaultAnnotationMetadata
extends java.lang.Object
implements AnnotationMetadata, java.lang.Cloneable
```
Default implementation of AnnotationMetadata.
NOTE: Although required to be public This is an internal class and should not be referenced directly in user code

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,java.lang.annotation.Annotation>`	`annotationMap`
`protected java.util.Map<java.lang.String,java.lang.annotation.Annotation>`	`declaredAnnotationMap`

Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadata
CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource
EMPTY

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DefaultAnnotationMetadata()` Constructs empty annotation metadata.
	DefaultAnnotationMetadata(java.util.Map<java.lang.String,java.util.Map<java.lang.CharSequence,java.lang.Object>> declaredAnnotations, java.util.Map<java.lang.String,java.util.Map<java.lang.CharSequence,java.lang.Object>> declaredStereotypes, java.util.Map<java.lang.String,java.util.Map<java.lang.CharSequence,java.lang.Object>> allStereotypes, java.util.Map<java.lang.String,java.util.Map<java.lang.CharSequence,java.lang.Object>> allAnnotations, java.util.Map<java.lang.String,java.util.List<java.lang.String>> annotationsByStereotype) This constructor is designed to be used by compile time produced subclasses.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAnnotation(java.lang.String annotation, java.util.Map<java.lang.CharSequence,java.lang.Object> values)` Adds an annotation and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addAnnotation(java.lang.String annotation, java.util.Map<java.lang.CharSequence,java.lang.Object> values, java.lang.annotation.RetentionPolicy retentionPolicy)` Adds an annotation and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addAnnotationValuesFromData(java.util.List results, java.util.Map<java.lang.CharSequence,java.lang.Object> values)` Adds any annotation values found in the values map to the results.
`protected void`	`addDeclaredAnnotation(java.lang.String annotation, java.util.Map<java.lang.CharSequence,java.lang.Object> values)` Adds an annotation directly declared on the element and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addDeclaredAnnotation(java.lang.String annotation, java.util.Map<java.lang.CharSequence,java.lang.Object> values, java.lang.annotation.RetentionPolicy retentionPolicy)` Adds an annotation directly declared on the element and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addDeclaredRepeatable(java.lang.String annotationName, AnnotationValue annotationValue)` Adds a repeatable annotation value.
`protected void`	`addDeclaredRepeatable(java.lang.String annotationName, AnnotationValue annotationValue, java.lang.annotation.RetentionPolicy retentionPolicy)` Adds a repeatable annotation value.
`protected void`	`addDeclaredRepeatableStereotype(java.util.List<java.lang.String> parents, java.lang.String stereotype, AnnotationValue annotationValue)` Adds a repeatable declared stereotype value.
`protected void`	`addDeclaredStereotype(java.util.List<java.lang.String> parentAnnotations, java.lang.String stereotype, java.util.Map<java.lang.CharSequence,java.lang.Object> values)` Adds a stereotype and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addDeclaredStereotype(java.util.List<java.lang.String> parentAnnotations, java.lang.String stereotype, java.util.Map<java.lang.CharSequence,java.lang.Object> values, java.lang.annotation.RetentionPolicy retentionPolicy)` Adds a stereotype and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addDefaultAnnotationValues(java.lang.String annotation, java.util.Map<java.lang.CharSequence,java.lang.Object> values)` Adds an annotation directly declared on the element and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addRepeatable(java.lang.String annotationName, AnnotationValue annotationValue)` Adds a repeatable annotation value.
`protected void`	`addRepeatable(java.lang.String annotationName, AnnotationValue annotationValue, java.lang.annotation.RetentionPolicy retentionPolicy)` Adds a repeatable annotation value.
`protected void`	`addRepeatableStereotype(java.util.List<java.lang.String> parents, java.lang.String stereotype, AnnotationValue annotationValue)` Adds a repeatable stereotype value.
`protected void`	`addStereotype(java.util.List<java.lang.String> parentAnnotations, java.lang.String stereotype, java.util.Map<java.lang.CharSequence,java.lang.Object> values)` Adds a stereotype and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addStereotype(java.util.List<java.lang.String> parentAnnotations, java.lang.String stereotype, java.util.Map<java.lang.CharSequence,java.lang.Object> values, java.lang.annotation.RetentionPolicy retentionPolicy)` Adds a stereotype and its member values, if the annotation already exists the data will be merged with existing values replaced.
`protected void`	`addValuesToResults(java.util.List<AnnotationValue> results, AnnotationValue values)` Adds a values instance to the results.
`static boolean`	`areAnnotationDefaultsRegistered(java.lang.String annotation)` Returns whether annotation defaults are registered for the give annotation.
`java.util.Optional<java.lang.Boolean>`	`booleanValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` The value as an optional boolean for the given annotation and member.
`java.util.Optional<java.lang.Boolean>`	`booleanValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the boolean value and optionally map its value.
`java.util.Optional<java.lang.Boolean>`	`booleanValue(java.lang.String annotation, java.lang.String member)` The value as an optional boolean for the given annotation and member.
`java.util.Optional<java.lang.Boolean>`	`booleanValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the boolean value and optionally map its value.
`java.util.Optional<java.lang.Class>`	`classValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` The value of the annotation as a Class.
`java.util.Optional<java.lang.Class>`	`classValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the class value and optionally map its value.
`java.util.Optional<java.lang.Class>`	`classValue(java.lang.String annotation, java.lang.String member)` The value of the annotation as a Class.
`java.util.Optional<java.lang.Class>`	`classValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the class value and optionally map its value.
`<T> java.lang.Class<T>[]`	`classValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` The value of the annotation as a Class.
`<T> java.lang.Class<T>[]`	`classValues(java.lang.String annotation, java.lang.String member)` The value of the annotation as a Class.
`DefaultAnnotationMetadata`	`clone()`
`static void`	`contributeDefaults(AnnotationMetadata target, AnnotationMetadata source)` Contributes defaults to the given target.
`java.util.OptionalDouble`	`doubleValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` The value as an `OptionalDouble` for the given annotation and member.
`java.util.OptionalDouble`	`doubleValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the double value and optionally map its value.
`java.util.OptionalDouble`	`doubleValue(java.lang.String annotation, java.lang.String member)` The value as an `OptionalDouble` for the given annotation and member.
`java.util.OptionalDouble`	`doubleValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the double value and optionally map its value.
`<E extends java.lang.Enum> java.util.Optional<E>`	`enumValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.Class<E> enumType)` The value of the annotation as a Class.
`<E extends java.lang.Enum> java.util.Optional<E>`	`enumValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType)` The value of the annotation as a Class.
`<E extends java.lang.Enum> java.util.Optional<E>`	`enumValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the class value and optionally map its value.
`<E extends java.lang.Enum> java.util.Optional<E>`	`enumValue(java.lang.String annotation, java.lang.Class<E> enumType)` The value of the given enum.
`<E extends java.lang.Enum> java.util.Optional<E>`	`enumValue(java.lang.String annotation, java.lang.String member, java.lang.Class<E> enumType)` The value of the annotation as a Class.
`<E extends java.lang.Enum> java.util.Optional<E>`	`enumValue(java.lang.String annotation, java.lang.String member, java.lang.Class<E> enumType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the class value and optionally map its value.
`<E extends java.lang.Enum> E[]`	`enumValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.Class<E> enumType)` The enum values for the given annotation.
`<E extends java.lang.Enum> E[]`	`enumValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType)` The enum values for the given annotation.
`<E extends java.lang.Enum> E[]`	`enumValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the enum values and optionally map its value.
`<E extends java.lang.Enum> E[]`	`enumValues(java.lang.String annotation, java.lang.Class<E> enumType)` The enum values for the given annotation.
`<E extends java.lang.Enum> E[]`	`enumValues(java.lang.String annotation, java.lang.String member, java.lang.Class<E> enumType)` The enum values for the given annotation.
`<E extends java.lang.Enum> E[]`	`enumValues(java.lang.String annotation, java.lang.String member, java.lang.Class<E> enumType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the enum values and optionally map its value.
`<T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>`	`findAnnotation(java.lang.String annotation)` Find an `AnnotationValue` for the given annotation name.
`<T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>`	`findDeclaredAnnotation(java.lang.String annotation)` Get all of the values for the given annotation that are directly declared on the annotated element.
`java.util.Optional<java.lang.String>`	`getAnnotationNameByStereotype(java.lang.String stereotype)` Find the first annotation name for the given stereotype.
`java.util.Set<java.lang.String>`	`getAnnotationNames()` All the annotation names this metadata declares.
`java.util.List<java.lang.String>`	`getAnnotationNamesByStereotype(java.lang.String stereotype)` Resolve all of the annotation names that feature the given stereotype.
`java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>`	`getAnnotationType(java.lang.String name)` Gets the type for a given annotation if it is present on the classpath.
`java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>`	`getAnnotationType(java.lang.String name, java.lang.ClassLoader classLoader)` Gets the type for a given annotation if it is present on the classpath.
`java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>`	`getAnnotationTypeByStereotype(java.lang.String stereotype)` Find the first annotation name for the given stereotype.
`<T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>>`	`getAnnotationValuesByType(java.lang.Class<T> annotationType)` Gets all the annotation values by the given repeatable type.
`java.util.Set<java.lang.String>`	`getDeclaredAnnotationNames()` All the declared annotation names this metadata declares.
`java.util.List<java.lang.String>`	`getDeclaredAnnotationNamesByStereotype(java.lang.String stereotype)` Resolve all of the annotations names for the given stereotype that are declared annotations.
`<T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>>`	`getDeclaredAnnotationValuesByType(java.lang.Class<T> annotationType)` Gets only declared annotation values by the given repeatable type.
`<T> java.util.Optional<T>`	`getDefaultValue(java.lang.String annotation, java.lang.String member, Argument<T> requiredType)` Return the default value for the given annotation member.
`<T> java.util.Optional<T>`	`getDefaultValue(java.lang.String annotation, java.lang.String member, java.lang.Class<T> requiredType)` Return the default value for the given annotation member.
`java.util.Map<java.lang.String,java.lang.Object>`	`getDefaultValues(java.lang.String annotation)` Return the default values for the given annotation name.
`<T> java.util.Optional<T>`	`getValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<T> requiredType)` Get the value of the given annotation member.
`<T> java.util.Optional<T>`	`getValue(java.lang.String annotation, java.lang.String member, Argument<T> requiredType)` Get the value of the given annotation member.
`<T> java.util.Optional<T>`	`getValue(java.lang.String annotation, java.lang.String member, Argument<T> requiredType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Resolves the given value performing type conversion as necessary.
`<T> OptionalValues<T>`	`getValues(java.lang.String annotation, java.lang.Class<T> valueType)` Get all of the values for the given annotation and type of the underlying values.
`boolean`	`hasAnnotation(java.lang.String annotation)` Checks whether this object has the given annotation on the object itself or inherited from a parent.
`boolean`	`hasDeclaredAnnotation(java.lang.String annotation)` Checks whether this object has the given annotation directly declared on the object.
`boolean`	`hasDeclaredStereotype(java.lang.String annotation)` Checks whether this object has the given annotation stereotype on the object itself and not inherited from a parent
`boolean`	`hasStereotype(java.lang.String annotation)` Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
`java.util.OptionalInt`	`intValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` The value as an `OptionalInt` for the given annotation and member.
`java.util.OptionalInt`	`intValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the int value and optionally map its value.
`java.util.OptionalInt`	`intValue(java.lang.String annotation, java.lang.String member)` The value as an `OptionalInt` for the given annotation and member.
`java.util.OptionalInt`	`intValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the int value and optionally map its value.
`boolean`	`isEmpty()` Is the annotation metadata empty.
`boolean`	`isFalse(java.lang.String annotation, java.lang.String member)` Returns whether the value of the given member is true.
`boolean`	`isPresent(java.lang.String annotation, java.lang.String member)` Returns whether the value of the given member is present.
`boolean`	`isTrue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` Returns whether the value of the given member is true.
`boolean`	`isTrue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the boolean value and optionally map its value.
`boolean`	`isTrue(java.lang.String annotation, java.lang.String member)` Returns whether the value of the given member is true.
`boolean`	`isTrue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the boolean value and optionally map its value.
`java.util.OptionalLong`	`longValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` The value as an `OptionalLong` for the given annotation and member.
`java.util.OptionalLong`	`longValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the long value and optionally map its value.
`java.util.OptionalLong`	`longValue(java.lang.String annotation, java.lang.String member)` The value as an `OptionalLong` for the given annotation and member.
`java.util.OptionalLong`	`longValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the long value and optionally map its value.
`static AnnotationMetadata`	`mutateMember(AnnotationMetadata annotationMetadata, java.lang.String annotationName, java.util.Map<java.lang.CharSequence,java.lang.Object> members)` Sets a member of the given `AnnotationMetadata` return a new annotation metadata instance without mutating the existing.
`static AnnotationMetadata`	`mutateMember(AnnotationMetadata annotationMetadata, java.lang.String annotationName, java.lang.String member, java.lang.Object value)` Sets a member of the given `AnnotationMetadata` return a new annotation metadata instance without mutating the existing.
`static void`	`registerAnnotationDefaults(AnnotationClassValue<?> annotation, java.util.Map<java.lang.String,java.lang.Object> defaultValues)` Registers annotation default values.
`static void`	`registerAnnotationDefaults(java.lang.String annotation, java.util.Map<java.lang.String,java.lang.Object> defaultValues)` Registers annotation default values.
`static void`	`registerAnnotationType(AnnotationClassValue<?> annotation)` Registers annotation default values.
`java.util.Optional<java.lang.String>`	`stringValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` The value as an optional string for the given annotation and member.
`java.util.Optional<java.lang.String>`	`stringValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the string value and optionally map its value.
`java.util.Optional<java.lang.String>`	`stringValue(java.lang.String annotation, java.lang.String member)` The value as an optional string for the given annotation and member.
`java.util.Optional<java.lang.String>`	`stringValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the string value and optionally map its value.
`java.lang.String[]`	`stringValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member)` The values as string array for the given annotation and member.
`java.lang.String[]`	`stringValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)` Retrieve the string value and optionally map its value.
`<T extends java.lang.annotation.Annotation> T`	`synthesize(java.lang.Class<T> annotationClass)` Synthesizes a new annotation from the metadata for the given annotation type.
`java.lang.annotation.Annotation[]`	`synthesizeAll()` Synthesizes a new annotations from the metadata.
`<T extends java.lang.annotation.Annotation> T[]`	`synthesizeAnnotationsByType(java.lang.Class<T> annotationClass)` Synthesizes a new annotations from the metadata for the given type.
`java.lang.annotation.Annotation[]`	`synthesizeDeclared()` Synthesizes a new annotations from the metadata.
`<T extends java.lang.annotation.Annotation> T`	`synthesizeDeclared(java.lang.Class<T> annotationClass)` Synthesizes a new annotation from the metadata for the given annotation type.
`<T extends java.lang.annotation.Annotation> T[]`	`synthesizeDeclaredAnnotationsByType(java.lang.Class<T> annotationClass)` Synthesizes a new annotations from the metadata for the given type.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadata
booleanValue, booleanValue, classValue, classValue, classValues, classValues, doubleValue, findAnnotation, findDeclaredAnnotation, getAnnotationNameByStereotype, getAnnotationNamesByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDefaultValue, getDefaultValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, hasAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isFalse, isPresent, stringValue, stringValue, stringValues

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource
getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, synthesize, synthesizeAll, synthesizeDeclared, synthesizeDeclared

Field Detail

annotationMap

protected final java.util.Map<java.lang.String,java.lang.annotation.Annotation> annotationMap

declaredAnnotationMap

protected final java.util.Map<java.lang.String,java.lang.annotation.Annotation> declaredAnnotationMap

Constructor Detail

DefaultAnnotationMetadata
```
@Internal
protected DefaultAnnotationMetadata()
```
Constructs empty annotation metadata.

DefaultAnnotationMetadata

@Internal
public DefaultAnnotationMetadata(@Nullable
                                           java.util.Map<java.lang.String,java.util.Map<java.lang.CharSequence,java.lang.Object>> declaredAnnotations,
                                           @Nullable
                                           java.util.Map<java.lang.String,java.util.Map<java.lang.CharSequence,java.lang.Object>> declaredStereotypes,
                                           @Nullable
                                           java.util.Map<java.lang.String,java.util.Map<java.lang.CharSequence,java.lang.Object>> allStereotypes,
                                           @Nullable
                                           java.util.Map<java.lang.String,java.util.Map<java.lang.CharSequence,java.lang.Object>> allAnnotations,
                                           @Nullable
                                           java.util.Map<java.lang.String,java.util.List<java.lang.String>> annotationsByStereotype)

This constructor is designed to be used by compile time produced subclasses.

Parameters:: declaredAnnotations - The directly declared annotations; declaredStereotypes - The directly declared stereotypes; allStereotypes - All of the stereotypes; allAnnotations - All of the annotations; annotationsByStereotype - The annotations by stereotype

Method Detail

getDefaultValues
```
@NonNull
public java.util.Map<java.lang.String,java.lang.Object> getDefaultValues(@NonNull
                                                                                  java.lang.String annotation)
```
Description copied from interface: AnnotationMetadata

Return the default values for the given annotation name.

Specified by:

getDefaultValues in interface AnnotationMetadata

Parameters:

annotation - The annotation name

Returns:

The default values

isPresent
```
public boolean isPresent(@NonNull
                         java.lang.String annotation,
                         @NonNull
                         java.lang.String member)
```
Description copied from interface: AnnotationMetadata

Returns whether the value of the given member is present.

Specified by:

isPresent in interface AnnotationMetadata

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

enumValue

public <E extends java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                  java.lang.String annotation,
                                                                  java.lang.Class<E> enumType)

Description copied from interface: AnnotationMetadata

The value of the given enum.

Specified by:: enumValue in interface AnnotationMetadata
Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; enumType - The enum type
Returns:: An Optional enum value

enumValue

public <E extends java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                  java.lang.String annotation,
                                                                  @NonNull
                                                                  java.lang.String member,
                                                                  java.lang.Class<E> enumType)

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:: enumValue in interface AnnotationMetadata
Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; member - The annotation member; enumType - The enum type
Returns:: An Optional class

enumValue

public <E extends java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                                  java.lang.Class<E> enumType)

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:: enumValue in interface AnnotationMetadata
Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; enumType - The enum type
Returns:: An Optional class

enumValue

public <E extends java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                                  @NonNull
                                                                  java.lang.String member,
                                                                  java.lang.Class<E> enumType)

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:: enumValue in interface AnnotationMetadata
Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; member - The annotation member; enumType - The enum type
Returns:: An Optional class

enumValue

@Internal
public <E extends java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                            java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                                            @NonNull
                                                                            java.lang.String member,
                                                                            java.lang.Class<E> enumType,
                                                                            @Nullable
                                                                            java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the class value and optionally map its value.

Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; member - The member; enumType - The enum type; valueMapper - The value mapper
Returns:: The class value

enumValues
```
public <E extends java.lang.Enum> E[] enumValues(@NonNull
                                                 java.lang.String annotation,
                                                 java.lang.Class<E> enumType)
```
Description copied from interface: AnnotationMetadata

The enum values for the given annotation.

Specified by:

enumValues in interface AnnotationMetadata

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

enumType - The enum type

Returns:

An array of enum values

enumValues

public <E extends java.lang.Enum> E[] enumValues(@NonNull
                                                 java.lang.String annotation,
                                                 @NonNull
                                                 java.lang.String member,
                                                 java.lang.Class<E> enumType)

Description copied from interface: AnnotationMetadata

The enum values for the given annotation.

Specified by:: enumValues in interface AnnotationMetadata
Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; member - The annotation member; enumType - The enum type
Returns:: An array of enum values

enumValues
```
public <E extends java.lang.Enum> E[] enumValues(@NonNull
                                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                 java.lang.Class<E> enumType)
```
Description copied from interface: AnnotationMetadata

The enum values for the given annotation.

Specified by:

enumValues in interface AnnotationMetadata

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

enumType - The enum type

Returns:

An array of enum values

enumValues

public <E extends java.lang.Enum> E[] enumValues(@NonNull
                                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                 @NonNull
                                                 java.lang.String member,
                                                 java.lang.Class<E> enumType)

Description copied from interface: AnnotationMetadata

The enum values for the given annotation.

Specified by:: enumValues in interface AnnotationMetadata
Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; member - The annotation member; enumType - The enum type
Returns:: An array of enum values

enumValues

public <E extends java.lang.Enum> E[] enumValues(@NonNull
                                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                 @NonNull
                                                 java.lang.String member,
                                                 java.lang.Class<E> enumType,
                                                 @Nullable
                                                 java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the enum values and optionally map its value.

Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; member - The member; enumType - The enum type; valueMapper - The value mapper
Returns:: The enum value

enumValues

public <E extends java.lang.Enum> E[] enumValues(@NonNull
                                                 java.lang.String annotation,
                                                 @NonNull
                                                 java.lang.String member,
                                                 java.lang.Class<E> enumType,
                                                 @Nullable
                                                 java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the enum values and optionally map its value.

Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; member - The member; enumType - The enum type; valueMapper - The value mapper
Returns:: The enum value

enumValue

@Internal
public <E extends java.lang.Enum> java.util.Optional<E> enumValue(@NonNull
                                                                            java.lang.String annotation,
                                                                            @NonNull
                                                                            java.lang.String member,
                                                                            java.lang.Class<E> enumType,
                                                                            @Nullable
                                                                            java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the class value and optionally map its value.

Type Parameters:: E - The enum type
Parameters:: annotation - The annotation; member - The member; enumType - The enum type; valueMapper - The value mapper
Returns:: The class value

classValues
```
public <T> java.lang.Class<T>[] classValues(@NonNull
                                            java.lang.String annotation,
                                            @NonNull
                                            java.lang.String member)
```
Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:

classValues in interface AnnotationMetadata

Type Parameters:

T - The type of the class

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

classValues

public <T> java.lang.Class<T>[] classValues(@NonNull
                                            java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                            @NonNull
                                            java.lang.String member)

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:: classValues in interface AnnotationMetadata
Type Parameters:: T - The type of the class
Parameters:: annotation - The annotation; member - The annotation member
Returns:: An Optional class

classValue

@NonNull
public java.util.Optional<java.lang.Class> classValue(@NonNull
                                                               java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                               @NonNull
                                                               java.lang.String member)

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:: classValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The annotation member
Returns:: An Optional class

classValue

public java.util.Optional<java.lang.Class> classValue(@NonNull
                                                      java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                      @NonNull
                                                      java.lang.String member,
                                                      java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the class value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The class value

classValue

@NonNull
public java.util.Optional<java.lang.Class> classValue(@NonNull
                                                               java.lang.String annotation,
                                                               @NonNull
                                                               java.lang.String member)

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:: classValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The annotation member
Returns:: An Optional class

classValue

@Internal
public java.util.Optional<java.lang.Class> classValue(@NonNull
                                                                java.lang.String annotation,
                                                                @NonNull
                                                                java.lang.String member,
                                                                @Nullable
                                                                java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the class value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The class value

intValue

@NonNull
public java.util.OptionalInt intValue(@NonNull
                                               java.lang.String annotation,
                                               @NonNull
                                               java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an OptionalInt for the given annotation and member.

Specified by:: intValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: THe OptionalInt value

intValue

@NonNull
public java.util.OptionalInt intValue(@NonNull
                                               java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                               @NonNull
                                               java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an OptionalInt for the given annotation and member.

Specified by:: intValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: THe OptionalInt value

intValue

@Internal
public java.util.OptionalInt intValue(@NonNull
                                                java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                @NonNull
                                                java.lang.String member,
                                                @Nullable
                                                java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the int value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The int value

booleanValue

public java.util.Optional<java.lang.Boolean> booleanValue(@NonNull
                                                          java.lang.String annotation,
                                                          @NonNull
                                                          java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an optional boolean for the given annotation and member.

Specified by:: booleanValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: The string value if it is present

booleanValue

public java.util.Optional<java.lang.Boolean> booleanValue(@NonNull
                                                          java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                          @NonNull
                                                          java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an optional boolean for the given annotation and member.

Specified by:: booleanValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: The string value if it is present

booleanValue

public java.util.Optional<java.lang.Boolean> booleanValue(@NonNull
                                                          java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                          @NonNull
                                                          java.lang.String member,
                                                          java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the boolean value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The boolean value

booleanValue

@NonNull
public java.util.Optional<java.lang.Boolean> booleanValue(@NonNull
                                                                   java.lang.String annotation,
                                                                   @NonNull
                                                                   java.lang.String member,
                                                                   @Nullable
                                                                   java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the boolean value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The boolean value

longValue

@NonNull
public java.util.OptionalLong longValue(@NonNull
                                                 java.lang.String annotation,
                                                 @NonNull
                                                 java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an OptionalLong for the given annotation and member.

Specified by:: longValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: THe OptionalLong value

longValue

@NonNull
public java.util.OptionalLong longValue(@NonNull
                                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                 @NonNull
                                                 java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an OptionalLong for the given annotation and member.

Specified by:: longValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: THe OptionalLong value

longValue

@Internal
public java.util.OptionalLong longValue(@NonNull
                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                  @NonNull
                                                  java.lang.String member,
                                                  @Nullable
                                                  java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the long value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The long value

longValue

@NonNull
public java.util.OptionalLong longValue(@NonNull
                                                 java.lang.String annotation,
                                                 @NonNull
                                                 java.lang.String member,
                                                 @Nullable
                                                 java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the long value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The long value

intValue

@NonNull
public java.util.OptionalInt intValue(@NonNull
                                               java.lang.String annotation,
                                               @NonNull
                                               java.lang.String member,
                                               @Nullable
                                               java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the int value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The int value

stringValue

@NonNull
public java.util.Optional<java.lang.String> stringValue(@NonNull
                                                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                                 @NonNull
                                                                 java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an optional string for the given annotation and member.

Specified by:: stringValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: The string value if it is present

stringValue

public java.util.Optional<java.lang.String> stringValue(@NonNull
                                                        java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                        @NonNull
                                                        java.lang.String member,
                                                        java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the string value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The int value

stringValues

@NonNull
public java.lang.String[] stringValues(@NonNull
                                                java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                @NonNull
                                                java.lang.String member)

Description copied from interface: AnnotationMetadata

The values as string array for the given annotation and member.

Specified by:: stringValues in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: The string values if it is present

stringValues

@NonNull
public java.lang.String[] stringValues(@NonNull
                                                java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                @NonNull
                                                java.lang.String member,
                                                java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the string value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The int value

stringValue

@NonNull
public java.util.Optional<java.lang.String> stringValue(@NonNull
                                                                 java.lang.String annotation,
                                                                 @NonNull
                                                                 java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an optional string for the given annotation and member.

Specified by:: stringValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: The string value if it is present

stringValue

@NonNull
public java.util.Optional<java.lang.String> stringValue(@NonNull
                                                                 java.lang.String annotation,
                                                                 @NonNull
                                                                 java.lang.String member,
                                                                 @Nullable
                                                                 java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the string value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The string value

isTrue
```
public boolean isTrue(@NonNull
                      java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                      @NonNull
                      java.lang.String member)
```
Description copied from interface: AnnotationMetadata

Returns whether the value of the given member is true.

Specified by:

isTrue in interface AnnotationMetadata

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

isTrue

public boolean isTrue(@NonNull
                      java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                      @NonNull
                      java.lang.String member,
                      java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the boolean value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The boolean value

isTrue
```
public boolean isTrue(@NonNull
                      java.lang.String annotation,
                      @NonNull
                      java.lang.String member)
```
Description copied from interface: AnnotationMetadata

Returns whether the value of the given member is true.

Specified by:

isTrue in interface AnnotationMetadata

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

isTrue

public boolean isTrue(@NonNull
                      java.lang.String annotation,
                      @NonNull
                      java.lang.String member,
                      @Nullable
                      java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the boolean value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The boolean value

isFalse
```
public boolean isFalse(@NonNull
                       java.lang.String annotation,
                       @NonNull
                       java.lang.String member)
```
Description copied from interface: AnnotationMetadata

Returns whether the value of the given member is true.

Specified by:

isFalse in interface AnnotationMetadata

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

doubleValue

@NonNull
public java.util.OptionalDouble doubleValue(@NonNull
                                                     java.lang.String annotation,
                                                     @NonNull
                                                     java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an OptionalDouble for the given annotation and member.

Specified by:: doubleValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: THe OptionalDouble value

doubleValue

@NonNull
public java.util.OptionalDouble doubleValue(@NonNull
                                                     java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                     @NonNull
                                                     java.lang.String member)

Description copied from interface: AnnotationMetadata

The value as an OptionalDouble for the given annotation and member.

Specified by:: doubleValue in interface AnnotationMetadata
Parameters:: annotation - The annotation; member - The member
Returns:: THe OptionalDouble value

doubleValue

@Internal
public java.util.OptionalDouble doubleValue(@NonNull
                                                      java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                      @NonNull
                                                      java.lang.String member,
                                                      @Nullable
                                                      java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the double value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The double value

doubleValue

@NonNull
 @Internal
public java.util.OptionalDouble doubleValue(@NonNull
                                                                java.lang.String annotation,
                                                                @NonNull
                                                                java.lang.String member,
                                                                java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Retrieve the double value and optionally map its value.

Parameters:: annotation - The annotation; member - The member; valueMapper - The value mapper
Returns:: The double value

getValue

@NonNull
public <T> java.util.Optional<T> getValue(@NonNull
                                                   java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                                   @NonNull
                                                   java.lang.String member,
                                                   @NonNull
                                                   java.lang.Class<T> requiredType)

Description copied from interface: AnnotationMetadata

Get the value of the given annotation member.

Specified by:: getValue in interface AnnotationMetadata
Type Parameters:: T - The value
Parameters:: annotation - The annotation class; member - The annotation member; requiredType - The required type
Returns:: An Optional of the value

getValue

@NonNull
public <T> java.util.Optional<T> getValue(@NonNull
                                                   java.lang.String annotation,
                                                   @NonNull
                                                   java.lang.String member,
                                                   @NonNull
                                                   Argument<T> requiredType)

Description copied from interface: AnnotationMetadata

Get the value of the given annotation member.

Specified by:: getValue in interface AnnotationMetadata
Type Parameters:: T - The value
Parameters:: annotation - The annotation class; member - The annotation member; requiredType - The required type
Returns:: An Optional of the value

getValue

@NonNull
public <T> java.util.Optional<T> getValue(@NonNull
                                                   java.lang.String annotation,
                                                   @NonNull
                                                   java.lang.String member,
                                                   @NonNull
                                                   Argument<T> requiredType,
                                                   @Nullable
                                                   java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper)

Resolves the given value performing type conversion as necessary.

Type Parameters:: T - The generic type
Parameters:: annotation - The annotation; member - The member; requiredType - The required type; valueMapper - The value mapper
Returns:: The resolved value

getDefaultValue

@NonNull
public <T> java.util.Optional<T> getDefaultValue(@NonNull
                                                          java.lang.String annotation,
                                                          @NonNull
                                                          java.lang.String member,
                                                          @NonNull
                                                          java.lang.Class<T> requiredType)

Description copied from interface: AnnotationMetadata

Return the default value for the given annotation member.

Specified by:: getDefaultValue in interface AnnotationMetadata
Type Parameters:: T - The required generic type
Parameters:: annotation - The annotation; member - The member; requiredType - The required type
Returns:: An optional value

getAnnotationValuesByType
```
@NonNull
public <T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>> getAnnotationValuesByType(@Nullable
                                                                                                                         java.lang.Class<T> annotationType)
```
Description copied from interface: AnnotationMetadata

Gets all the annotation values by the given repeatable type.

Specified by:

getAnnotationValuesByType in interface AnnotationMetadata

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

getDeclaredAnnotationValuesByType
```
@NonNull
public <T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>> getDeclaredAnnotationValuesByType(@NonNull
                                                                                                                                 java.lang.Class<T> annotationType)
```
Description copied from interface: AnnotationMetadata

Gets only declared annotation values by the given repeatable type.

Specified by:

getDeclaredAnnotationValuesByType in interface AnnotationMetadata

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

synthesizeAnnotationsByType
```
public <T extends java.lang.annotation.Annotation> T[] synthesizeAnnotationsByType(@NonNull
                                                                                   java.lang.Class<T> annotationClass)
```
Description copied from interface: AnnotationSource

Synthesizes a new annotations from the metadata for the given type. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Specified by:

synthesizeAnnotationsByType in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation type

Returns:

All annotations by the given type

synthesizeDeclaredAnnotationsByType
```
public <T extends java.lang.annotation.Annotation> T[] synthesizeDeclaredAnnotationsByType(@NonNull
                                                                                           java.lang.Class<T> annotationClass)
```
Description copied from interface: AnnotationSource

Synthesizes a new annotations from the metadata for the given type. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Specified by:

synthesizeDeclaredAnnotationsByType in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation type

Returns:

Declared annotations by the given type

isEmpty
```
public boolean isEmpty()
```
Description copied from interface: AnnotationMetadata

Is the annotation metadata empty.

Specified by:

isEmpty in interface AnnotationMetadata

Returns:

True if it is

hasDeclaredAnnotation
```
public boolean hasDeclaredAnnotation(java.lang.String annotation)
```
Description copied from interface: AnnotationMetadata

Checks whether this object has the given annotation directly declared on the object.

Specified by:

hasDeclaredAnnotation in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasAnnotation
```
public boolean hasAnnotation(java.lang.String annotation)
```
Description copied from interface: AnnotationMetadata

Checks whether this object has the given annotation on the object itself or inherited from a parent.

Specified by:

hasAnnotation in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasStereotype
```
public boolean hasStereotype(java.lang.String annotation)
```
Description copied from interface: AnnotationMetadata

Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
.

An annotation stereotype is a meta annotation potentially applied to another annotation

Specified by:

hasStereotype in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasDeclaredStereotype
```
public boolean hasDeclaredStereotype(java.lang.String annotation)
```
Description copied from interface: AnnotationMetadata

Checks whether this object has the given annotation stereotype on the object itself and not inherited from a parent
.

An annotation stereotype is a meta annotation potentially applied to another annotation

Specified by:

hasDeclaredStereotype in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

getAnnotationTypeByStereotype

@NonNull
public java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>> getAnnotationTypeByStereotype(@Nullable
                                                                                                                             java.lang.String stereotype)

Description copied from interface: AnnotationMetadata

Find the first annotation name for the given stereotype.

Specified by:: getAnnotationTypeByStereotype in interface AnnotationMetadata
Parameters:: stereotype - The stereotype
Returns:: The annotation name

getAnnotationNameByStereotype
```
@NonNull
public java.util.Optional<java.lang.String> getAnnotationNameByStereotype(@Nullable
                                                                                   java.lang.String stereotype)
```
Description copied from interface: AnnotationMetadata

Find the first annotation name for the given stereotype.

Specified by:

getAnnotationNameByStereotype in interface AnnotationMetadata

Parameters:

stereotype - The stereotype

Returns:

The annotation name

getAnnotationNamesByStereotype
```
@NonNull
public java.util.List<java.lang.String> getAnnotationNamesByStereotype(@Nullable
                                                                                java.lang.String stereotype)
```
Description copied from interface: AnnotationMetadata

Resolve all of the annotation names that feature the given stereotype.

Specified by:

getAnnotationNamesByStereotype in interface AnnotationMetadata

Parameters:

stereotype - The annotation names

Returns:

A set of annotation names

getAnnotationNames
```
@NonNull
public java.util.Set<java.lang.String> getAnnotationNames()
```
Description copied from interface: AnnotationMetadata

All the annotation names this metadata declares.

Specified by:

getAnnotationNames in interface AnnotationMetadata

Returns:

All the annotation names this metadata declares

getDeclaredAnnotationNames
```
@NonNull
public java.util.Set<java.lang.String> getDeclaredAnnotationNames()
```
Description copied from interface: AnnotationMetadata

All the declared annotation names this metadata declares.

Specified by:

getDeclaredAnnotationNames in interface AnnotationMetadata

Returns:

All the declared annotation names this metadata declares

getDeclaredAnnotationNamesByStereotype
```
@NonNull
public java.util.List<java.lang.String> getDeclaredAnnotationNamesByStereotype(@Nullable
                                                                                        java.lang.String stereotype)
```
Description copied from interface: AnnotationMetadata

Resolve all of the annotations names for the given stereotype that are declared annotations.

Specified by:

getDeclaredAnnotationNamesByStereotype in interface AnnotationMetadata

Parameters:

stereotype - The stereotype

Returns:

The declared annotations

getAnnotationType
```
@NonNull
public java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>> getAnnotationType(@NonNull
                                                                                                                 java.lang.String name)
```
Description copied from interface: AnnotationMetadata

Gets the type for a given annotation if it is present on the classpath. Subclasses can potentially override to provide optimized loading.

Specified by:

getAnnotationType in interface AnnotationMetadata

Parameters:

name - The type name

Returns:

The type if present

getAnnotationType

@NonNull
public java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>> getAnnotationType(@NonNull
                                                                                                                 java.lang.String name,
                                                                                                                 @NonNull
                                                                                                                 java.lang.ClassLoader classLoader)

Description copied from interface: AnnotationMetadata

Gets the type for a given annotation if it is present on the classpath. Subclasses can potentially override to provide optimized loading.

Specified by:: getAnnotationType in interface AnnotationMetadata
Parameters:: name - The type name; classLoader - The ClassLoader to load the type
Returns:: The type if present

findAnnotation
```
@NonNull
public <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findAnnotation(@NonNull
                                                                                                                  java.lang.String annotation)
```
Description copied from interface: AnnotationSource

Find an AnnotationValue for the given annotation name.

Specified by:

findAnnotation in interface AnnotationSource

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

findDeclaredAnnotation
```
@NonNull
public <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull
                                                                                                                          java.lang.String annotation)
```
Description copied from interface: AnnotationSource

Get all of the values for the given annotation that are directly declared on the annotated element.

Specified by:

findDeclaredAnnotation in interface AnnotationSource

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

getValues
```
@NonNull
public <T> OptionalValues<T> getValues(@NonNull
                                                java.lang.String annotation,
                                                @NonNull
                                                java.lang.Class<T> valueType)
```
Description copied from interface: AnnotationMetadata

Get all of the values for the given annotation and type of the underlying values.

Specified by:

getValues in interface AnnotationMetadata

Type Parameters:

T - Generic type

Parameters:

annotation - The annotation name

valueType - valueType

Returns:

The OptionalValues

getDefaultValue

@NonNull
public <T> java.util.Optional<T> getDefaultValue(@NonNull
                                                          java.lang.String annotation,
                                                          @NonNull
                                                          java.lang.String member,
                                                          @NonNull
                                                          Argument<T> requiredType)

Description copied from interface: AnnotationMetadata

Return the default value for the given annotation member.

Specified by:: getDefaultValue in interface AnnotationMetadata
Type Parameters:: T - The required generic type
Parameters:: annotation - The annotation; member - The member; requiredType - The required type
Returns:: An optional value

clone

public DefaultAnnotationMetadata clone()

Overrides:: clone in class java.lang.Object

addAnnotation
```
protected final void addAnnotation(java.lang.String annotation,
                                   java.util.Map<java.lang.CharSequence,java.lang.Object> values)
```
Adds an annotation and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:

annotation - The annotation

values - The values

addAnnotation

protected final void addAnnotation(java.lang.String annotation,
                                   java.util.Map<java.lang.CharSequence,java.lang.Object> values,
                                   java.lang.annotation.RetentionPolicy retentionPolicy)

Adds an annotation and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:: annotation - The annotation; values - The values; retentionPolicy - The retention policy

addDefaultAnnotationValues
```
protected final void addDefaultAnnotationValues(java.lang.String annotation,
                                                java.util.Map<java.lang.CharSequence,java.lang.Object> values)
```
Adds an annotation directly declared on the element and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:

annotation - The annotation

values - The values

areAnnotationDefaultsRegistered
```
@Internal
public static boolean areAnnotationDefaultsRegistered(java.lang.String annotation)
```
Returns whether annotation defaults are registered for the give annotation. Used by generated byte code. DO NOT REMOVE.

Parameters:

annotation - The annotation name

Returns:

True if defaults have already been registered

registerAnnotationDefaults

@Internal
public static void registerAnnotationDefaults(java.lang.String annotation,
                                                        java.util.Map<java.lang.String,java.lang.Object> defaultValues)

Registers annotation default values. Used by generated byte code. DO NOT REMOVE.

Parameters:: annotation - The annotation name; defaultValues - The default values

registerAnnotationDefaults

@Internal
public static void registerAnnotationDefaults(AnnotationClassValue<?> annotation,
                                                        java.util.Map<java.lang.String,java.lang.Object> defaultValues)

Registers annotation default values. Used by generated byte code. DO NOT REMOVE.

Parameters:: annotation - The annotation name; defaultValues - The default values

registerAnnotationType
```
@Internal
public static void registerAnnotationType(AnnotationClassValue<?> annotation)
```
Registers annotation default values. Used by generated byte code. DO NOT REMOVE.

Parameters:

annotation - The annotation

addRepeatable

protected final void addRepeatable(java.lang.String annotationName,
                                   AnnotationValue annotationValue)

Adds a repeatable annotation value. If a value already exists will be added

Parameters:: annotationName - The annotation name; annotationValue - The annotation value

addRepeatable

protected final void addRepeatable(java.lang.String annotationName,
                                   AnnotationValue annotationValue,
                                   java.lang.annotation.RetentionPolicy retentionPolicy)

Adds a repeatable annotation value. If a value already exists will be added

Parameters:: annotationName - The annotation name; annotationValue - The annotation value; retentionPolicy - The retention policy

addRepeatableStereotype

protected void addRepeatableStereotype(java.util.List<java.lang.String> parents,
                                       java.lang.String stereotype,
                                       AnnotationValue annotationValue)

Adds a repeatable stereotype value. If a value already exists will be added

Parameters:: parents - The parent annotations; stereotype - The annotation name; annotationValue - The annotation value

addDeclaredRepeatableStereotype

protected void addDeclaredRepeatableStereotype(java.util.List<java.lang.String> parents,
                                               java.lang.String stereotype,
                                               AnnotationValue annotationValue)

Adds a repeatable declared stereotype value. If a value already exists will be added

Parameters:: parents - The parent annotations; stereotype - The annotation name; annotationValue - The annotation value

addDeclaredRepeatable

protected final void addDeclaredRepeatable(java.lang.String annotationName,
                                           AnnotationValue annotationValue)

Adds a repeatable annotation value. If a value already exists will be added

Parameters:: annotationName - The annotation name; annotationValue - The annotation value

addDeclaredRepeatable

protected final void addDeclaredRepeatable(java.lang.String annotationName,
                                           AnnotationValue annotationValue,
                                           java.lang.annotation.RetentionPolicy retentionPolicy)

Adds a repeatable annotation value. If a value already exists will be added

Parameters:: annotationName - The annotation name; annotationValue - The annotation value; retentionPolicy - The retention policy

addStereotype

protected final void addStereotype(java.util.List<java.lang.String> parentAnnotations,
                                   java.lang.String stereotype,
                                   java.util.Map<java.lang.CharSequence,java.lang.Object> values)

Adds a stereotype and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:: parentAnnotations - The parent annotations; stereotype - The annotation; values - The values

addStereotype

protected final void addStereotype(java.util.List<java.lang.String> parentAnnotations,
                                   java.lang.String stereotype,
                                   java.util.Map<java.lang.CharSequence,java.lang.Object> values,
                                   java.lang.annotation.RetentionPolicy retentionPolicy)

Adds a stereotype and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:: parentAnnotations - The parent annotations; stereotype - The annotation; values - The values; retentionPolicy - The retention policy

addDeclaredStereotype

protected final void addDeclaredStereotype(java.util.List<java.lang.String> parentAnnotations,
                                           java.lang.String stereotype,
                                           java.util.Map<java.lang.CharSequence,java.lang.Object> values)

Adds a stereotype and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:: parentAnnotations - The parent annotations; stereotype - The annotation; values - The values

addDeclaredStereotype

protected final void addDeclaredStereotype(java.util.List<java.lang.String> parentAnnotations,
                                           java.lang.String stereotype,
                                           java.util.Map<java.lang.CharSequence,java.lang.Object> values,
                                           java.lang.annotation.RetentionPolicy retentionPolicy)

Adds a stereotype and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:: parentAnnotations - The parent annotations; stereotype - The annotation; values - The values; retentionPolicy - The retention policy

addDeclaredAnnotation
```
protected void addDeclaredAnnotation(java.lang.String annotation,
                                     java.util.Map<java.lang.CharSequence,java.lang.Object> values)
```
Adds an annotation directly declared on the element and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:

annotation - The annotation

values - The values

addDeclaredAnnotation
```
protected void addDeclaredAnnotation(java.lang.String annotation,
                                     java.util.Map<java.lang.CharSequence,java.lang.Object> values,
                                     java.lang.annotation.RetentionPolicy retentionPolicy)
```
Adds an annotation directly declared on the element and its member values, if the annotation already exists the data will be merged with existing values replaced.

Parameters:

annotation - The annotation

values - The values

retentionPolicy - The retention policy

mutateMember

@Internal
public static AnnotationMetadata mutateMember(AnnotationMetadata annotationMetadata,
                                                        java.lang.String annotationName,
                                                        java.lang.String member,
                                                        java.lang.Object value)

Sets a member of the given AnnotationMetadata return a new annotation metadata instance without mutating the existing.

WARNING: for internal use only be the framework

Parameters:: annotationMetadata - The metadata; annotationName - The annotation name; member - The member; value - The value
Returns:: The metadata

contributeDefaults

@Internal
public static void contributeDefaults(AnnotationMetadata target,
                                                AnnotationMetadata source)

Contributes defaults to the given target.

WARNING: for internal use only be the framework

Parameters:: target - The target; source - The source

mutateMember
```
@Internal
public static AnnotationMetadata mutateMember(AnnotationMetadata annotationMetadata,
                                                        java.lang.String annotationName,
                                                        java.util.Map<java.lang.CharSequence,java.lang.Object> members)
```
Sets a member of the given AnnotationMetadata return a new annotation metadata instance without mutating the existing.

WARNING: for internal use only be the framework

Parameters:

annotationMetadata - The metadata

annotationName - The annotation name

members - The key/value set of members and values

Returns:

The metadata

synthesize
```
@Nullable
public <T extends java.lang.annotation.Annotation> T synthesize(@NonNull
                                                                          java.lang.Class<T> annotationClass)
```
Description copied from interface: AnnotationSource

Synthesizes a new annotation from the metadata for the given annotation type. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Specified by:

synthesize in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

Returns:

The annotation or null if it doesn't exist

synthesizeDeclared
```
@Nullable
public <T extends java.lang.annotation.Annotation> T synthesizeDeclared(@NonNull
                                                                                  java.lang.Class<T> annotationClass)
```
Description copied from interface: AnnotationSource

Synthesizes a new annotation from the metadata for the given annotation type. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.
This method ignores inherited annotations. (Returns null if no annotations are directly present on this element.)

Specified by:

synthesizeDeclared in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

Returns:

The annotation or null if it doesn't exist

synthesizeAll
```
@NonNull
public java.lang.annotation.Annotation[] synthesizeAll()
```
Description copied from interface: AnnotationSource

Synthesizes a new annotations from the metadata. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Specified by:

synthesizeAll in interface AnnotationSource

Returns:

All the annotations

synthesizeDeclared
```
@NonNull
public java.lang.annotation.Annotation[] synthesizeDeclared()
```
Description copied from interface: AnnotationSource

Synthesizes a new annotations from the metadata. This method works by creating a runtime proxy of the annotation interface and should be avoided in favour of direct use of the annotation metadata and only used for unique cases that require integrating third party libraries.

Specified by:

synthesizeDeclared in interface AnnotationSource

Returns:

All declared annotations

addAnnotationValuesFromData

protected final void addAnnotationValuesFromData(java.util.List results,
                                                 java.util.Map<java.lang.CharSequence,java.lang.Object> values)

Adds any annotation values found in the values map to the results.

Parameters:: results - The results; values - The values

addValuesToResults

protected void addValuesToResults(java.util.List<AnnotationValue> results,
                                  AnnotationValue values)

Adds a values instance to the results.

Parameters:: results - The results; values - The values

Class DefaultAnnotationMetadata

Field Summary

Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadata

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadata

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

Field Detail

annotationMap

declaredAnnotationMap

Constructor Detail

DefaultAnnotationMetadata

DefaultAnnotationMetadata

Method Detail

getDefaultValues

isPresent

enumValue

enumValue

enumValue

enumValue

enumValue

enumValues

enumValues

enumValues

enumValues

enumValues

enumValues

enumValue

classValues

classValues

classValue

classValue

classValue

classValue

intValue

intValue

intValue

booleanValue

booleanValue

booleanValue

booleanValue

longValue

longValue

longValue

longValue

intValue

stringValue

stringValue

stringValues

stringValues

stringValue

stringValue

isTrue

isTrue

isTrue

isTrue

isFalse

doubleValue

doubleValue

doubleValue

doubleValue

getValue

getValue

getValue

getDefaultValue

getAnnotationValuesByType

getDeclaredAnnotationValuesByType

synthesizeAnnotationsByType

synthesizeDeclaredAnnotationsByType

isEmpty

hasDeclaredAnnotation

hasAnnotation

hasStereotype

hasDeclaredStereotype

getAnnotationTypeByStereotype

getAnnotationNameByStereotype

getAnnotationNamesByStereotype

getAnnotationNames