io.micronaut.inject.annotation

Class AnnotationMetadataHierarchy

java.lang.Object

io.micronaut.inject.annotation.AnnotationMetadataHierarchy

All Implemented Interfaces:

AnnotationMetadata, AnnotationSource, java.lang.Iterable<AnnotationMetadata>

public final class AnnotationMetadataHierarchy
extends java.lang.Object
implements AnnotationMetadata, java.lang.Iterable<AnnotationMetadata>

Used to represent an annotation metadata hierarchy. The first AnnotationMetadata instance passed to the constructor represents the annotation metadata that is declared, hence methods like hasDeclaredAnnotation(String) will return true for the last annotation metadata passed in the hierarchy.

This class is used to internally optimize memory usage and compilation time for classes that declare AOP advice at the type level and where the classes methods typically don't include any annotations and therefore would be wasteful to generate additional annotation metadata classes.

Since:

1.3.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static AnnotationMetadata[]	EMPTY_HIERARCHY Constant to represent an empty hierarchy.

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
AnnotationMetadataHierarchy(AnnotationMetadata... hierarchy) Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.Boolean>	booleanValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the boolean value and optionally map its value.
java.util.Optional<java.lang.Boolean>	booleanValue(java.lang.String annotation, java.lang.String member) The value as an optional boolean for the given annotation and member.
java.util.Optional<java.lang.Boolean>	booleanValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the boolean value and optionally map its value.
java.util.Optional<java.lang.Class>	classValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the class value and optionally map its value.
java.util.Optional<java.lang.Class>	classValue(java.lang.String annotation, java.lang.String member) The value of the annotation as a Class.
java.util.Optional<java.lang.Class>	classValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the class value and optionally map its value.
<T> java.lang.Class<T>[]	classValues(java.lang.String annotation, java.lang.String member) The value of the annotation as a Class.
AnnotationMetadata	createSibling(AnnotationMetadata child) Create a new hierarchy instance from this metadata using this metadata's parents.
java.util.OptionalDouble	doubleValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The value as an OptionalDouble for the given annotation and member.
java.util.OptionalDouble	doubleValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the double value and optionally map its value.
java.util.OptionalDouble	doubleValue(java.lang.String annotation, java.lang.String member) The value as an OptionalDouble for the given annotation and member.
java.util.OptionalDouble	doubleValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the double value and optionally map its value.
<E extends java.lang.Enum> java.util.Optional<E>	enumValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType) The value of the annotation as a Class.
<E extends java.lang.Enum> java.util.Optional<E>	enumValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the enum value and optionally map its value.
<E extends java.lang.Enum> java.util.Optional<E>	enumValue(java.lang.String annotation, java.lang.String member, java.lang.Class<E> enumType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the enum value and optionally map its value.
<E extends java.lang.Enum> E[]	enumValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.lang.Class<E> enumType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the enum values and optionally map its value.
<E extends java.lang.Enum> E[]	enumValues(java.lang.String annotation, java.lang.String member, java.lang.Class<E> enumType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the enum values and optionally map its value.
<T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>	findAnnotation(java.lang.String annotation) Find an AnnotationValue for the given annotation name.
<T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>>	findDeclaredAnnotation(java.lang.String annotation) Get all of the values for the given annotation that are directly declared on the annotated element.
java.util.Set<java.lang.String>	getAnnotationNames() All the annotation names this metadata declares.
java.util.List<java.lang.String>	getAnnotationNamesByStereotype(java.lang.String stereotype) Resolve all of the annotation names that feature the given stereotype.
java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>	getAnnotationType(java.lang.String name) Gets the type for a given annotation if it is present on the classpath.
java.util.Optional<java.lang.Class<? extends java.lang.annotation.Annotation>>	getAnnotationType(java.lang.String name, java.lang.ClassLoader classLoader) Gets the type for a given annotation if it is present on the classpath.
<T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>>	getAnnotationValuesByType(java.lang.Class<T> annotationType) Gets all the annotation values by the given repeatable type.
java.util.Set<java.lang.String>	getDeclaredAnnotationNames() All the declared annotation names this metadata declares.
<T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>>	getDeclaredAnnotationValuesByType(java.lang.Class<T> annotationType) Gets only declared annotation values by the given repeatable type.
AnnotationMetadata	getDeclaredMetadata()
<T> java.util.Optional<T>	getDefaultValue(java.lang.String annotation, java.lang.String member, Argument<T> requiredType) Return the default value for the given annotation member.
java.util.Map<java.lang.String,java.lang.Object>	getDefaultValues(java.lang.String annotation) Return the default values for the given annotation name.
AnnotationMetadata	getRootMetadata()
<T> java.util.Optional<T>	getValue(java.lang.String annotation, java.lang.String member, Argument<T> requiredType, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Resolves the given value performing type conversion as necessary.
<T> OptionalValues<T>	getValues(java.lang.String annotation, java.lang.Class<T> valueType) Get all of the values for the given annotation and type of the underlying values.
boolean	hasAnnotation(java.lang.String annotation) Checks whether this object has the given annotation on the object itself or inherited from a parent.
boolean	hasDeclaredAnnotation(java.lang.String annotation) Checks whether this object has the given annotation directly declared on the object.
boolean	hasDeclaredStereotype(java.lang.String annotation) Checks whether this object has the given annotation stereotype on the object itself and not inherited from a parent
boolean	hasStereotype(java.lang.String annotation) Checks whether this object has the given annotation stereotype on the object itself or inherited from a parent
java.util.OptionalInt	intValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the int value and optionally map its value.
java.util.OptionalInt	intValue(java.lang.String annotation, java.lang.String member) The value as an OptionalInt for the given annotation and member.
java.util.OptionalInt	intValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the int value and optionally map its value.
boolean	isTrue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the boolean value and optionally map its value.
boolean	isTrue(java.lang.String annotation, java.lang.String member) Returns whether the value of the given member is true.
boolean	isTrue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the boolean value and optionally map its value.
java.util.Iterator<AnnotationMetadata>	iterator()
java.util.OptionalLong	longValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the long value and optionally map its value.
java.util.OptionalLong	longValue(java.lang.String annotation, java.lang.String member) The value as an OptionalLong for the given annotation and member.
java.util.OptionalLong	longValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the long value and optionally map its value.
java.util.Optional<java.lang.String>	stringValue(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the string value and optionally map its value.
java.util.Optional<java.lang.String>	stringValue(java.lang.String annotation, java.lang.String member) The value as an optional string for the given annotation and member.
java.util.Optional<java.lang.String>	stringValue(java.lang.String annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the string value and optionally map its value.
java.lang.String[]	stringValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member) The values as string array for the given annotation and member.
java.lang.String[]	stringValues(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, java.lang.String member, java.util.function.Function<java.lang.Object,java.lang.Object> valueMapper) Retrieve the string value and optionally map its value.
<T extends java.lang.annotation.Annotation> T	synthesize(java.lang.Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.
<T extends java.lang.annotation.Annotation> T	synthesizeDeclared(java.lang.Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValues, classValues, classValues, doubleValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, findAnnotation, findDeclaredAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNamesByStereotype, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDefaultValue, getDefaultValue, getDefaultValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, hasAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isTrue, longValue, stringValue, stringValue, stringValue, stringValues

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

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY_HIERARCHY

public static final AnnotationMetadata[] EMPTY_HIERARCHY

Constant to represent an empty hierarchy.

Constructor Detail

AnnotationMetadataHierarchy

public AnnotationMetadataHierarchy(AnnotationMetadata... hierarchy)

Default constructor.

Parameters:

hierarchy - The annotation hierarchy

Method Detail

getAnnotationType

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

Description copied from interface: AnnotationMetadata

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

Specified by:

getAnnotationType in interface AnnotationMetadata

Parameters:

name - The type name

Returns:

The type if present

getAnnotationType

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

Description copied from interface: AnnotationMetadata

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

Specified by:

getAnnotationType in interface AnnotationMetadata

Parameters:

name - The type name

classLoader - The ClassLoader to load the type

Returns:

The type if present

getDeclaredMetadata

@NonNull
public AnnotationMetadata getDeclaredMetadata()

Returns:

The metadata that is actually declared in the element

getRootMetadata

@NonNull
public AnnotationMetadata getRootMetadata()

Returns:

The metadata that is actually declared in the element

createSibling

@NonNull
public AnnotationMetadata createSibling(@NonNull
                                                 AnnotationMetadata child)

Create a new hierarchy instance from this metadata using this metadata's parents.

Parameters:

child - The child annotation metadata

Returns:

A new sibling

synthesize

@Nullable
public <T extends java.lang.annotation.Annotation> T synthesize(@NonNull
                                                                          java.lang.Class<T> annotationClass)

Description copied from interface: AnnotationSource

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

Specified by:

synthesize in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

Returns:

The annotation or null if it doesn't exist

synthesizeDeclared

@Nullable
public <T extends java.lang.annotation.Annotation> T synthesizeDeclared(@NonNull
                                                                                  java.lang.Class<T> annotationClass)

Description copied from interface: AnnotationSource

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

This method ignores inherited annotations. (Returns null if no annotations are directly present on this element.)

Specified by:

synthesizeDeclared in interface AnnotationSource

Type Parameters:

T - The annotation generic type

Parameters:

annotationClass - The annotation class

Returns:

The annotation or null if it doesn't exist

findAnnotation

@NonNull
public <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findAnnotation(@NonNull
                                                                                                                  java.lang.String annotation)

Description copied from interface: AnnotationSource

Find an AnnotationValue for the given annotation name.

Specified by:

findAnnotation in interface AnnotationSource

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

findDeclaredAnnotation

@NonNull
public <T extends java.lang.annotation.Annotation> java.util.Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull
                                                                                                                          java.lang.String annotation)

Description copied from interface: AnnotationSource

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

Specified by:

findDeclaredAnnotation in interface AnnotationSource

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

A AnnotationValue instance

doubleValue

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

Description copied from interface: AnnotationMetadata

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

Specified by:

doubleValue in interface AnnotationMetadata

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalDouble value

stringValues

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

Description copied from interface: AnnotationMetadata

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

Specified by:

stringValues in interface AnnotationMetadata

Parameters:

annotation - The annotation

member - The member

Returns:

The string values if it is present

booleanValue

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

Description copied from interface: AnnotationMetadata

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

Specified by:

booleanValue in interface AnnotationMetadata

Parameters:

annotation - The annotation

member - The member

Returns:

The string value if it is present

isTrue

public boolean isTrue(@NonNull
                      java.lang.String annotation,
                      @NonNull
                      java.lang.String member)

Description copied from interface: AnnotationMetadata

Returns whether the value of the given member is true.

Specified by:

isTrue in interface AnnotationMetadata

Parameters:

annotation - The annotation class

member - The annotation member

Returns:

True if the value is true

longValue

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

Description copied from interface: AnnotationMetadata

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

Specified by:

longValue in interface AnnotationMetadata

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalLong value

stringValue

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

Description copied from interface: AnnotationMetadata

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

Specified by:

stringValue in interface AnnotationMetadata

Parameters:

annotation - The annotation

member - The member

Returns:

The string value if it is present

intValue

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

Description copied from interface: AnnotationMetadata

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

Specified by:

intValue in interface AnnotationMetadata

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalInt value

doubleValue

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

Description copied from interface: AnnotationMetadata

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

Specified by:

doubleValue in interface AnnotationMetadata

Parameters:

annotation - The annotation

member - The member

Returns:

THe OptionalDouble value

enumValue

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

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:

enumValue in interface AnnotationMetadata

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

member - The annotation member

enumType - The enum type

Returns:

An Optional class

classValues

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

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:

classValues in interface AnnotationMetadata

Type Parameters:

T - The type of the class

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

classValue

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

Description copied from interface: AnnotationMetadata

The value of the annotation as a Class.

Specified by:

classValue in interface AnnotationMetadata

Parameters:

annotation - The annotation

member - The annotation member

Returns:

An Optional class

getAnnotationNamesByStereotype

@NonNull
public java.util.List<java.lang.String> getAnnotationNamesByStereotype(@Nullable
                                                                                java.lang.String stereotype)

Description copied from interface: AnnotationMetadata

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

Specified by:

getAnnotationNamesByStereotype in interface AnnotationMetadata

Parameters:

stereotype - The annotation names

Returns:

A set of annotation names

getDeclaredAnnotationNames

@NonNull
public java.util.Set<java.lang.String> getDeclaredAnnotationNames()

Description copied from interface: AnnotationMetadata

All the declared annotation names this metadata declares.

Specified by:

getDeclaredAnnotationNames in interface AnnotationMetadata

Returns:

All the declared annotation names this metadata declares

getAnnotationNames

@NonNull
public java.util.Set<java.lang.String> getAnnotationNames()

Description copied from interface: AnnotationMetadata

All the annotation names this metadata declares.

Specified by:

getAnnotationNames in interface AnnotationMetadata

Returns:

All the annotation names this metadata declares

getValues

@NonNull
public <T> OptionalValues<T> getValues(@NonNull
                                                java.lang.String annotation,
                                                @NonNull
                                                java.lang.Class<T> valueType)

Description copied from interface: AnnotationMetadata

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

Specified by:

getValues in interface AnnotationMetadata

Type Parameters:

T - Generic type

Parameters:

annotation - The annotation name

valueType - valueType

Returns:

The OptionalValues

getDefaultValue

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

Description copied from interface: AnnotationMetadata

Return the default value for the given annotation member.

Specified by:

getDefaultValue in interface AnnotationMetadata

Type Parameters:

T - The required generic type

Parameters:

annotation - The annotation

member - The member

requiredType - The required type

Returns:

An optional value

getAnnotationValuesByType

@NonNull
public <T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>> getAnnotationValuesByType(@NonNull
                                                                                                                         java.lang.Class<T> annotationType)

Description copied from interface: AnnotationMetadata

Gets all the annotation values by the given repeatable type.

Specified by:

getAnnotationValuesByType in interface AnnotationMetadata

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

getDeclaredAnnotationValuesByType

@NonNull
public <T extends java.lang.annotation.Annotation> java.util.List<AnnotationValue<T>> getDeclaredAnnotationValuesByType(@NonNull
                                                                                                                                 java.lang.Class<T> annotationType)

Description copied from interface: AnnotationMetadata

Gets only declared annotation values by the given repeatable type.

Specified by:

getDeclaredAnnotationValuesByType in interface AnnotationMetadata

Type Parameters:

T - The annotation type

Parameters:

annotationType - The annotation type

Returns:

A list of values

hasDeclaredAnnotation

public boolean hasDeclaredAnnotation(@Nullable
                                     java.lang.String annotation)

Description copied from interface: AnnotationMetadata

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

Specified by:

hasDeclaredAnnotation in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasAnnotation

public boolean hasAnnotation(@Nullable
                             java.lang.String annotation)

Description copied from interface: AnnotationMetadata

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

Specified by:

hasAnnotation in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasStereotype

public boolean hasStereotype(@Nullable
                             java.lang.String annotation)

Description copied from interface: AnnotationMetadata

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

.

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

Specified by:

hasStereotype in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

hasDeclaredStereotype

public boolean hasDeclaredStereotype(@Nullable
                                     java.lang.String annotation)

Description copied from interface: AnnotationMetadata

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

.

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

Specified by:

hasDeclaredStereotype in interface AnnotationMetadata

Parameters:

annotation - The annotation

Returns:

True if the annotation is present

getDefaultValues

@NonNull
public java.util.Map<java.lang.String,java.lang.Object> getDefaultValues(@NonNull
                                                                                  java.lang.String annotation)

Description copied from interface: AnnotationMetadata

Return the default values for the given annotation name.

Specified by:

getDefaultValues in interface AnnotationMetadata

Parameters:

annotation - The annotation name

Returns:

The default values

enumValue

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

Retrieve the enum 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 enum value

enumValue

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

Retrieve the enum 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 enum value

enumValues

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

Retrieve the enum values and optionally map its value.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

member - The member

enumType - The enum type

valueMapper - The value mapper

Returns:

The enum value

enumValues

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

Retrieve the enum values and optionally map its value.

Type Parameters:

E - The enum type

Parameters:

annotation - The annotation

member - The member

enumType - The enum type

valueMapper - The value mapper

Returns:

The enum value

classValue

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

Retrieve the class value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The class value

classValue

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

Retrieve the class value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The class value

intValue

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

Retrieve the int value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The int value

booleanValue

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

Retrieve the boolean value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The boolean value

booleanValue

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

Retrieve the boolean value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The boolean value

longValue

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

Retrieve the long value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The long value

longValue

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

Retrieve the long value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The long value

intValue

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

Retrieve the int value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The int value

stringValue

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

Retrieve the string value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The int value

stringValues

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

Retrieve the string value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The int value

stringValue

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

Retrieve the string value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The string value

isTrue

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

Retrieve the boolean value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The boolean value

isTrue

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

Retrieve the boolean value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The boolean value

doubleValue

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

Retrieve the double value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The double value

doubleValue

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

Retrieve the double value and optionally map its value.

Parameters:

annotation - The annotation

member - The member

valueMapper - The value mapper

Returns:

The double value

getValue

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

Resolves the given value performing type conversion as necessary.

Type Parameters:

T - The generic type

Parameters:

annotation - The annotation

member - The member

requiredType - The required type

valueMapper - The value mapper

Returns:

The resolved value

iterator

@NotNull
public java.util.Iterator<AnnotationMetadata> iterator()

Specified by:

iterator in interface java.lang.Iterable<AnnotationMetadata>