io.micronaut.inject.annotation

Class DefaultAnnotationMetadata

java.lang.Object

io.micronaut.inject.annotation.DefaultAnnotationMetadata

All Implemented Interfaces:

AnnotationMetadata, AnnotationSource, Cloneable

@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

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.

Method Summary

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	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	addDeclaredRepeatable(String annotationName, AnnotationValue annotationValue) 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	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	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	addValuesToResults(List<AnnotationValue> results, AnnotationValue values) Adds a values instance to the results.
protected static boolean	areAnnotationDefaultsRegistered(String annotation) Returns whether annotation defaults are registered for the give annotation.
AnnotationMetadata	clone()
<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.
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.
<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>>	getDeclaredAnnotationValuesByType(Class<T> annotationType) Gets only declared annotation values by the given repeatable type.
<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.
<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> 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	hasStereotype(String annotation) Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
boolean	isEmpty() Is the annotation metadata empty.
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.
protected static void	registerAnnotationDefaults(AnnotationClassValue<?> annotation, Map<String,Object> defaultValues) Registers annotation default values.
protected static void	registerAnnotationDefaults(String annotation, Map<String,Object> defaultValues) Registers annotation default values.
<T extends Annotation> T	synthesize(Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.
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[]	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

classValue, classValue, classValue, classValue, doubleValue, findAnnotation, findDeclaredAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNamesByStereotype, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDefaultValue, getDefaultValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, hasAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isFalse, isFalse, isPresent, isPresent, isTrue, isTrue, longValue

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

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, synthesize, synthesizeAll, 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

Method Detail

getValue

public <T> Optional<T> getValue(Class<? extends Annotation> annotation,
                                String member,
                                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

public <T> Optional<T> getValue(String annotation,
                                String member,
                                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

getDefaultValue

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

public <T extends Annotation> List<AnnotationValue<T>> getAnnotationValuesByType(Class<T> annotationType)

Description copied from interface: AnnotationMetadata

Gets all the annotation values by the given repeatable type.

Specified by:

getAnnotationValuesByType in interface AnnotationMetadata

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

getDeclaredAnnotationValuesByType

public <T extends Annotation> List<AnnotationValue<T>> getDeclaredAnnotationValuesByType(Class<T> annotationType)

Description copied from interface: AnnotationMetadata

Gets only declared annotation values by the given repeatable type.

Specified by:

getDeclaredAnnotationValuesByType in interface AnnotationMetadata

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

synthesizeAnnotationsByType

public <T extends Annotation> T[] synthesizeAnnotationsByType(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(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

getAnnotationNamesByStereotype

public List<String> getAnnotationNamesByStereotype(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

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

getDeclaredAnnotationNames

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

public List<String> getDeclaredAnnotationNamesByStereotype(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

public Optional<Class<? extends Annotation>> getAnnotationType(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

findAnnotation

public <T extends Annotation> Optional<AnnotationValue<T>> findAnnotation(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

public <T extends Annotation> Optional<AnnotationValue<T>> findDeclaredAnnotation(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

public <T> OptionalValues<T> getValues(String annotation,
                                       Class<T> valueType)

Description copied from interface: AnnotationMetadata

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

Specified by:

getValues in interface AnnotationMetadata

Type Parameters:

T - Generic type

Parameters:

annotation - The annotation name

valueType - valueType

Returns:

The OptionalValues

getDefaultValue

public <T> Optional<T> getDefaultValue(String annotation,
                                       String member,
                                       Argument<T> requiredType)

Description copied from interface: AnnotationMetadata

Return the default value for the given annotation member.

Specified by:

getDefaultValue in interface AnnotationMetadata

Type Parameters:

T - The required generic type

Parameters:

annotation - The annotation

member - The member

requiredType - The required type

Returns:

An optional value

clone

public AnnotationMetadata clone()

Overrides:

clone in class Object

addAnnotation

protected final 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

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
protected 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
protected 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
protected 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

addRepeatable

protected final 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

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 final 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

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

addDeclaredStereotype

protected final 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

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

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

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

synthesize

public <T extends Annotation> T synthesize(Class<T> annotationClass)

Description copied from interface: AnnotationSource

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

Specified by:

synthesize in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

Returns:

The annotation or null if it doesn't exist

synthesizeDeclared

public <T extends Annotation> T synthesizeDeclared(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

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

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