DefaultAnnotationMetadata (micronaut 3.4.2 API)

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

All Implemented Interfaces:

AnnotationMetadata, AnnotationSource, Cloneable

Direct Known Subclasses:

MutableAnnotationMetadata
```
@Internal
public class DefaultAnnotationMetadata
extends Object
implements AnnotationMetadata, 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 Map<String,Annotation> annotationMap

protected Map<String,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

Fields
Modifier and Type	Field and Description
`protected Map<String,Annotation>`	`annotationMap`
`protected Map<String,Annotation>`	`declaredAnnotationMap`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DefaultAnnotationMetadata()` Constructs empty annotation metadata.
	`DefaultAnnotationMetadata(Map<String,Map<CharSequence,Object>> declaredAnnotations, Map<String,Map<CharSequence,Object>> declaredStereotypes, Map<String,Map<CharSequence,Object>> allStereotypes, Map<String,Map<CharSequence,Object>> allAnnotations, Map<String,List<String>> annotationsByStereotype)` This constructor is designed to be used by compile time produced subclasses.
	`DefaultAnnotationMetadata(Map<String,Map<CharSequence,Object>> declaredAnnotations, Map<String,Map<CharSequence,Object>> declaredStereotypes, Map<String,Map<CharSequence,Object>> allStereotypes, Map<String,Map<CharSequence,Object>> allAnnotations, Map<String,List<String>> annotationsByStereotype, boolean hasPropertyExpressions)` This constructor is designed to be used by compile time produced subclasses.
	`DefaultAnnotationMetadata(Map<String,Map<CharSequence,Object>> declaredAnnotations, Map<String,Map<CharSequence,Object>> declaredStereotypes, Map<String,Map<CharSequence,Object>> allStereotypes, Map<String,Map<CharSequence,Object>> allAnnotations, Map<String,List<String>> annotationsByStereotype, boolean hasPropertyExpressions, boolean useRepeatableDefaults)` 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(String annotation, Map<CharSequence,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(String annotation, Map<CharSequence,Object> values, 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(List results, Map<CharSequence,Object> values)` Adds any annotation values found in the values map to the results.
`protected void`	`addDeclaredAnnotation(String annotation, Map<CharSequence,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(String annotation, Map<CharSequence,Object> values, 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(String annotationName, AnnotationValue annotationValue)` Adds a repeatable annotation value.
`protected void`	`addDeclaredRepeatable(String annotationName, AnnotationValue annotationValue, RetentionPolicy retentionPolicy)` Adds a repeatable annotation value.
`protected void`	`addDeclaredRepeatableStereotype(List<String> parents, String stereotype, AnnotationValue annotationValue)` Adds a repeatable declared stereotype value.
`protected void`	`addDeclaredStereotype(List<String> parentAnnotations, String stereotype, Map<CharSequence,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(List<String> parentAnnotations, String stereotype, Map<CharSequence,Object> values, 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(String annotation, Map<CharSequence,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(String annotationName, AnnotationValue annotationValue)` Adds a repeatable annotation value.
`protected void`	`addRepeatable(String annotationName, AnnotationValue annotationValue, RetentionPolicy retentionPolicy)` Adds a repeatable annotation value.
`protected void`	`addRepeatableStereotype(List<String> parents, String stereotype, AnnotationValue annotationValue)` Adds a repeatable stereotype value.
`protected void`	`addStereotype(List<String> parentAnnotations, String stereotype, Map<CharSequence,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(List<String> parentAnnotations, String stereotype, Map<CharSequence,Object> values, 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(List<AnnotationValue> results, AnnotationValue values)` Adds a values instance to the results.
`static boolean`	`areAnnotationDefaultsRegistered(String annotation)` Returns whether annotation defaults are registered for the give annotation.
`Optional<Boolean>`	`booleanValue(Class<? extends Annotation> annotation, String member)` The value as an optional boolean for the given annotation and member.
`Optional<Boolean>`	`booleanValue(Class<? extends Annotation> annotation, String member, Function<Object,Object> valueMapper)` Retrieve the boolean value and optionally map its value.
`Optional<Boolean>`	`booleanValue(String annotation, String member)` The value as an optional boolean for the given annotation and member.
`Optional<Boolean>`	`booleanValue(String annotation, String member, Function<Object,Object> valueMapper)` Retrieve the boolean value and optionally map its value.
`Optional<Class>`	`classValue(Class<? extends Annotation> annotation, String member)` The value of the annotation as a Class.
`Optional<Class>`	`classValue(Class<? extends Annotation> annotation, String member, Function<Object,Object> valueMapper)` Retrieve the class value and optionally map its value.
`Optional<Class>`	`classValue(String annotation, String member)` The value of the annotation as a Class.
`Optional<Class>`	`classValue(String annotation, String member, Function<Object,Object> valueMapper)` Retrieve the class value and optionally map its value.
`<T> Class<T>[]`	`classValues(Class<? extends Annotation> annotation, String member)` The value of the annotation as a Class.
`<T> Class<T>[]`	`classValues(String annotation, 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.
`static void`	`contributeRepeatable(AnnotationMetadata target, AnnotationMetadata source)` Contributes repeatable annotation metadata to the given target.
`static void`	`contributeRepeatable(AnnotationMetadata target, ClassElement classElement)` Contributes repeatable annotation metadata to the given class element.
`OptionalDouble`	`doubleValue(Class<? extends Annotation> annotation, String member)` The value as an `OptionalDouble` for the given annotation and member.
`OptionalDouble`	`doubleValue(Class<? extends Annotation> annotation, String member, Function<Object,Object> valueMapper)` Retrieve the double value and optionally map its value.
`OptionalDouble`	`doubleValue(String annotation, String member)` The value as an `OptionalDouble` for the given annotation and member.
`OptionalDouble`	`doubleValue(String annotation, String member, Function<Object,Object> valueMapper)` Retrieve the double value and optionally map its value.
`<E extends Enum> Optional<E>`	`enumValue(Class<? extends Annotation> annotation, Class<E> enumType)` The value of the annotation as a Class.
`<E extends Enum> Optional<E>`	`enumValue(Class<? extends Annotation> annotation, String member, Class<E> enumType)` The value of the annotation as a Class.
`<E extends Enum> Optional<E>`	`enumValue(Class<? extends Annotation> annotation, String member, Class<E> enumType, Function<Object,Object> valueMapper)` Retrieve the class value and optionally map its value.
`<E extends Enum> Optional<E>`	`enumValue(String annotation, Class<E> enumType)` The value of the given enum.
`<E extends Enum> Optional<E>`	`enumValue(String annotation, String member, Class<E> enumType)` The value of the annotation as a Class.
`<E extends Enum> Optional<E>`	`enumValue(String annotation, String member, Class<E> enumType, Function<Object,Object> valueMapper)` Retrieve the class value and optionally map its value.
`<E extends Enum> E[]`	`enumValues(Class<? extends Annotation> annotation, Class<E> enumType)` The enum values for the given annotation.
`<E extends Enum> E[]`	`enumValues(Class<? extends Annotation> annotation, String member, Class<E> enumType)` The enum values for the given annotation.
`<E extends Enum> E[]`	`enumValues(Class<? extends Annotation> annotation, String member, Class<E> enumType, Function<Object,Object> valueMapper)` Retrieve the enum values and optionally map its value.
`<E extends Enum> E[]`	`enumValues(String annotation, Class<E> enumType)` The enum values for the given annotation.
`<E extends Enum> E[]`	`enumValues(String annotation, String member, Class<E> enumType)` The enum values for the given annotation.
`<E extends Enum> E[]`	`enumValues(String annotation, String member, Class<E> enumType, Function<Object,Object> valueMapper)` Retrieve the enum values and optionally map its value.
`<T extends Annotation> Optional<AnnotationValue<T>>`	`findAnnotation(String annotation)` Find an `AnnotationValue` for the given annotation name.
`<T extends Annotation> Optional<AnnotationValue<T>>`	`findDeclaredAnnotation(String annotation)` Get all of the values for the given annotation that are directly declared on the annotated element.
`Optional<String>`	`findRepeatableAnnotation(Class<? extends Annotation> annotation)` Find repeatable annotation container.
`Optional<String>`	`findRepeatableAnnotation(String annotation)` Find repeatable annotation container.
`Optional<String>`	`getAnnotationNameByStereotype(String stereotype)` Find the first annotation name for the given stereotype.
`Set<String>`	`getAnnotationNames()` All the annotation names this metadata declares.
`List<String>`	`getAnnotationNamesByStereotype(String stereotype)` Resolve all of the annotation names that feature the given stereotype.
`Optional<Class<? extends Annotation>>`	`getAnnotationType(String name)` Gets the type for a given annotation if it is present on the classpath.
`Optional<Class<? extends Annotation>>`	`getAnnotationType(String name, ClassLoader classLoader)` Gets the type for a given annotation if it is present on the classpath.
`Optional<Class<? extends Annotation>>`	`getAnnotationTypeByStereotype(String stereotype)` Find the first annotation name for the given stereotype.
`<T extends Annotation> List<AnnotationValue<T>>`	`getAnnotationValuesByName(String annotationType)` Gets all the annotation values by the given repeatable type name.
`<T extends Annotation> List<AnnotationValue<T>>`	`getAnnotationValuesByType(Class<T> annotationType)` Gets all the annotation values by the given repeatable type.
`Set<String>`	`getDeclaredAnnotationNames()` All the declared annotation names this metadata declares.
`List<String>`	`getDeclaredAnnotationNamesByStereotype(String stereotype)` Resolve all of the annotations names for the given stereotype that are declared annotations.
`<T extends Annotation> List<AnnotationValue<T>>`	`getDeclaredAnnotationValuesByName(String annotationType)` Gets only declared annotation values by the given repeatable type name.
`<T extends Annotation> List<AnnotationValue<T>>`	`getDeclaredAnnotationValuesByType(Class<T> annotationType)` Gets only declared annotation values by the given repeatable type.
`AnnotationMetadata`	`getDeclaredMetadata()` Gets the declared metadata without inherited metdata.
`Set<String>`	`getDeclaredStereotypeAnnotationNames()` Returns the names of the annotations which are declared stereotypes.
`<T> Optional<T>`	`getDefaultValue(String annotation, String member, Argument<T> requiredType)` Return the default value for the given annotation member.
`<T> Optional<T>`	`getDefaultValue(String annotation, String member, Class<T> requiredType)` Return the default value for the given annotation member.
`Map<String,Object>`	`getDefaultValues(String annotation)` Return the default values for the given annotation name.
`Set<String>`	`getStereotypeAnnotationNames()` Returns the names of the annotations which are stereotypes.
`<T> Optional<T>`	`getValue(Class<? extends Annotation> annotation, String member, Class<T> requiredType)` Get the value of the given annotation member.
`<T> Optional<T>`	`getValue(String annotation, String member, Argument<T> requiredType)` Get the value of the given annotation member.
`<T> Optional<T>`	`getValue(String annotation, String member, Argument<T> requiredType, Function<Object,Object> valueMapper)` Resolves the given value performing type conversion as necessary.
`Map<CharSequence,Object>`	`getValues(String annotation)` Get all of the values for the given annotation and type of the underlying values.
`<T> OptionalValues<T>`	`getValues(String annotation, Class<T> valueType)` Get all of the values for the given annotation and type of the underlying values.
`boolean`	`hasAnnotation(String annotation)` Checks whether this object has the given annotation on the object itself or inherited from a parent.
`boolean`	`hasDeclaredAnnotation(String annotation)` Checks whether this object has the given annotation directly declared on the object.
`boolean`	`hasDeclaredStereotype(String annotation)` Checks whether this object has the given annotation stereotype on the object itself and not inherited from a parent
`boolean`	`hasPropertyExpressions()` Does the metadata contain any property expressions like `${foo.bar}`.
`boolean`	`hasStereotype(String annotation)` Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
`OptionalInt`	`intValue(Class<? extends Annotation> annotation, String member)` The value as an `OptionalInt` for the given annotation and member.
`OptionalInt`	`intValue(Class<? extends Annotation> annotation, String member, Function<Object,Object> valueMapper)` Retrieve the int value and optionally map its value.
`OptionalInt`	`intValue(String annotation, String member)` The value as an `OptionalInt` for the given annotation and member.
`OptionalInt`	`intValue(String annotation, String member, Function<Object,Object> valueMapper)` Retrieve the int value and optionally map its value.
`boolean`	`isEmpty()` Is the annotation metadata empty.
`boolean`	`isFalse(String annotation, String member)` Returns whether the value of the given member is true.
`boolean`	`isPresent(String annotation, String member)` Returns whether the value of the given member is present.
`boolean`	`isRepeatableAnnotation(Class<? extends Annotation> annotation)` Is repeatable annotation?
`boolean`	`isRepeatableAnnotation(String annotation)` Is repeatable annotation?
`boolean`	`isTrue(Class<? extends Annotation> annotation, String member)` Returns whether the value of the given member is true.
`boolean`	`isTrue(Class<? extends Annotation> annotation, String member, Function<Object,Object> valueMapper)` Retrieve the boolean value and optionally map its value.
`boolean`	`isTrue(String annotation, String member)` Returns whether the value of the given member is true.
`boolean`	`isTrue(String annotation, String member, Function<Object,Object> valueMapper)` Retrieve the boolean value and optionally map its value.
`OptionalLong`	`longValue(Class<? extends Annotation> annotation, String member)` The value as an `OptionalLong` for the given annotation and member.
`OptionalLong`	`longValue(Class<? extends Annotation> annotation, String member, Function<Object,Object> valueMapper)` Retrieve the long value and optionally map its value.
`OptionalLong`	`longValue(String annotation, String member)` The value as an `OptionalLong` for the given annotation and member.
`OptionalLong`	`longValue(String annotation, String member, Function<Object,Object> valueMapper)` Retrieve the long value and optionally map its value.
`static AnnotationMetadata`	`mutateMember(AnnotationMetadata annotationMetadata, String annotationName, Map<CharSequence,Object> members)` Sets a member of the given `AnnotationMetadata` return a new annotation metadata instance without mutating the existing.
`static AnnotationMetadata`	`mutateMember(AnnotationMetadata annotationMetadata, String annotationName, String member, Object value)` Sets a member of the given `AnnotationMetadata` return a new annotation metadata instance without mutating the existing.
`static void`	`registerAnnotationDefaults(AnnotationClassValue<?> annotation, Map<String,Object> defaultValues)` Registers annotation default values.
`static void`	`registerAnnotationDefaults(String annotation, Map<String,Object> defaultValues)` Registers annotation default values.
`static void`	`registerAnnotationType(AnnotationClassValue<?> annotation)` Registers annotation default values.
`static void`	`registerRepeatableAnnotations(Map<String,String> repeatableAnnotations)` Registers repeatable annotations.
`protected void`	`removeAnnotation(String annotationType)` Removes an annotation for the given annotation type.
`protected <A extends Annotation> void`	`removeAnnotationIf(Predicate<AnnotationValue<A>> predicate)` Removes an annotation for the given predicate.
`protected void`	`removeStereotype(String annotationType)` Removes a stereotype annotation for the given annotation type.
`Optional<String>`	`stringValue(Class<? extends Annotation> annotation, String member)` The value as an optional string for the given annotation and member.
`Optional<String>`	`stringValue(Class<? extends Annotation> annotation, String member, Function<Object,Object> valueMapper)` Retrieve the string value and optionally map its value.
`Optional<String>`	`stringValue(String annotation, String member)` The value as an optional string for the given annotation and member.
`Optional<String>`	`stringValue(String annotation, String member, Function<Object,Object> valueMapper)` Retrieve the string value and optionally map its value.
`String[]`	`stringValues(Class<? extends Annotation> annotation, String member)` The values as string array for the given annotation and member.
`String[]`	`stringValues(Class<? extends Annotation> annotation, String member, Function<Object,Object> valueMapper)` Retrieve the string value and optionally map its value.
`String[]`	`stringValues(String annotation, String member)` The values as string array for the given annotation and member.
`String[]`	`stringValues(String annotation, String member, Function<Object,Object> valueMapper)` Retrieve the string value and optionally map its value.
`<T extends Annotation> T`	`synthesize(Class<T> annotationClass)` Synthesizes a new annotation from the metadata for the given annotation type.
`<T extends Annotation> T`	`synthesize(Class<T> annotationClass, String sourceAnnotation)` Synthesizes a new annotation for the given annotation type using the member values of the given source annotation.
`Annotation[]`	`synthesizeAll()` Synthesizes a new annotations from the metadata.
`<T extends Annotation> T[]`	`synthesizeAnnotationsByType(Class<T> annotationClass)` Synthesizes a new annotations from the metadata for the given type.
`Annotation[]`	`synthesizeDeclared()` Synthesizes a new annotations from the metadata.
`<T extends Annotation> T`	`synthesizeDeclared(Class<T> annotationClass)` Synthesizes a new annotation from the metadata for the given annotation type.
`<T extends Annotation> T`	`synthesizeDeclared(Class<T> annotationClass, String sourceAnnotation)` Synthesizes a new annotation declared for the given annotation type using the member values of the given source annotation.
`<T extends Annotation> T[]`	`synthesizeDeclaredAnnotationsByType(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, getAnnotationTypesByStereotype, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDefaultValue, getDefaultValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, hasAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, intValue, isAnnotationPresent, isAnnotationPresent, isDeclaredAnnotationPresent, isDeclaredAnnotationPresent, isFalse, isPresent, stringValue, stringValue, stringValues, stringValues

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

Field Detail

annotationMap

protected final Map<String,Annotation> annotationMap

declaredAnnotationMap

protected final Map<String,Annotation> declaredAnnotationMap

Constructor Detail

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

DefaultAnnotationMetadata

@Internal
public DefaultAnnotationMetadata(@Nullable
                                           Map<String,Map<CharSequence,Object>> declaredAnnotations,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> declaredStereotypes,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> allStereotypes,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> allAnnotations,
                                           @Nullable
                                           Map<String,List<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

DefaultAnnotationMetadata

@Internal
public DefaultAnnotationMetadata(@Nullable
                                           Map<String,Map<CharSequence,Object>> declaredAnnotations,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> declaredStereotypes,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> allStereotypes,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> allAnnotations,
                                           @Nullable
                                           Map<String,List<String>> annotationsByStereotype,
                                           boolean hasPropertyExpressions)

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; hasPropertyExpressions - Whether property expressions exist in the metadata

DefaultAnnotationMetadata

@Internal
public DefaultAnnotationMetadata(@Nullable
                                           Map<String,Map<CharSequence,Object>> declaredAnnotations,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> declaredStereotypes,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> allStereotypes,
                                           @Nullable
                                           Map<String,Map<CharSequence,Object>> allAnnotations,
                                           @Nullable
                                           Map<String,List<String>> annotationsByStereotype,
                                           boolean hasPropertyExpressions,
                                           boolean useRepeatableDefaults)

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; hasPropertyExpressions - Whether property expressions exist in the metadata; useRepeatableDefaults - Use repeatable defaults

Method Detail

getDeclaredMetadata
```
@NonNull
public AnnotationMetadata getDeclaredMetadata()
```
Description copied from interface: AnnotationMetadata

Gets the declared metadata without inherited metdata.

Specified by:

getDeclaredMetadata in interface AnnotationMetadata

Returns:

The declared metadata

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

Does the metadata contain any property expressions like ${foo.bar}. Note this by default returns true as previous versions of Micronaut must assume metadata is present. The compilation time this is computed in order to decide whether to instrument annotation metadata with environment specific logic.

Specified by:

hasPropertyExpressions in interface AnnotationMetadata

Returns:

True if property expressions are present

getDefaultValues
```
@NonNull
public Map<String,Object> getDefaultValues(@NonNull
                                                    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
                         String annotation,
                         @NonNull
                         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 Enum> Optional<E> enumValue(@NonNull
                                              String annotation,
                                              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 Enum> Optional<E> enumValue(@NonNull
                                              String annotation,
                                              @NonNull
                                              String member,
                                              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 Enum> Optional<E> enumValue(@NonNull
                                              Class<? extends Annotation> annotation,
                                              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 Enum> Optional<E> enumValue(@NonNull
                                              Class<? extends Annotation> annotation,
                                              @NonNull
                                              String member,
                                              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 Enum> Optional<E> enumValue(@NonNull
                                                        Class<? extends Annotation> annotation,
                                                        @NonNull
                                                        String member,
                                                        Class<E> enumType,
                                                        @Nullable
                                                        Function<Object,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 Enum> E[] enumValues(@NonNull
                                       String annotation,
                                       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 Enum> E[] enumValues(@NonNull
                                       String annotation,
                                       @NonNull
                                       String member,
                                       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 Enum> E[] enumValues(@NonNull
                                       Class<? extends Annotation> annotation,
                                       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 Enum> E[] enumValues(@NonNull
                                       Class<? extends Annotation> annotation,
                                       @NonNull
                                       String member,
                                       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 Enum> E[] enumValues(@NonNull
                                       Class<? extends Annotation> annotation,
                                       @NonNull
                                       String member,
                                       Class<E> enumType,
                                       @Nullable
                                       Function<Object,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 Enum> E[] enumValues(@NonNull
                                       String annotation,
                                       @NonNull
                                       String member,
                                       Class<E> enumType,
                                       @Nullable
                                       Function<Object,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 Enum> Optional<E> enumValue(@NonNull
                                                        String annotation,
                                                        @NonNull
                                                        String member,
                                                        Class<E> enumType,
                                                        @Nullable
                                                        Function<Object,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> Class<T>[] classValues(@NonNull
                                  String annotation,
                                  @NonNull
                                  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> Class<T>[] classValues(@NonNull
                                  Class<? extends Annotation> annotation,
                                  @NonNull
                                  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 Optional<Class> classValue(@NonNull
                                           Class<? extends Annotation> annotation,
                                           @NonNull
                                           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 Optional<Class> classValue(@NonNull
                                  Class<? extends Annotation> annotation,
                                  @NonNull
                                  String member,
                                  Function<Object,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 Optional<Class> classValue(@NonNull
                                           String annotation,
                                           @NonNull
                                           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 Optional<Class> classValue(@NonNull
                                            String annotation,
                                            @NonNull
                                            String member,
                                            @Nullable
                                            Function<Object,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 OptionalInt intValue(@NonNull
                                     String annotation,
                                     @NonNull
                                     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 OptionalInt intValue(@NonNull
                                     Class<? extends Annotation> annotation,
                                     @NonNull
                                     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 OptionalInt intValue(@NonNull
                                      Class<? extends Annotation> annotation,
                                      @NonNull
                                      String member,
                                      @Nullable
                                      Function<Object,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 Optional<Boolean> booleanValue(@NonNull
                                      String annotation,
                                      @NonNull
                                      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 Optional<Boolean> booleanValue(@NonNull
                                      Class<? extends Annotation> annotation,
                                      @NonNull
                                      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 Optional<Boolean> booleanValue(@NonNull
                                      Class<? extends Annotation> annotation,
                                      @NonNull
                                      String member,
                                      Function<Object,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 Optional<Boolean> booleanValue(@NonNull
                                               String annotation,
                                               @NonNull
                                               String member,
                                               @Nullable
                                               Function<Object,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 OptionalLong longValue(@NonNull
                                       String annotation,
                                       @NonNull
                                       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 OptionalLong longValue(@NonNull
                                       Class<? extends Annotation> annotation,
                                       @NonNull
                                       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 OptionalLong longValue(@NonNull
                                        Class<? extends Annotation> annotation,
                                        @NonNull
                                        String member,
                                        @Nullable
                                        Function<Object,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 OptionalLong longValue(@NonNull
                                       String annotation,
                                       @NonNull
                                       String member,
                                       @Nullable
                                       Function<Object,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 OptionalInt intValue(@NonNull
                                     String annotation,
                                     @NonNull
                                     String member,
                                     @Nullable
                                     Function<Object,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 Optional<String> stringValue(@NonNull
                                             Class<? extends Annotation> annotation,
                                             @NonNull
                                             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 Optional<String> stringValue(@NonNull
                                    Class<? extends Annotation> annotation,
                                    @NonNull
                                    String member,
                                    Function<Object,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 String[] stringValues(@NonNull
                                      Class<? extends Annotation> annotation,
                                      @NonNull
                                      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 String[] stringValues(@NonNull
                                      String annotation,
                                      @NonNull
                                      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 String[] stringValues(@NonNull
                                      Class<? extends Annotation> annotation,
                                      @NonNull
                                      String member,
                                      Function<Object,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 String[] stringValues(@NonNull
                                      String annotation,
                                      @NonNull
                                      String member,
                                      Function<Object,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 Optional<String> stringValue(@NonNull
                                             String annotation,
                                             @NonNull
                                             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 Optional<String> stringValue(@NonNull
                                             String annotation,
                                             @NonNull
                                             String member,
                                             @Nullable
                                             Function<Object,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
                      Class<? extends Annotation> annotation,
                      @NonNull
                      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
                      Class<? extends Annotation> annotation,
                      @NonNull
                      String member,
                      Function<Object,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
                      String annotation,
                      @NonNull
                      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
                      String annotation,
                      @NonNull
                      String member,
                      @Nullable
                      Function<Object,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
                       String annotation,
                       @NonNull
                       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 OptionalDouble doubleValue(@NonNull
                                           String annotation,
                                           @NonNull
                                           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 OptionalDouble doubleValue(@NonNull
                                           Class<? extends Annotation> annotation,
                                           @NonNull
                                           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 OptionalDouble doubleValue(@NonNull
                                            Class<? extends Annotation> annotation,
                                            @NonNull
                                            String member,
                                            @Nullable
                                            Function<Object,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 OptionalDouble doubleValue(@NonNull
                                                      String annotation,
                                                      @NonNull
                                                      String member,
                                                      Function<Object,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> Optional<T> getValue(@NonNull
                                         Class<? extends Annotation> annotation,
                                         @NonNull
                                         String member,
                                         @NonNull
                                         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> Optional<T> getValue(@NonNull
                                         String annotation,
                                         @NonNull
                                         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> Optional<T> getValue(@NonNull
                                         String annotation,
                                         @NonNull
                                         String member,
                                         @NonNull
                                         Argument<T> requiredType,
                                         @Nullable
                                         Function<Object,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> Optional<T> getDefaultValue(@NonNull
                                                String annotation,
                                                @NonNull
                                                String member,
                                                @NonNull
                                                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 Annotation> List<AnnotationValue<T>> getAnnotationValuesByType(@Nullable
                                                                                          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

getAnnotationValuesByName
```
public <T extends Annotation> List<AnnotationValue<T>> getAnnotationValuesByName(String annotationType)
```
Description copied from interface: AnnotationMetadata

Gets all the annotation values by the given repeatable type name.

Specified by:

getAnnotationValuesByName in interface AnnotationMetadata

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

getDeclaredAnnotationValuesByType

@NonNull
public <T extends Annotation> List<AnnotationValue<T>> getDeclaredAnnotationValuesByType(@NonNull
                                                                                                  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

getDeclaredAnnotationValuesByName
```
public <T extends Annotation> List<AnnotationValue<T>> getDeclaredAnnotationValuesByName(String annotationType)
```
Description copied from interface: AnnotationMetadata

Gets only declared annotation values by the given repeatable type name.

Specified by:

getDeclaredAnnotationValuesByName in interface AnnotationMetadata

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

synthesizeAnnotationsByType
```
public <T extends Annotation> T[] synthesizeAnnotationsByType(@NonNull
                                                              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 Annotation> T[] synthesizeDeclaredAnnotationsByType(@NonNull
                                                                      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(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(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(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(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 Optional<Class<? extends Annotation>> getAnnotationTypeByStereotype(@Nullable
                                                                                    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 Optional<String> getAnnotationNameByStereotype(@Nullable
                                                               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 List<String> getAnnotationNamesByStereotype(@Nullable
                                                            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 Set<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

getStereotypeAnnotationNames
```
public Set<String> getStereotypeAnnotationNames()
```
Description copied from interface: AnnotationMetadata

Returns the names of the annotations which are stereotypes.
A stereotype is a meta-annotation (an annotation declared on another annotation).

Specified by:

getStereotypeAnnotationNames in interface AnnotationMetadata

Returns:

The names of the stereotype annotations

See Also:

AnnotationMetadata.getDeclaredStereotypeAnnotationNames()

getDeclaredStereotypeAnnotationNames
```
public Set<String> getDeclaredStereotypeAnnotationNames()
```
Description copied from interface: AnnotationMetadata

Returns the names of the annotations which are declared stereotypes.
A stereotype is a meta-annotation (an annotation declared on another annotation).

A stereotype is considered declared when it it is a meta-annotation that is present on an annotation directly declared on the element and not inherited from a super class.

Specified by:

getDeclaredStereotypeAnnotationNames in interface AnnotationMetadata

Returns:

The names of the stereotype annotations

See Also:

AnnotationMetadata.getStereotypeAnnotationNames(), AnnotationMetadata.getDeclaredAnnotationNames()

getDeclaredAnnotationNames
```
@NonNull
public Set<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 List<String> getDeclaredAnnotationNamesByStereotype(@Nullable
                                                                    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 Optional<Class<? extends Annotation>> getAnnotationType(@NonNull
                                                                        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 Optional<Class<? extends Annotation>> getAnnotationType(@NonNull
                                                                        String name,
                                                                        @NonNull
                                                                        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 Annotation> Optional<AnnotationValue<T>> findAnnotation(@NonNull
                                                                                   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 Annotation> Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull
                                                                                           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
                                                String annotation,
                                                @NonNull
                                                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

getValues
```
@NonNull
public Map<CharSequence,Object> getValues(@NonNull
                                                   String annotation)
```
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

Parameters:

annotation - The annotation name

Returns:

An immutable map of values

getDefaultValue

@NonNull
public <T> Optional<T> getDefaultValue(@NonNull
                                                String annotation,
                                                @NonNull
                                                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

isRepeatableAnnotation
```
public boolean isRepeatableAnnotation(Class<? extends Annotation> annotation)
```
Description copied from interface: AnnotationMetadata

Is repeatable annotation?

Specified by:

isRepeatableAnnotation in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

true if repeatable

isRepeatableAnnotation
```
public boolean isRepeatableAnnotation(String annotation)
```
Description copied from interface: AnnotationMetadata

Is repeatable annotation?

Specified by:

isRepeatableAnnotation in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

true if repeatable

findRepeatableAnnotation
```
public Optional<String> findRepeatableAnnotation(Class<? extends Annotation> annotation)
```
Description copied from interface: AnnotationMetadata

Find repeatable annotation container.

Specified by:

findRepeatableAnnotation in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

optional repeatable annotation container

findRepeatableAnnotation
```
public Optional<String> findRepeatableAnnotation(String annotation)
```
Description copied from interface: AnnotationMetadata

Find repeatable annotation container.

Specified by:

findRepeatableAnnotation in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

optional repeatable annotation container

clone

public DefaultAnnotationMetadata clone()

Overrides:: clone in class Object

addAnnotation
```
protected void addAnnotation(String annotation,
                             Map<CharSequence,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 void addAnnotation(String annotation,
                             Map<CharSequence,Object> values,
                             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(String annotation,
                                                Map<CharSequence,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(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(String annotation,
                                                        Map<String,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,
                                                        Map<String,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

registerRepeatableAnnotations
```
@Internal
public static void registerRepeatableAnnotations(Map<String,String> repeatableAnnotations)
```
Registers repeatable annotations. Annotation container -> annotations item. Used by generated byte code. DO NOT REMOVE.

Parameters:

repeatableAnnotations - The annotation

addRepeatable
```
protected void addRepeatable(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 void addRepeatable(String annotationName,
                             AnnotationValue annotationValue,
                             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(List<String> parents,
                                       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(List<String> parents,
                                               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 void addDeclaredRepeatable(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 void addDeclaredRepeatable(String annotationName,
                                     AnnotationValue annotationValue,
                                     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(List<String> parentAnnotations,
                                   String stereotype,
                                   Map<CharSequence,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(List<String> parentAnnotations,
                                   String stereotype,
                                   Map<CharSequence,Object> values,
                                   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 void addDeclaredStereotype(List<String> parentAnnotations,
                                     String stereotype,
                                     Map<CharSequence,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 void addDeclaredStereotype(List<String> parentAnnotations,
                                     String stereotype,
                                     Map<CharSequence,Object> values,
                                     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(String annotation,
                                     Map<CharSequence,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(String annotation,
                                     Map<CharSequence,Object> values,
                                     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,
                                                        String annotationName,
                                                        String member,
                                                        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

contributeRepeatable

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

Contributes repeatable annotation metadata to the given target.

WARNING: for internal use only be the framework

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

contributeRepeatable

@Internal
public static void contributeRepeatable(AnnotationMetadata target,
                                                  ClassElement classElement)

Contributes repeatable annotation metadata to the given class element.

WARNING: for internal use only be the framework

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

mutateMember

@Internal
public static AnnotationMetadata mutateMember(AnnotationMetadata annotationMetadata,
                                                        String annotationName,
                                                        Map<CharSequence,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

removeAnnotationIf

protected <A extends Annotation> void removeAnnotationIf(@NonNull
                                                         Predicate<AnnotationValue<A>> predicate)

Removes an annotation for the given predicate.

Type Parameters:: A - The annotation
Parameters:: predicate - The predicate

removeAnnotation
```
protected void removeAnnotation(String annotationType)
```
Removes an annotation for the given annotation type.

Parameters:

annotationType - The annotation type

Since:

3.0.0

removeStereotype
```
protected void removeStereotype(String annotationType)
```
Removes a stereotype annotation for the given annotation type.

Parameters:

annotationType - The annotation type

Since:

3.0.0

synthesize
```
@Nullable
public <T extends Annotation> T synthesize(@NonNull
                                                     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

synthesize
```
@Nullable
public <T extends Annotation> T synthesize(@NonNull
                                                     Class<T> annotationClass,
                                                     @NonNull
                                                     String sourceAnnotation)
```
Description copied from interface: AnnotationSource

Synthesizes a new annotation for the given annotation type using the member values of the given source annotation.
This method allows supporting synthesizing annotations that have been renamed, for example a jakarta.inject.Named annotation an be synthesized from the metadata of the a javax.inject.Named annotation.

Specified by:

synthesize in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

sourceAnnotation - The source annotation that provides the member values

Returns:

The annotation or null if it doesn't exist

synthesizeDeclared
```
@Nullable
public <T extends Annotation> T synthesizeDeclared(@NonNull
                                                             Class<T> annotationClass,
                                                             @NonNull
                                                             String sourceAnnotation)
```
Description copied from interface: AnnotationSource

Synthesizes a new annotation declared for the given annotation type using the member values of the given source annotation.
This method allows supporting synthesizing annotations that have been renamed, for example a jakarta.inject.Named annotation an be synthesized from the metadata of the a javax.inject.Named annotation.

Specified by:

synthesizeDeclared in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

sourceAnnotation - The source annotation that provides the member values

Returns:

The annotation or null if it doesn't exist

synthesizeDeclared
```
@Nullable
public <T extends Annotation> T synthesizeDeclared(@NonNull
                                                             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 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 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(List results,
                                                 Map<CharSequence,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(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

DefaultAnnotationMetadata

DefaultAnnotationMetadata

Method Detail

getDeclaredMetadata

hasPropertyExpressions

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

stringValues

stringValues

stringValue

stringValue

isTrue

isTrue

isTrue

isTrue

isFalse

doubleValue

doubleValue

doubleValue

doubleValue

getValue

getValue

getValue

getDefaultValue

getAnnotationValuesByType

getAnnotationValuesByName

getDeclaredAnnotationValuesByType

getDeclaredAnnotationValuesByName

synthesizeAnnotationsByType

synthesizeDeclaredAnnotationsByType

isEmpty