Interface AnnotationMetadataDelegate
- All Superinterfaces:
AnnotationMetadata,AnnotationMetadataProvider,AnnotationSource
- All Known Subinterfaces:
AbstractAnnotationMetadataBuilder.CachedAnnotationMetadata,AnnotationElement,ArrayableClassElement,BeanConstructorElement,BeanDefinition<T>,BeanDefinitionMethodReference<T,,R> BeanDefinitionReference<T>,BeanElement,BeanElementBuilder,BeanFieldElement,BeanIntrospection<T>,BeanMethodElement,BeanParameterElement,BeanProperty<B,,T> BeanReadProperty<B,,T> BeanWriteProperty<B,,T> ClassElement,ConfigurableElement,ConstructorElement,ConstructorInvocationContext<T>,DelegatingBeanDefinition<T>,DelegatingExecutableMethod<T,,R> DisposableBeanDefinition<T>,Element,ElementAnnotationMetadata,ElementMutableAnnotationMetadataDelegate<R>,EnumBeanIntrospection<E>,EnumBeanIntrospection.EnumConstant<E>,EnumConstantElement,EnumElement,ExecutableMethod<T,,R> ExecutionHandle<T,,R> FieldElement,GenericElement,GenericPlaceholderElement,InitializingBeanDefinition<T>,InjectableBeanDefinition<T>,InjectableElement,InstantiatableBeanDefinition<T>,InvocationContext<T,,R> KotlinParameterElement,MemberElement,MethodBasedRouteMatch<T,,R> MethodElement,MethodExecutionHandle<T,,R> MethodInvocationContext<T,,R> MethodReference<T,,R> MutableAnnotationMetadataDelegate<R>,PackageElement,ParameterElement,ParametrizedInstantiatableBeanDefinition<T>,PropertyElement,ProxyBeanDefinition<T>,QualifiedBeanType<T>,RuntimeBeanDefinition<T>,TypedElement,UnsafeBeanInstantiationIntrospection<T>,UnsafeBeanProperty<B,,T> UnsafeBeanReadProperty<B,,T> UnsafeBeanWriteProperty<B,,T> UnsafeExecutionHandle<T,,R> UriRouteMatch<T,,R> ValidatedBeanDefinition<T>,WildcardElement
- All Known Implementing Classes:
AbstractAnnotationElement,AbstractBeanDefinitionBuilder,AbstractBeanProperty,AbstractElementAnnotationMetadata,AbstractElementAnnotationMetadataFactory.AbstractElementAnnotationMetadata,AbstractElementAnnotationMetadataFactory.MutableElementAnnotationMetadata,AbstractEnumBeanIntrospectionAndReference,AbstractEnumBeanIntrospectionAndReference.EnumConstantDynamicRef,AbstractEnumBeanIntrospectionAndReference.EnumConstantRef,AbstractExecutableBeanMethod,AbstractExecutableMethod,AbstractGroovyElement,AbstractInitializableBeanDefinition,AbstractInitializableBeanDefinitionAndReference,AbstractInitializableBeanDefinitionReference,AbstractInitializableBeanIntrospection,AbstractInitializableBeanIntrospectionAndReference,AbstractJavaElement,AbstractMutableAnnotationMetadata,AbstractProviderDefinition,AnnotationMetadataReference,ApplicationEventPublisherFactory,BeanDefinitionWriter,BeanProviderDefinition,ConstructorInterceptorChain,DefaultUriRouteMatch,DisabledBean,EvaluatedAnnotationMetadata,GenericPlaceholderElementAnnotationMetadata,GroovyClassElement,GroovyConstructorElement,GroovyEnumConstantElement,GroovyFieldElement,GroovyMethodElement,GroovyPackageElement,GroovyParameterElement,InterceptorChain,InterceptorRegistryBean,JakartaProviderBeanDefinition,JavaClassElement,JavaMethodElement,JavaPackageElement,JavaxProviderBeanDefinition,MappingAnnotationMetadataDelegate,MethodElementAnnotationMetadata,MethodInterceptorChain,MutatedMethodElementAnnotationMetadata,PrimitiveElement,PropertyElementAnnotationMetadata,WildcardElementAnnotationMetadata
AnnotationMetadata
to the AnnotationMetadataProvider.getAnnotationMetadata() method.- Since:
- 1.0
- Author:
- Graeme Rocher
-
Field Summary
Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadata
CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBERFields inherited from interface io.micronaut.core.annotation.AnnotationSource
EMPTY -
Method Summary
Modifier and TypeMethodDescriptionbooleanValue(@NonNull Class<? extends Annotation> annotation) The value as an optional boolean for the given annotation and member.booleanValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member) The value as an optional boolean for the given annotation and member.booleanValue(@NonNull String annotation) The value as an optional boolean for the given annotation and member.booleanValue(@NonNull String annotation, @NonNull String member) The value as an optional boolean for the given annotation and member.classValue(@NonNull Class<? extends Annotation> annotation) The value of the annotation as a Class.classValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member) The value of the annotation as a Class.classValue(@NonNull String annotation) The value of the annotation as a Class.classValue(@NonNull String annotation, @NonNull String member) The value of the annotation as a Class.default <T> Class<T>[]classValues(@NonNull Class<? extends Annotation> annotation) The value of the annotation as a Class.default <T> Class<T>[]classValues(@NonNull Class<? extends Annotation> annotation, @NonNull String member) The value of the annotation as a Class.default <T> Class<T>[]classValues(@NonNull String annotation) The value of the annotation as a Class.default <T> Class<T>[]classValues(@NonNull String annotation, @NonNull String member) The value of the annotation as a Class.default AnnotationMetadataMakes a copy of the annotation or returns this.default @NonNull OptionalDoubledoubleValue(@NonNull Class<? extends Annotation> annotation) The value as anOptionalDoublefor the given annotation and member.default @NonNull OptionalDoubledoubleValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member) The value as anOptionalDoublefor the given annotation and member.default @NonNull OptionalDoubledoubleValue(@NonNull String annotation, @NonNull String member) The value as anOptionalDoublefor the given annotation and member.enumValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member, Class<E> enumType) The value of the annotation as a Class.enumValue(@NonNull Class<? extends Annotation> annotation, Class<E> enumType) The value of the annotation as a Class.The value of the annotation as a Class.The value of the given enum.default <E extends Enum<E>>
E[]enumValues(@NonNull Class<? extends Annotation> annotation, @NonNull String member, Class<E> enumType) The enum values for the given annotation.default <E extends Enum<E>>
E[]enumValues(@NonNull Class<? extends Annotation> annotation, Class<E> enumType) The enum values for the given annotation.default <E extends Enum<E>>
E[]The enum values for the given annotation.default <E extends Enum<E>>
E[]enumValues(@NonNull String annotation, Class<E> enumType) The enum values for the given annotation.default <T extends Annotation>
@NonNull Optional<AnnotationValue<T>>findAnnotation(@NonNull Class<T> annotationClass) Find anAnnotationValuefor the given annotation type.default <T extends Annotation>
@NonNull Optional<AnnotationValue<T>>findAnnotation(@NonNull String annotation) Find anAnnotationValuefor the given annotation name.default <T extends Annotation>
@NonNull Optional<AnnotationValue<T>>findDeclaredAnnotation(@NonNull Class<T> annotationClass) Get all values for the given annotation that are directly declared on the annotated element.default <T extends Annotation>
@NonNull Optional<AnnotationValue<T>>findDeclaredAnnotation(@NonNull String annotation) Get all values for the given annotation that are directly declared on the annotated element.findRepeatableAnnotation(Class<? extends Annotation> annotation) Find repeatable annotation container.findRepeatableAnnotation(String annotation) Find repeatable annotation container.default <T extends Annotation>
@Nullable AnnotationValue<T>getAnnotation(@NonNull Class<T> annotationClass) Find anAnnotationValuefor the given annotation name.default <T extends Annotation>
@Nullable AnnotationValue<T>getAnnotation(@NonNull String annotation) Find anAnnotationValuefor the given annotation name.getAnnotationNameByStereotype(@NonNull Class<? extends Annotation> stereotype) Find the first annotation name for the given stereotype.getAnnotationNameByStereotype(String stereotype) Find the first annotation name for the given stereotype.All the annotation names this metadata declares.getAnnotationNamesByStereotype(@NonNull Class<? extends Annotation> stereotype) Resolve all annotation names that feature the given stereotype.getAnnotationNamesByStereotype(String stereotype) Resolve all annotation names that feature the given stereotype.default @NonNull Optional<Class<? extends Annotation>>getAnnotationType(@NonNull String name) Gets the type for a given annotation if it is present on the classpath.default @NonNull Optional<Class<? extends Annotation>>getAnnotationType(@NonNull String name, @NonNull ClassLoader classLoader) Gets the type for a given annotation if it is present on the classpath.default @NonNull Optional<Class<? extends Annotation>>getAnnotationTypeByStereotype(@NonNull Class<? extends Annotation> stereotype) Find the first annotation name for the given stereotype.default @NonNull Optional<Class<? extends Annotation>>getAnnotationTypeByStereotype(String stereotype) Find the first annotation name for the given stereotype.default @NonNull List<Class<? extends Annotation>>getAnnotationTypesByStereotype(@NonNull Class<? extends Annotation> stereotype) Resolve all annotation names that feature the given stereotype.default @NonNull List<Class<? extends Annotation>>getAnnotationTypesByStereotype(@NonNull Class<? extends Annotation> stereotype, @NonNull ClassLoader classLoader) Resolve all annotation names that feature the given stereotype.default @NonNull List<Class<? extends Annotation>>getAnnotationTypesByStereotype(@NonNull String stereotype) Resolve all annotation names that feature the given stereotype.default <T extends Annotation>
List<AnnotationValue<T>>getAnnotationValuesByName(String annotationType) Gets all the annotation values by the given repeatable type name.default <T extends Annotation>
List<AnnotationValue<T>>getAnnotationValuesByStereotype(String stereotype) Resolve all annotation values that feature the given stereotype.default <T extends Annotation>
@NonNull List<AnnotationValue<T>>getAnnotationValuesByType(@NonNull Class<T> annotationType) Gets all the annotation values by the given repeatable type.default <T extends Annotation>
@Nullable AnnotationValue<T>getDeclaredAnnotation(@NonNull Class<T> annotationClass) Find anAnnotationValuefor the given annotation name.default <T extends Annotation>
@Nullable AnnotationValue<T>getDeclaredAnnotation(@NonNull String annotation) Get all values for the given annotation that are directly declared on the annotated element.getDeclaredAnnotationNameByStereotype(String stereotype) Find the first annotation name for the given stereotype.All the declared annotation names this metadata declares.getDeclaredAnnotationNamesByStereotype(String stereotype) Resolve all annotations names for the given stereotype that are declared annotations.default @NonNull Optional<Class<? extends Annotation>>getDeclaredAnnotationTypeByStereotype(@NonNull Class<? extends Annotation> stereotype) Find the first declared annotation name for the given stereotype.default @NonNull Optional<Class<? extends Annotation>>getDeclaredAnnotationTypeByStereotype(String stereotype) Find the first annotation name for the given stereotype.default <T extends Annotation>
List<AnnotationValue<T>>getDeclaredAnnotationValuesByName(String annotationType) Gets only declared annotation values by the given repeatable type name.default <T extends Annotation>
@NonNull List<AnnotationValue<T>>getDeclaredAnnotationValuesByType(@NonNull Class<T> annotationType) Gets only declared annotation values by the given repeatable type.default @NonNull AnnotationMetadataGets the declared metadata without inherited metdata.Returns the names of the annotations which are declared stereotypes.getDefaultValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member, @NonNull Argument<T> requiredType) Return the default value for the given annotation member.getDefaultValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member, @NonNull Class<T> requiredType) Return the default value for the given annotation member.getDefaultValue(@NonNull String annotation, @NonNull String member, @NonNull Argument<T> requiredType) Return the default value for the given annotation member.Return the default value for the given annotation member.default @NonNull Map<CharSequence,Object> getDefaultValues(@NonNull String annotation) Return the default values for the given annotation name.Returns the names of the annotations which are stereotypes.default AnnotationMetadataUnwraps possible delegate or provider.getValue(@NonNull Class<? extends Annotation> annotation) Get the value of default "value" the given annotation.Get the value of default "value" the given annotation.Get the value of default "value" the given annotation.Get the value of the given annotation member.getValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member, @NonNull Argument<T> requiredType) Get the value of the given annotation member.getValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member, @NonNull Class<T> requiredType) Get the value of the given annotation member.Get the value of default "value" the given annotation.Get the value of default "value" the given annotation.Get the value of default "value" the given annotation.Get the value of the given annotation member.Get the value of the given annotation member.Get the value of the given annotation member.default <T> @NonNull OptionalValues<T>Get all values for the given annotation.default <T> @NonNull OptionalValues<T>Get all values for the given annotation and type of the underlying values.default booleanhasAnnotation(@Nullable Class<? extends Annotation> annotation) Checks whether this object has the given annotation on the object itself or inherited from a parent.default booleanhasAnnotation(String annotation) Checks whether this object has the given annotation on the object itself or inherited from a parent.default booleanhasDeclaredAnnotation(@Nullable Class<? extends Annotation> annotation) Checks whether this object has the given annotation directly declared on the object.default booleanhasDeclaredAnnotation(String annotation) Checks whether this object has the given annotation directly declared on the object.default booleanhasDeclaredStereotype(@Nullable Class<? extends Annotation> stereotype) Checks whether this object has the given stereotype directly declared on the object.default booleanhasDeclaredStereotype(Class<? extends Annotation>... annotations) Checks whether this object has any of the given stereotype directly declared on the object.default booleanhasDeclaredStereotype(String annotation) Checks whether this object has the given annotation stereotype on the object itself and not inherited from a parentdefault booleanDoes the metadata contain any property expressions like${foo.bar}.default booleanhasSimpleAnnotation(@Nullable String annotation) Checks whether the given annotation simple name (name without the package) is present in the annotations.default booleanhasSimpleDeclaredAnnotation(@Nullable String annotation) Checks whether the given annotation simple name (name without the package) is present in the declared annotations.default booleanhasStereotype(@Nullable Class<? extends Annotation> annotation) Checks whether this object has the given annotation stereotype on the object itself or inherited from a parentdefault booleanhasStereotype(Class<? extends Annotation>... annotations) Check whether any of the given stereotypes is present.default booleanhasStereotype(String annotation) Checks whether this object has the given annotation stereotype on the object itself or inherited from a parentdefault booleanhasStereotype(String[] annotations) Check whether any of the given stereotypes is present.default @NonNull OptionalIntintValue(@NonNull Class<? extends Annotation> annotation) The value as anOptionalIntfor the given annotation and member.default @NonNull OptionalIntThe value as anOptionalIntfor the given annotation and member.default @NonNull OptionalIntThe value as anOptionalIntfor the given annotation and member.default booleanisAnnotationPresent(@NonNull Class<? extends Annotation> annotationClass) Return whether an annotation is present.default booleanisDeclaredAnnotationPresent(@NonNull Class<? extends Annotation> annotationClass) Variation ofAnnotationSource.isAnnotationPresent(Class)for declared annotations.default booleanisEmpty()Is the annotation metadata empty.default booleanReturns whether the value of the given member is true.default booleanReturns whether the value of the given member is true.default booleanReturns whether the value of the given member is present.default booleanReturns whether the value of the given member is present.default booleanisRepeatableAnnotation(Class<? extends Annotation> annotation) Is repeatable annotation?default booleanisRepeatableAnnotation(String annotation) Is repeatable annotation?default booleanReturns whether the value of the given member is true.default booleanReturns whether the value of the given member is true.default OptionalLongThe value as anOptionalLongfor the given annotation and member.default @NonNull OptionalLongThe value as anOptionalLongfor the given annotation and member.stringValue(@NonNull Class<? extends Annotation> annotation) The value as an optional string for the given annotation and member.stringValue(@NonNull Class<? extends Annotation> annotation, @NonNull String member) The value as an optional string for the given annotation and member.stringValue(@NonNull String annotation) The value as an optional string for the given annotation and member.stringValue(@NonNull String annotation, @NonNull String member) The value as an optional string for the given annotation and member.stringValues(@NonNull Class<? extends Annotation> annotation) The values as string array for the given annotation and member.stringValues(@NonNull Class<? extends Annotation> annotation, @NonNull String member) The values as string array for the given annotation and member.stringValues(@NonNull String annotation) The values as string array for the given annotation and member.stringValues(@NonNull String annotation, @NonNull String member) The values as string array for the given annotation and member.default <T extends Annotation>
Tsynthesize(@NonNull Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.default <T extends Annotation>
Tsynthesize(@NonNull Class<T> annotationClass, @NonNull String sourceAnnotation) Synthesizes a new annotation for the given annotation type using the member values of the given source annotation.default @NonNull Annotation[]Synthesizes a new annotations from the metadata.default <T extends Annotation>
@NonNull T[]synthesizeAnnotationsByType(@NonNull Class<T> annotationClass) Synthesizes a new annotations from the metadata for the given type.default @NonNull Annotation[]Synthesizes a new annotations from the metadata.default <T extends Annotation>
TsynthesizeDeclared(@NonNull Class<T> annotationClass) Synthesizes a new annotation from the metadata for the given annotation type.default <T extends Annotation>
TsynthesizeDeclared(@NonNull Class<T> annotationClass, @NonNull String sourceAnnotation) Synthesizes a new annotation declared for the given annotation type using the member values of the given source annotation.default <T extends Annotation>
@NonNull T[]synthesizeDeclaredAnnotationsByType(@NonNull Class<T> annotationClass) Synthesizes a new annotations from the metadata for the given type.Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadata
enumValuesSet, enumValuesSet, getValues, hasDeclaredStereotype, hasEvaluatedExpressions, hasStereotypeNonRepeating, isAnnotationPresent, isDeclaredAnnotationPresentMethods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider
getAnnotationMetadata
-
Method Details
-
getStereotypeAnnotationNames
Description copied from interface:AnnotationMetadataReturns the names of the annotations which are stereotypes.A stereotype is a meta-annotation (an annotation declared on another annotation).
- Specified by:
getStereotypeAnnotationNamesin interfaceAnnotationMetadata- Returns:
- The names of the stereotype annotations
- See Also:
-
getDeclaredStereotypeAnnotationNames
Description copied from interface:AnnotationMetadataReturns the names of the annotations which are declared stereotypes.A stereotype is a meta-annotation (an annotation declared on another annotation).
A stereotype is considered declared when it it is a meta-annotation that is present on an annotation directly declared on the element and not inherited from a super class.
- Specified by:
getDeclaredStereotypeAnnotationNamesin interfaceAnnotationMetadata- Returns:
- The names of the stereotype annotations
- See Also:
-
getDeclaredAnnotationValuesByName
default <T extends Annotation> List<AnnotationValue<T>> getDeclaredAnnotationValuesByName(String annotationType) Description copied from interface:AnnotationMetadataGets only declared annotation values by the given repeatable type name.- Specified by:
getDeclaredAnnotationValuesByNamein interfaceAnnotationMetadata- Type Parameters:
T- The annotation type- Parameters:
annotationType- The annotation type- Returns:
- A list of values
-
getAnnotationValuesByName
default <T extends Annotation> List<AnnotationValue<T>> getAnnotationValuesByName(String annotationType) Description copied from interface:AnnotationMetadataGets all the annotation values by the given repeatable type name.- Specified by:
getAnnotationValuesByNamein interfaceAnnotationMetadata- Type Parameters:
T- The annotation type- Parameters:
annotationType- The annotation type- Returns:
- A list of values
-
getAnnotationValuesByStereotype
default <T extends Annotation> List<AnnotationValue<T>> getAnnotationValuesByStereotype(String stereotype) Description copied from interface:AnnotationMetadataResolve all annotation values that feature the given stereotype.- Specified by:
getAnnotationValuesByStereotypein interfaceAnnotationMetadata- Type Parameters:
T- The annotation type- Parameters:
stereotype- The annotation names- Returns:
- A set of annotation names
-
getDeclaredMetadata
Description copied from interface:AnnotationMetadataGets the declared metadata without inherited metdata.- Specified by:
getDeclaredMetadatain interfaceAnnotationMetadata- Returns:
- The declared metadata
-
hasSimpleAnnotation
Description copied from interface:AnnotationMetadataChecks whether the given annotation simple name (name without the package) is present in the annotations.- Specified by:
hasSimpleAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
hasPropertyExpressions
default boolean hasPropertyExpressions()Description copied from interface:AnnotationMetadataDoes the metadata contain any property expressions like${foo.bar}. Note this by default returnstrueas 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:
hasPropertyExpressionsin interfaceAnnotationMetadata- Returns:
- True if property expressions are present
-
hasSimpleDeclaredAnnotation
Description copied from interface:AnnotationMetadataChecks whether the given annotation simple name (name without the package) is present in the declared annotations.- Specified by:
hasSimpleDeclaredAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
enumValues
Description copied from interface:AnnotationMetadataThe enum values for the given annotation.- Specified by:
enumValuesin interfaceAnnotationMetadata- Type Parameters:
E- The enum type- Parameters:
annotation- The annotationenumType- The enum type- Returns:
- An array of enum values
-
enumValues
default <E extends Enum<E>> E[] enumValues(@NonNull @NonNull String annotation, @NonNull @NonNull String member, Class<E> enumType) Description copied from interface:AnnotationMetadataThe enum values for the given annotation.- Specified by:
enumValuesin interfaceAnnotationMetadata- Type Parameters:
E- The enum type- Parameters:
annotation- The annotationmember- The annotation memberenumType- The enum type- Returns:
- An array of enum values
-
enumValues
default <E extends Enum<E>> E[] enumValues(@NonNull @NonNull Class<? extends Annotation> annotation, Class<E> enumType) Description copied from interface:AnnotationMetadataThe enum values for the given annotation.- Specified by:
enumValuesin interfaceAnnotationMetadata- Type Parameters:
E- The enum type- Parameters:
annotation- The annotationenumType- The enum type- Returns:
- An array of enum values
-
enumValues
default <E extends Enum<E>> E[] enumValues(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member, Class<E> enumType) Description copied from interface:AnnotationMetadataThe enum values for the given annotation.- Specified by:
enumValuesin interfaceAnnotationMetadata- Type Parameters:
E- The enum type- Parameters:
annotation- The annotationmember- The annotation memberenumType- The enum type- Returns:
- An array of enum values
-
classValues
Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
classValuesin interfaceAnnotationMetadata- Type Parameters:
T- The type of the class- Parameters:
annotation- The annotation- Returns:
- An
Optionalclass
-
classValues
default <T> Class<T>[] classValues(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
classValuesin interfaceAnnotationMetadata- Type Parameters:
T- The type of the class- Parameters:
annotation- The annotationmember- The annotation member- Returns:
- An
Optionalclass
-
classValues
Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
classValuesin interfaceAnnotationMetadata- Type Parameters:
T- The type of the class- Parameters:
annotation- The annotation- Returns:
- An
Optionalclass
-
classValues
default <T> Class<T>[] classValues(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
classValuesin interfaceAnnotationMetadata- Type Parameters:
T- The type of the class- Parameters:
annotation- The annotationmember- The annotation member- Returns:
- An
Optionalclass
-
enumValue
default <E extends Enum<E>> Optional<E> enumValue(@NonNull @NonNull String annotation, Class<E> enumType) Description copied from interface:AnnotationMetadataThe value of the given enum.- Specified by:
enumValuein interfaceAnnotationMetadata- Type Parameters:
E- The enum type- Parameters:
annotation- The annotationenumType- The enum type- Returns:
- An
Optionalenum value
-
enumValue
default <E extends Enum<E>> Optional<E> enumValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member, Class<E> enumType) Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
enumValuein interfaceAnnotationMetadata- Type Parameters:
E- The enum type- Parameters:
annotation- The annotationmember- The annotation memberenumType- The enum type- Returns:
- An
Optionalclass
-
enumValue
default <E extends Enum<E>> Optional<E> enumValue(@NonNull @NonNull Class<? extends Annotation> annotation, Class<E> enumType) Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
enumValuein interfaceAnnotationMetadata- Type Parameters:
E- The enum type- Parameters:
annotation- The annotationenumType- The enum type- Returns:
- An
Optionalclass
-
enumValue
default <E extends Enum<E>> Optional<E> enumValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member, Class<E> enumType) Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
enumValuein interfaceAnnotationMetadata- Type Parameters:
E- The enum type- Parameters:
annotation- The annotationmember- The annotation memberenumType- The enum type- Returns:
- An
Optionalclass
-
longValue
default OptionalLong longValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as anOptionalLongfor the given annotation and member.- Specified by:
longValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- THe
OptionalLongvalue
-
booleanValue
default Optional<Boolean> booleanValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as an optional boolean for the given annotation and member.- Specified by:
booleanValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- The string value if it is present
-
booleanValue
default Optional<Boolean> booleanValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as an optional boolean for the given annotation and member.- Specified by:
booleanValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- The string value if it is present
-
booleanValue
@NonNull default @NonNull Optional<Boolean> booleanValue(@NonNull @NonNull Class<? extends Annotation> annotation) Description copied from interface:AnnotationMetadataThe value as an optional boolean for the given annotation and member.- Specified by:
booleanValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- The string value if it is present
-
booleanValue
Description copied from interface:AnnotationMetadataThe value as an optional boolean for the given annotation and member.- Specified by:
booleanValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- The string value if it is present
-
stringValues
@NonNull default @NonNull String[] stringValues(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe values as string array for the given annotation and member.- Specified by:
stringValuesin interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- The string values if it is present
-
stringValues
@NonNull default @NonNull String[] stringValues(@NonNull @NonNull Class<? extends Annotation> annotation) Description copied from interface:AnnotationMetadataThe values as string array for the given annotation and member.- Specified by:
stringValuesin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- The string values if it is present
-
stringValues
@NonNull default @NonNull String[] stringValues(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe values as string array for the given annotation and member.- Specified by:
stringValuesin interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- The string values if it is present
-
stringValues
Description copied from interface:AnnotationMetadataThe values as string array for the given annotation and member.- Specified by:
stringValuesin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- The string values if it is present
-
intValue
@NonNull default @NonNull OptionalInt intValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as anOptionalIntfor the given annotation and member.- Specified by:
intValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- THe
OptionalIntvalue
-
intValue
@NonNull default @NonNull OptionalInt intValue(@NonNull @NonNull Class<? extends Annotation> annotation) Description copied from interface:AnnotationMetadataThe value as anOptionalIntfor the given annotation and member.- Specified by:
intValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- THe
OptionalIntvalue
-
stringValue
@NonNull default @NonNull Optional<String> stringValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as an optional string for the given annotation and member.- Specified by:
stringValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- The string value if it is present
-
stringValue
@NonNull default @NonNull Optional<String> stringValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as an optional string for the given annotation and member.- Specified by:
stringValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- The string value if it is present
-
stringValue
@NonNull default @NonNull Optional<String> stringValue(@NonNull @NonNull Class<? extends Annotation> annotation) Description copied from interface:AnnotationMetadataThe value as an optional string for the given annotation and member.- Specified by:
stringValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- The string value if it is present
-
stringValue
Description copied from interface:AnnotationMetadataThe value as an optional string for the given annotation and member.- Specified by:
stringValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- The string value if it is present
-
doubleValue
@NonNull default @NonNull OptionalDouble doubleValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as anOptionalDoublefor the given annotation and member.- Specified by:
doubleValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- THe
OptionalDoublevalue
-
doubleValue
@NonNull default @NonNull OptionalDouble doubleValue(@NonNull @NonNull Class<? extends Annotation> annotation) Description copied from interface:AnnotationMetadataThe value as anOptionalDoublefor the given annotation and member.- Specified by:
doubleValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- THe
OptionalDoublevalue
-
getDefaultValues
@NonNull default @NonNull Map<CharSequence,Object> getDefaultValues(@NonNull @NonNull String annotation) Description copied from interface:AnnotationMetadataReturn the default values for the given annotation name.- Specified by:
getDefaultValuesin interfaceAnnotationMetadata- Parameters:
annotation- The annotation name- Returns:
- The default values
-
getValue
@NonNull default <T> @NonNull Optional<T> getValue(@NonNull @NonNull String annotation, @NonNull @NonNull Argument<T> requiredType) Description copied from interface:AnnotationMetadataGet the value of default "value" the given annotation.- Specified by:
getValuein interfaceAnnotationMetadata- Type Parameters:
T- Generic type- Parameters:
annotation- The annotation classrequiredType- requiredType- Returns:
- An
Optionalof the value
-
getValue
@NonNull default <T> @NonNull Optional<T> getValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull Argument<T> requiredType) Description copied from interface:AnnotationMetadataGet the value of default "value" the given annotation.- Specified by:
getValuein interfaceAnnotationMetadata- Type Parameters:
T- Generic type- Parameters:
annotation- The annotation classrequiredType- requiredType- Returns:
- An
Optionalof the value
-
getValue
@NonNull default <T> @NonNull Optional<T> getValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member, @NonNull @NonNull Argument<T> requiredType) Description copied from interface:AnnotationMetadataGet the value of the given annotation member.- Specified by:
getValuein interfaceAnnotationMetadata- Type Parameters:
T- The value- Parameters:
annotation- The annotation classmember- The annotation memberrequiredType- The required type- Returns:
- An
Optionalof the value
-
getDefaultValue
@NonNull default <T> @NonNull Optional<T> getDefaultValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member, @NonNull @NonNull Argument<T> requiredType) Description copied from interface:AnnotationMetadataReturn the default value for the given annotation member.- Specified by:
getDefaultValuein interfaceAnnotationMetadata- Type Parameters:
T- The required generic type- Parameters:
annotation- The annotationmember- The memberrequiredType- The required type- Returns:
- An optional value
-
getDefaultValue
@NonNull default <T> @NonNull Optional<T> getDefaultValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member, @NonNull @NonNull Argument<T> requiredType) Description copied from interface:AnnotationMetadataReturn the default value for the given annotation member.- Specified by:
getDefaultValuein interfaceAnnotationMetadata- Type Parameters:
T- The required generic type- Parameters:
annotation- The annotationmember- The memberrequiredType- The required type- Returns:
- An optional value
-
getValue
@NonNull default <T> @NonNull Optional<T> getValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member, @NonNull @NonNull Argument<T> requiredType) Description copied from interface:AnnotationMetadataGet the value of the given annotation member.- Specified by:
getValuein interfaceAnnotationMetadata- Type Parameters:
T- The value- Parameters:
annotation- The annotation classmember- The annotation memberrequiredType- The required type- Returns:
- An
Optionalof the value
-
synthesizeDeclared
Description copied from interface:AnnotationSourceSynthesizes 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:
synthesizeDeclaredin interfaceAnnotationMetadataProvider- Specified by:
synthesizeDeclaredin interfaceAnnotationSource- Type Parameters:
T- The annotation generic type- Parameters:
annotationClass- The annotation class- Returns:
- The annotation or null if it doesn't exist
-
synthesizeAnnotationsByType
@NonNull default <T extends Annotation> @NonNull T[] synthesizeAnnotationsByType(@NonNull @NonNull Class<T> annotationClass) Description copied from interface:AnnotationSourceSynthesizes 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:
synthesizeAnnotationsByTypein interfaceAnnotationMetadataProvider- Specified by:
synthesizeAnnotationsByTypein interfaceAnnotationSource- Type Parameters:
T- The annotation generic type- Parameters:
annotationClass- The annotation type- Returns:
- All annotations by the given type
-
synthesizeDeclaredAnnotationsByType
@NonNull default <T extends Annotation> @NonNull T[] synthesizeDeclaredAnnotationsByType(@NonNull @NonNull Class<T> annotationClass) Description copied from interface:AnnotationSourceSynthesizes 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:
synthesizeDeclaredAnnotationsByTypein interfaceAnnotationMetadataProvider- Specified by:
synthesizeDeclaredAnnotationsByTypein interfaceAnnotationSource- Type Parameters:
T- The annotation generic type- Parameters:
annotationClass- The annotation type- Returns:
- Declared annotations by the given type
-
getAnnotation
@Nullable default <T extends Annotation> @Nullable AnnotationValue<T> getAnnotation(@NonNull @NonNull String annotation) Description copied from interface:AnnotationSourceFind anAnnotationValuefor the given annotation name.- Specified by:
getAnnotationin interfaceAnnotationSource- Type Parameters:
T- The annotation type- Parameters:
annotation- The annotation name- Returns:
- A
AnnotationValueinstance or null
-
getAnnotation
@Nullable default <T extends Annotation> @Nullable AnnotationValue<T> getAnnotation(@NonNull @NonNull Class<T> annotationClass) Description copied from interface:AnnotationSourceFind anAnnotationValuefor the given annotation name.- Specified by:
getAnnotationin interfaceAnnotationSource- Type Parameters:
T- The annotation type- Parameters:
annotationClass- The annotation name- Returns:
- A
AnnotationValueinstance or null
-
getDeclaredAnnotation
@Nullable default <T extends Annotation> @Nullable AnnotationValue<T> getDeclaredAnnotation(@NonNull @NonNull String annotation) Description copied from interface:AnnotationSourceGet all values for the given annotation that are directly declared on the annotated element.- Specified by:
getDeclaredAnnotationin interfaceAnnotationSource- Type Parameters:
T- The annotation type- Parameters:
annotation- The annotation name- Returns:
- A
AnnotationValueinstance
-
findDeclaredAnnotation
@NonNull default <T extends Annotation> @NonNull Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull @NonNull Class<T> annotationClass) Description copied from interface:AnnotationSourceGet all values for the given annotation that are directly declared on the annotated element.- Specified by:
findDeclaredAnnotationin interfaceAnnotationMetadata- Specified by:
findDeclaredAnnotationin interfaceAnnotationMetadataProvider- Specified by:
findDeclaredAnnotationin interfaceAnnotationSource- Type Parameters:
T- The annotation type- Parameters:
annotationClass- The annotation name- Returns:
- A
AnnotationValueinstance
-
getDeclaredAnnotation
@Nullable default <T extends Annotation> @Nullable AnnotationValue<T> getDeclaredAnnotation(@NonNull @NonNull Class<T> annotationClass) Description copied from interface:AnnotationSourceFind anAnnotationValuefor the given annotation name.- Specified by:
getDeclaredAnnotationin interfaceAnnotationSource- Type Parameters:
T- The annotation type- Parameters:
annotationClass- The annotation name- Returns:
- A
AnnotationValueinstance or null
-
isAnnotationPresent
Description copied from interface:AnnotationSourceReturn whether an annotation is present.- Specified by:
isAnnotationPresentin interfaceAnnotationMetadata- Specified by:
isAnnotationPresentin interfaceAnnotationMetadataProvider- Specified by:
isAnnotationPresentin interfaceAnnotationSource- Parameters:
annotationClass- The annotation class- Returns:
- True if it is
- See Also:
-
isDeclaredAnnotationPresent
default boolean isDeclaredAnnotationPresent(@NonNull @NonNull Class<? extends Annotation> annotationClass) Description copied from interface:AnnotationSourceVariation ofAnnotationSource.isAnnotationPresent(Class)for declared annotations.- Specified by:
isDeclaredAnnotationPresentin interfaceAnnotationMetadata- Specified by:
isDeclaredAnnotationPresentin interfaceAnnotationMetadataProvider- Specified by:
isDeclaredAnnotationPresentin interfaceAnnotationSource- Parameters:
annotationClass- The annotation class- Returns:
- True if it is
- See Also:
-
getDefaultValue
@NonNull default <T> @NonNull Optional<T> getDefaultValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member, @NonNull @NonNull Class<T> requiredType) Description copied from interface:AnnotationMetadataReturn the default value for the given annotation member.- Specified by:
getDefaultValuein interfaceAnnotationMetadata- Type Parameters:
T- The required generic type- Parameters:
annotation- The annotationmember- The memberrequiredType- The required type- Returns:
- An optional value
-
getValue
@NonNull default <T> @NonNull Optional<T> getValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member, @NonNull @NonNull Class<T> requiredType) Description copied from interface:AnnotationMetadataGet the value of the given annotation member.- Specified by:
getValuein interfaceAnnotationMetadata- Type Parameters:
T- The value- Parameters:
annotation- The annotation classmember- The annotation memberrequiredType- The required type- Returns:
- An
Optionalof the value
-
getAnnotationNameByStereotype
Description copied from interface:AnnotationMetadataFind the first annotation name for the given stereotype.- Specified by:
getAnnotationNameByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The stereotype- Returns:
- The annotation name
-
getDeclaredAnnotationNameByStereotype
Description copied from interface:AnnotationMetadataFind the first annotation name for the given stereotype.- Specified by:
getDeclaredAnnotationNameByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The stereotype- Returns:
- The annotation name
-
getAnnotationTypeByStereotype
@NonNull default @NonNull Optional<Class<? extends Annotation>> getAnnotationTypeByStereotype(@NonNull @NonNull Class<? extends Annotation> stereotype) Description copied from interface:AnnotationMetadataFind the first annotation name for the given stereotype.- Specified by:
getAnnotationTypeByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The stereotype- Returns:
- The annotation name
-
getDeclaredAnnotationTypeByStereotype
@NonNull default @NonNull Optional<Class<? extends Annotation>> getDeclaredAnnotationTypeByStereotype(@NonNull @NonNull Class<? extends Annotation> stereotype) Description copied from interface:AnnotationMetadataFind the first declared annotation name for the given stereotype.- Specified by:
getDeclaredAnnotationTypeByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The stereotype- Returns:
- The annotation name
-
getDeclaredAnnotationTypeByStereotype
@NonNull default @NonNull Optional<Class<? extends Annotation>> getDeclaredAnnotationTypeByStereotype(String stereotype) Description copied from interface:AnnotationMetadataFind the first annotation name for the given stereotype.- Specified by:
getDeclaredAnnotationTypeByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The stereotype- Returns:
- The annotation name
-
getAnnotationTypeByStereotype
@NonNull default @NonNull Optional<Class<? extends Annotation>> getAnnotationTypeByStereotype(String stereotype) Description copied from interface:AnnotationMetadataFind the first annotation name for the given stereotype.- Specified by:
getAnnotationTypeByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The stereotype- Returns:
- The annotation name
-
getAnnotationNameByStereotype
@NonNull default @NonNull Optional<String> getAnnotationNameByStereotype(@NonNull @NonNull Class<? extends Annotation> stereotype) Description copied from interface:AnnotationMetadataFind the first annotation name for the given stereotype.- Specified by:
getAnnotationNameByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The stereotype- Returns:
- The annotation name
-
getValues
@NonNull default <T> @NonNull OptionalValues<T> getValues(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull Class<T> valueType) Description copied from interface:AnnotationMetadataGet all values for the given annotation.- Specified by:
getValuesin interfaceAnnotationMetadata- Type Parameters:
T- Generic type- Parameters:
annotation- The annotation namevalueType- valueType- Returns:
- The
OptionalValues
-
getAnnotationNamesByStereotype
@NonNull default @NonNull List<String> getAnnotationNamesByStereotype(@NonNull @NonNull Class<? extends Annotation> stereotype) Description copied from interface:AnnotationMetadataResolve all annotation names that feature the given stereotype.- Specified by:
getAnnotationNamesByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The annotation names- Returns:
- A set of annotation names
-
getAnnotationTypesByStereotype
@NonNull default @NonNull List<Class<? extends Annotation>> getAnnotationTypesByStereotype(@NonNull @NonNull Class<? extends Annotation> stereotype) Description copied from interface:AnnotationMetadataResolve all annotation names that feature the given stereotype.- Specified by:
getAnnotationTypesByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The annotation names- Returns:
- A set of annotation names
-
getAnnotationTypesByStereotype
@NonNull default @NonNull List<Class<? extends Annotation>> getAnnotationTypesByStereotype(@NonNull @NonNull String stereotype) Description copied from interface:AnnotationMetadataResolve all annotation names that feature the given stereotype.- Specified by:
getAnnotationTypesByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The annotation names- Returns:
- A set of annotation names
-
getAnnotationTypesByStereotype
@NonNull default @NonNull List<Class<? extends Annotation>> getAnnotationTypesByStereotype(@NonNull @NonNull Class<? extends Annotation> stereotype, @NonNull @NonNull ClassLoader classLoader) Description copied from interface:AnnotationMetadataResolve all annotation names that feature the given stereotype.- Specified by:
getAnnotationTypesByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The annotation namesclassLoader- The classloader to load annotation type- Returns:
- A set of annotation names
-
findAnnotation
@NonNull default <T extends Annotation> @NonNull Optional<AnnotationValue<T>> findAnnotation(@NonNull @NonNull Class<T> annotationClass) Description copied from interface:AnnotationSourceFind anAnnotationValuefor the given annotation type.- Specified by:
findAnnotationin interfaceAnnotationMetadata- Specified by:
findAnnotationin interfaceAnnotationMetadataProvider- Specified by:
findAnnotationin interfaceAnnotationSource- Type Parameters:
T- The annotation type- Parameters:
annotationClass- The annotation- Returns:
- A
AnnotationValueinstance
-
getValue
@NonNull default <T> @NonNull Optional<T> getValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member, @NonNull @NonNull Class<T> requiredType) Description copied from interface:AnnotationMetadataGet the value of the given annotation member.- Specified by:
getValuein interfaceAnnotationMetadata- Type Parameters:
T- The value- Parameters:
annotation- The annotation classmember- The annotation memberrequiredType- The required type- Returns:
- An
Optionalof the value
-
longValue
@NonNull default @NonNull OptionalLong longValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as anOptionalLongfor the given annotation and member.- Specified by:
longValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- THe
OptionalLongvalue
-
classValue
Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
classValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- An
Optionalclass
-
classValue
@NonNull default @NonNull Optional<Class> classValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
classValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The annotation member- Returns:
- An
Optionalclass
-
classValue
@NonNull default @NonNull Optional<Class> classValue(@NonNull @NonNull Class<? extends Annotation> annotation) Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
classValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- An
Optionalclass
-
classValue
@NonNull default @NonNull Optional<Class> classValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value of the annotation as a Class.- Specified by:
classValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The annotation member- Returns:
- An
Optionalclass
-
intValue
@NonNull default @NonNull OptionalInt intValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as anOptionalIntfor the given annotation and member.- Specified by:
intValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- THe
OptionalIntvalue
-
doubleValue
@NonNull default @NonNull OptionalDouble doubleValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataThe value as anOptionalDoublefor the given annotation and member.- Specified by:
doubleValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotationmember- The member- Returns:
- THe
OptionalDoublevalue
-
getValue
@NonNull default <T> @NonNull Optional<T> getValue(@NonNull @NonNull String annotation, @NonNull @NonNull Class<T> requiredType) Description copied from interface:AnnotationMetadataGet the value of default "value" the given annotation.- Specified by:
getValuein interfaceAnnotationMetadata- Type Parameters:
T- The value- Parameters:
annotation- The annotation classrequiredType- The required type- Returns:
- An
Optionalof the value
-
getValue
@NonNull default @NonNull Optional<Object> getValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataGet the value of the given annotation member.- Specified by:
getValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation classmember- The annotation member- Returns:
- An
Optionalof the value
-
getValue
@NonNull default @NonNull Optional<Object> getValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataGet the value of the given annotation member.- Specified by:
getValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation classmember- The annotation member- Returns:
- An
Optionalof the value
-
isTrue
Description copied from interface:AnnotationMetadataReturns whether the value of the given member is true.- Specified by:
isTruein interfaceAnnotationMetadata- Parameters:
annotation- The annotation classmember- The annotation member- Returns:
- True if the value is true
-
isTrue
default boolean isTrue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataReturns whether the value of the given member is true.- Specified by:
isTruein interfaceAnnotationMetadata- Parameters:
annotation- The annotation classmember- The annotation member- Returns:
- True if the value is true
-
isPresent
Description copied from interface:AnnotationMetadataReturns whether the value of the given member is present.- Specified by:
isPresentin interfaceAnnotationMetadata- Parameters:
annotation- The annotation classmember- The annotation member- Returns:
- True if the value is true
-
isPresent
default boolean isPresent(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataReturns whether the value of the given member is present.- Specified by:
isPresentin interfaceAnnotationMetadata- Parameters:
annotation- The annotation classmember- The annotation member- Returns:
- True if the value is true
-
isFalse
default boolean isFalse(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull String member) Description copied from interface:AnnotationMetadataReturns whether the value of the given member is true.- Specified by:
isFalsein interfaceAnnotationMetadata- Parameters:
annotation- The annotation classmember- The annotation member- Returns:
- True if the value is true
-
isFalse
Description copied from interface:AnnotationMetadataReturns whether the value of the given member is true.- Specified by:
isFalsein interfaceAnnotationMetadata- Parameters:
annotation- The annotation classmember- The annotation member- Returns:
- True if the value is true
-
getValue
Description copied from interface:AnnotationMetadataGet the value of default "value" the given annotation.- Specified by:
getValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation class- Returns:
- An
Optionalof the value
-
getValue
@NonNull default @NonNull Optional<Object> getValue(@NonNull @NonNull Class<? extends Annotation> annotation) Description copied from interface:AnnotationMetadataGet the value of default "value" the given annotation.- Specified by:
getValuein interfaceAnnotationMetadata- Parameters:
annotation- The annotation class- Returns:
- An
Optionalof the value
-
getValue
@NonNull default <T> @NonNull Optional<T> getValue(@NonNull @NonNull Class<? extends Annotation> annotation, @NonNull @NonNull Class<T> requiredType) Description copied from interface:AnnotationMetadataGet the value of default "value" the given annotation.- Specified by:
getValuein interfaceAnnotationMetadata- Type Parameters:
T- Generic type- Parameters:
annotation- The annotation classrequiredType- requiredType- Returns:
- An
Optionalof the value
-
getAnnotationType
@NonNull default @NonNull Optional<Class<? extends Annotation>> getAnnotationType(@NonNull @NonNull String name) Description copied from interface:AnnotationMetadataGets the type for a given annotation if it is present on the classpath. Subclasses can potentially override to provide optimized loading.- Specified by:
getAnnotationTypein interfaceAnnotationMetadata- Parameters:
name- The type name- Returns:
- The type if present
-
getAnnotationType
@NonNull default @NonNull Optional<Class<? extends Annotation>> getAnnotationType(@NonNull @NonNull String name, @NonNull @NonNull ClassLoader classLoader) Description copied from interface:AnnotationMetadataGets the type for a given annotation if it is present on the classpath. Subclasses can potentially override to provide optimized loading.- Specified by:
getAnnotationTypein interfaceAnnotationMetadata- Parameters:
name- The type nameclassLoader- The ClassLoader to load the type- Returns:
- The type if present
-
hasAnnotation
Description copied from interface:AnnotationMetadataChecks whether this object has the given annotation on the object itself or inherited from a parent.- Specified by:
hasAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
hasStereotype
Description copied from interface:AnnotationMetadataChecks 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:
hasStereotypein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
hasStereotype
Description copied from interface:AnnotationMetadataCheck whether any of the given stereotypes is present.- Specified by:
hasStereotypein interfaceAnnotationMetadata- Parameters:
annotations- The annotations- Returns:
- True if any of the given stereotypes are present
-
hasStereotype
Description copied from interface:AnnotationMetadataCheck whether any of the given stereotypes is present.- Specified by:
hasStereotypein interfaceAnnotationMetadata- Parameters:
annotations- The annotations- Returns:
- True if any of the given stereotypes are present
-
hasDeclaredAnnotation
Description copied from interface:AnnotationMetadataChecks whether this object has the given annotation directly declared on the object.- Specified by:
hasDeclaredAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
hasDeclaredStereotype
Description copied from interface:AnnotationMetadataChecks whether this object has the given stereotype directly declared on the object.- Specified by:
hasDeclaredStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The annotation- Returns:
- True if the annotation is present
-
hasDeclaredStereotype
Description copied from interface:AnnotationMetadataChecks whether this object has any of the given stereotype directly declared on the object.- Specified by:
hasDeclaredStereotypein interfaceAnnotationMetadata- Parameters:
annotations- The annotations- Returns:
- True if any of the given stereotypes are present
-
isEmpty
default boolean isEmpty()Description copied from interface:AnnotationMetadataIs the annotation metadata empty.- Specified by:
isEmptyin interfaceAnnotationMetadata- Returns:
- True if it is
-
hasDeclaredAnnotation
Description copied from interface:AnnotationMetadataChecks whether this object has the given annotation directly declared on the object.- Specified by:
hasDeclaredAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
getAnnotationNames
Description copied from interface:AnnotationMetadataAll the annotation names this metadata declares.- Specified by:
getAnnotationNamesin interfaceAnnotationMetadata- Returns:
- All the annotation names this metadata declares
-
getDeclaredAnnotationNames
Description copied from interface:AnnotationMetadataAll the declared annotation names this metadata declares.- Specified by:
getDeclaredAnnotationNamesin interfaceAnnotationMetadata- Returns:
- All the declared annotation names this metadata declares
-
hasAnnotation
Description copied from interface:AnnotationMetadataChecks whether this object has the given annotation on the object itself or inherited from a parent.- Specified by:
hasAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
hasStereotype
Description copied from interface:AnnotationMetadataChecks 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:
hasStereotypein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
hasDeclaredStereotype
Description copied from interface:AnnotationMetadataChecks 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:
hasDeclaredStereotypein interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- True if the annotation is present
-
getAnnotationNamesByStereotype
Description copied from interface:AnnotationMetadataResolve all annotation names that feature the given stereotype.- Specified by:
getAnnotationNamesByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The annotation names- Returns:
- A set of annotation names
-
getDeclaredAnnotationNamesByStereotype
Description copied from interface:AnnotationMetadataResolve all annotations names for the given stereotype that are declared annotations.- Specified by:
getDeclaredAnnotationNamesByStereotypein interfaceAnnotationMetadata- Parameters:
stereotype- The stereotype- Returns:
- The declared annotations
-
findAnnotation
@NonNull default <T extends Annotation> @NonNull Optional<AnnotationValue<T>> findAnnotation(@NonNull @NonNull String annotation) Description copied from interface:AnnotationSourceFind anAnnotationValuefor the given annotation name.- Specified by:
findAnnotationin interfaceAnnotationMetadataProvider- Specified by:
findAnnotationin interfaceAnnotationSource- Type Parameters:
T- The annotation type- Parameters:
annotation- The annotation name- Returns:
- A
AnnotationValueinstance
-
getValues
@NonNull default <T> @NonNull OptionalValues<T> getValues(@NonNull @NonNull String annotation, @NonNull @NonNull Class<T> valueType) Description copied from interface:AnnotationMetadataGet all values for the given annotation and type of the underlying values.- Specified by:
getValuesin interfaceAnnotationMetadata- Type Parameters:
T- Generic type- Parameters:
annotation- The annotation namevalueType- valueType- Returns:
- The
OptionalValues
-
findDeclaredAnnotation
@NonNull default <T extends Annotation> @NonNull Optional<AnnotationValue<T>> findDeclaredAnnotation(@NonNull @NonNull String annotation) Description copied from interface:AnnotationSourceGet all values for the given annotation that are directly declared on the annotated element.- Specified by:
findDeclaredAnnotationin interfaceAnnotationMetadataProvider- Specified by:
findDeclaredAnnotationin interfaceAnnotationSource- Type Parameters:
T- The annotation type- Parameters:
annotation- The annotation name- Returns:
- A
AnnotationValueinstance
-
getDefaultValue
@NonNull default <T> @NonNull Optional<T> getDefaultValue(@NonNull @NonNull String annotation, @NonNull @NonNull String member, @NonNull @NonNull Class<T> requiredType) Description copied from interface:AnnotationMetadataReturn the default value for the given annotation member.- Specified by:
getDefaultValuein interfaceAnnotationMetadata- Type Parameters:
T- The required generic type- Parameters:
annotation- The annotationmember- The memberrequiredType- The required type- Returns:
- An optional value
-
synthesize
Description copied from interface:AnnotationSourceSynthesizes 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:
synthesizein interfaceAnnotationMetadataProvider- Specified by:
synthesizein interfaceAnnotationSource- Type Parameters:
T- The annotation generic type- Parameters:
annotationClass- The annotation class- Returns:
- The annotation or null if it doesn't exist
-
synthesize
@Nullable default <T extends Annotation> T synthesize(@NonNull @NonNull Class<T> annotationClass, @NonNull @NonNull String sourceAnnotation) Description copied from interface:AnnotationSourceSynthesizes 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.Namedannotation an be synthesized from the metadata of the ajakarta.inject.Namedannotation.- Specified by:
synthesizein interfaceAnnotationSource- Type Parameters:
T- The annotation generic type- Parameters:
annotationClass- The annotation classsourceAnnotation- The source annotation that provides the member values- Returns:
- The annotation or null if it doesn't exist
-
synthesizeDeclared
@Nullable default <T extends Annotation> T synthesizeDeclared(@NonNull @NonNull Class<T> annotationClass, @NonNull @NonNull String sourceAnnotation) Description copied from interface:AnnotationSourceSynthesizes 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.Namedannotation an be synthesized from the metadata of the ajakarta.inject.Namedannotation.- Specified by:
synthesizeDeclaredin interfaceAnnotationSource- Type Parameters:
T- The annotation generic type- Parameters:
annotationClass- The annotation classsourceAnnotation- The source annotation that provides the member values- Returns:
- The annotation or null if it doesn't exist
-
synthesizeAll
Description copied from interface:AnnotationSourceSynthesizes 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:
synthesizeAllin interfaceAnnotationMetadataProvider- Specified by:
synthesizeAllin interfaceAnnotationSource- Returns:
- All the annotations
-
synthesizeDeclared
Description copied from interface:AnnotationSourceSynthesizes 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:
synthesizeDeclaredin interfaceAnnotationMetadataProvider- Specified by:
synthesizeDeclaredin interfaceAnnotationSource- Returns:
- All declared annotations
-
getAnnotationValuesByType
@NonNull default <T extends Annotation> @NonNull List<AnnotationValue<T>> getAnnotationValuesByType(@NonNull @NonNull Class<T> annotationType) Description copied from interface:AnnotationMetadataGets all the annotation values by the given repeatable type.- Specified by:
getAnnotationValuesByTypein interfaceAnnotationMetadata- Type Parameters:
T- The annotation type- Parameters:
annotationType- The annotation type- Returns:
- A list of values
-
getDeclaredAnnotationValuesByType
@NonNull default <T extends Annotation> @NonNull List<AnnotationValue<T>> getDeclaredAnnotationValuesByType(@NonNull @NonNull Class<T> annotationType) Description copied from interface:AnnotationMetadataGets only declared annotation values by the given repeatable type.- Specified by:
getDeclaredAnnotationValuesByTypein interfaceAnnotationMetadata- Type Parameters:
T- The annotation type- Parameters:
annotationType- The annotation type- Returns:
- A list of values
-
isRepeatableAnnotation
Description copied from interface:AnnotationMetadataIs repeatable annotation?- Specified by:
isRepeatableAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- true if repeatable
-
isRepeatableAnnotation
Description copied from interface:AnnotationMetadataIs repeatable annotation?- Specified by:
isRepeatableAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- true if repeatable
-
findRepeatableAnnotation
Description copied from interface:AnnotationMetadataFind repeatable annotation container.- Specified by:
findRepeatableAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- optional repeatable annotation container
-
findRepeatableAnnotation
Description copied from interface:AnnotationMetadataFind repeatable annotation container.- Specified by:
findRepeatableAnnotationin interfaceAnnotationMetadata- Parameters:
annotation- The annotation- Returns:
- optional repeatable annotation container
-
copyAnnotationMetadata
Description copied from interface:AnnotationMetadataMakes a copy of the annotation or returns this.- Specified by:
copyAnnotationMetadatain interfaceAnnotationMetadata- Returns:
- the copy
-
getTargetAnnotationMetadata
Description copied from interface:AnnotationSourceUnwraps possible delegate or provider.- Specified by:
getTargetAnnotationMetadatain interfaceAnnotationMetadata- Specified by:
getTargetAnnotationMetadatain interfaceAnnotationMetadataProvider- Specified by:
getTargetAnnotationMetadatain interfaceAnnotationSource- Returns:
- unwrapped
- See Also:
-