io.micronaut.inject.annotation

Class MutableAnnotationMetadata

java.lang.Object

io.micronaut.inject.annotation.DefaultAnnotationMetadata

io.micronaut.inject.annotation.MutableAnnotationMetadata

All Implemented Interfaces:

AnnotationMetadata, AnnotationSource, Cloneable

public class MutableAnnotationMetadata
extends DefaultAnnotationMetadata

A mutable various of DefaultAnnotationMetadata that is used only at build time.

Since:

2.4.0

Author:

graemerocher

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

Constructor Summary

Constructors

Constructor and Description
MutableAnnotationMetadata() Default constructor.

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
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.
void	addDeclaredRepeatable(String annotationName, AnnotationValue annotationValue) Adds a repeatable annotation value.
void	addDeclaredRepeatable(String annotationName, AnnotationValue annotationValue, RetentionPolicy retentionPolicy) Adds a repeatable annotation value.
void	addDeclaredRepeatableStereotype(List<String> parents, String stereotype, AnnotationValue annotationValue) Adds a repeatable declared stereotype value.
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.
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.
void	addRepeatable(String annotationName, AnnotationValue annotationValue) Adds a repeatable annotation value.
void	addRepeatable(String annotationName, AnnotationValue annotationValue, RetentionPolicy retentionPolicy) Adds a repeatable annotation value.
void	addRepeatableStereotype(List<String> parents, String stereotype, AnnotationValue annotationValue) Adds a repeatable stereotype value.
protected void	addValuesToResults(List<AnnotationValue> results, AnnotationValue values) Adds a values instance to the results.
MutableAnnotationMetadata	clone()
Map<String,Object>	getDefaultValues(String annotation) Return the default values for the given annotation name.
boolean	hasPropertyExpressions() Does the metadata contain any property expressions like ${foo.bar}.
void	removeAnnotation(String annotationType) Removes an annotation for the given annotation type.
<A extends Annotation> void	removeAnnotationIf(Predicate<AnnotationValue<A>> predicate) Removes an annotation for the given predicate.
void	removeStereotype(String annotationType) Removes a stereotype annotation for the given annotation type.
<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.
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.

Methods inherited from class io.micronaut.inject.annotation.DefaultAnnotationMetadata

addDefaultAnnotationValues, addStereotype, addStereotype, areAnnotationDefaultsRegistered, booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, cloneMap, cloneMapOfListValue, cloneMapOfMapValue, contributeDefaults, contributeRepeatable, contributeRepeatable, doubleValue, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, enumValues, enumValues, findAnnotation, findDeclaredAnnotation, findRepeatableAnnotation, findRepeatableAnnotation, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationValuesByName, getAnnotationValuesByStereotype, getAnnotationValuesByType, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationValuesByName, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getStereotypeAnnotationNames, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasStereotype, intValue, intValue, intValue, intValue, isEmpty, isFalse, isPresent, isRepeatableAnnotation, isRepeatableAnnotation, isTrue, isTrue, isTrue, isTrue, longValue, longValue, longValue, longValue, mutateMember, mutateMember, registerAnnotationDefaults, registerAnnotationDefaults, registerAnnotationType, registerRepeatableAnnotations, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, stringValues, stringValues, synthesizeAnnotationsByType, synthesizeDeclaredAnnotationsByType

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

MutableAnnotationMetadata

public MutableAnnotationMetadata()

Default constructor.

Method Detail

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

Overrides:

hasPropertyExpressions in class DefaultAnnotationMetadata

Returns:

True if property expressions are present

clone

public MutableAnnotationMetadata clone()

Overrides:

clone in class DefaultAnnotationMetadata

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

Overrides:

getDefaultValues in class DefaultAnnotationMetadata

Parameters:

annotation - The annotation name

Returns:

The default values

removeAnnotationIf

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

Description copied from class: DefaultAnnotationMetadata

Removes an annotation for the given predicate.

Overrides:

removeAnnotationIf in class DefaultAnnotationMetadata

Type Parameters:

A - The annotation

Parameters:

predicate - The predicate

removeAnnotation

public void removeAnnotation(String annotationType)

Description copied from class: DefaultAnnotationMetadata

Removes an annotation for the given annotation type.

Overrides:

removeAnnotation in class DefaultAnnotationMetadata

Parameters:

annotationType - The annotation type

removeStereotype

public void removeStereotype(String annotationType)

Description copied from class: DefaultAnnotationMetadata

Removes a stereotype annotation for the given annotation type.

Overrides:

removeStereotype in class DefaultAnnotationMetadata

Parameters:

annotationType - The annotation type

addAnnotation

public void addAnnotation(String annotation,
                          Map<CharSequence,Object> values)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addAnnotation in class DefaultAnnotationMetadata

Parameters:

annotation - The annotation

values - The values

addAnnotation

public void addAnnotation(String annotation,
                          Map<CharSequence,Object> values,
                          RetentionPolicy retentionPolicy)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addAnnotation in class DefaultAnnotationMetadata

Parameters:

annotation - The annotation

values - The values

retentionPolicy - The retention policy

addRepeatableStereotype

public void addRepeatableStereotype(List<String> parents,
                                    String stereotype,
                                    AnnotationValue annotationValue)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addRepeatableStereotype in class DefaultAnnotationMetadata

Parameters:

parents - The parent annotations

stereotype - The annotation name

annotationValue - The annotation value

addDeclaredRepeatableStereotype

public void addDeclaredRepeatableStereotype(List<String> parents,
                                            String stereotype,
                                            AnnotationValue annotationValue)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addDeclaredRepeatableStereotype in class DefaultAnnotationMetadata

Parameters:

parents - The parent annotations

stereotype - The annotation name

annotationValue - The annotation value

addDeclaredAnnotation

public void addDeclaredAnnotation(String annotation,
                                  Map<CharSequence,Object> values)

Description copied from class: DefaultAnnotationMetadata

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.

Overrides:

addDeclaredAnnotation in class DefaultAnnotationMetadata

Parameters:

annotation - The annotation

values - The values

addDeclaredAnnotation

public void addDeclaredAnnotation(String annotation,
                                  Map<CharSequence,Object> values,
                                  RetentionPolicy retentionPolicy)

Description copied from class: DefaultAnnotationMetadata

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.

Overrides:

addDeclaredAnnotation in class DefaultAnnotationMetadata

Parameters:

annotation - The annotation

values - The values

retentionPolicy - The retention policy

addRepeatable

public void addRepeatable(String annotationName,
                          AnnotationValue annotationValue)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addRepeatable in class DefaultAnnotationMetadata

Parameters:

annotationName - The annotation name

annotationValue - The annotation value

addRepeatable

public void addRepeatable(String annotationName,
                          AnnotationValue annotationValue,
                          RetentionPolicy retentionPolicy)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addRepeatable in class DefaultAnnotationMetadata

Parameters:

annotationName - The annotation name

annotationValue - The annotation value

retentionPolicy - The retention policy

addDeclaredRepeatable

public void addDeclaredRepeatable(String annotationName,
                                  AnnotationValue annotationValue)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addDeclaredRepeatable in class DefaultAnnotationMetadata

Parameters:

annotationName - The annotation name

annotationValue - The annotation value

addDeclaredRepeatable

public void addDeclaredRepeatable(String annotationName,
                                  AnnotationValue annotationValue,
                                  RetentionPolicy retentionPolicy)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addDeclaredRepeatable in class DefaultAnnotationMetadata

Parameters:

annotationName - The annotation name

annotationValue - The annotation value

retentionPolicy - The retention policy

addDeclaredStereotype

public void addDeclaredStereotype(List<String> parentAnnotations,
                                  String stereotype,
                                  Map<CharSequence,Object> values)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addDeclaredStereotype in class DefaultAnnotationMetadata

Parameters:

parentAnnotations - The parent annotations

stereotype - The annotation

values - The values

addDeclaredStereotype

public void addDeclaredStereotype(List<String> parentAnnotations,
                                  String stereotype,
                                  Map<CharSequence,Object> values,
                                  RetentionPolicy retentionPolicy)

Description copied from class: DefaultAnnotationMetadata

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

Overrides:

addDeclaredStereotype in class DefaultAnnotationMetadata

Parameters:

parentAnnotations - The parent annotations

stereotype - The annotation

values - The values

retentionPolicy - The retention policy

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