micrometer-commons 1.12.0 · io.micrometer.common.annotation.AnnotationHandler

This class is able to find all methods annotated with the Micrometer annotations. All methods mean that if you have both an interface and an implementation annotated with Micrometer annotations then this class is capable of finding both of them and merging into one set of information.

This information is then used to add proper key-values to objects such as span or timer from the method arguments that are annotated with a proper annotation. Code ported from Spring Cloud Sleuth.

Modifier and Type	Field and Description
private final Class<? extends Annotation>	annotationClass
private final Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver>	expressionResolverProvider
private final BiConsumer<KeyValue, T>	keyValueConsumer
private static final InternalLogger	log
private final Function<Class<? extends ValueResolver>, ? extends ValueResolver>	resolverProvider
private final BiFunction<Annotation, Object, KeyValue>	toKeyValue

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	AnnotationHandler(BiConsumer<KeyValue, T> consumer that takes a `KeyValue` and mutates the `<T>` type keyValueConsumer, Function<Class<? extends ValueResolver>, ? extends ValueResolver> function converting a class extending a `ValueResolver` to an instance of that class resolverProvider, Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver> function converting a class extending a `ValueExpressionResolver` to an instance of that class expressionResolverProvider, Class<? extends Annotation> annotation containing `KeyValue` related information annotation, BiFunction<Annotation, Object, KeyValue> function converting the annotation and the expression or annotation value to a `KeyValue` toKeyValue) Creates a new instance of `AnnotationHandler`.

public

AnnotationHandler(BiConsumer<KeyValue, T>

consumer that takes a KeyValue and mutates the <T> type

keyValueConsumer, Function<Class<? extends ValueResolver>, ? extends ValueResolver>

function converting a class extending a ValueResolver to an instance of that class

resolverProvider, Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver>

function converting a class extending a ValueExpressionResolver to an instance of that class

expressionResolverProvider, Class<? extends Annotation>

annotation containing KeyValue related information

annotation, BiFunction<Annotation, Object, KeyValue>

function converting the annotation and the expression or annotation value to a KeyValue

toKeyValue)

Creates a new instance of AnnotationHandler.

Method Summary

Modifier and Type	Method and Description
private void	addAnnotatedArguments(T objectToModify, List<AnnotatedParameter> toBeAdded)
public void	addAnnotatedParameters(T object to modify objectToModify, ProceedingJoinPoint proceeding join point pjp) Modifies the object with `KeyValue` related information.
private void	getAnnotationsFromInterfaces(ProceedingJoinPoint pjp, Method mostSpecificMethod, List<AnnotatedParameter> annotatedParameters)
public Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver>	getExpressionResolverProvider()
public Function<Class<? extends ValueResolver>, ? extends ValueResolver>	getResolverProvider()
private void	mergeAnnotatedParameters(List<AnnotatedParameter> annotatedParameters, List<AnnotatedParameter> annotatedParametersForActualMethod)
private boolean	methodsAreTheSame(Method mostSpecificMethod, Method method)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

annotationClass	back to summary
private final Class<? extends Annotation> annotationClass

expressionResolverProvider	back to summary
private final Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver> expressionResolverProvider

keyValueConsumer	back to summary
private final BiConsumer<KeyValue, T> keyValueConsumer

log	back to summary
private static final InternalLogger log

resolverProvider	back to summary
private final Function<Class<? extends ValueResolver>, ? extends ValueResolver> resolverProvider

toKeyValue	back to summary
private final BiFunction<Annotation, Object, KeyValue> toKeyValue

Constructor Detail

AnnotationHandler back to summary

AnnotationHandler	back to summary
public AnnotationHandler(BiConsumer<KeyValue, T> keyValueConsumer, Function<Class<? extends ValueResolver>, ? extends ValueResolver> resolverProvider, Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver> expressionResolverProvider, Class<? extends Annotation> annotation, BiFunction<Annotation, Object, KeyValue> toKeyValue) Creates a new instance of `AnnotationHandler`. Parameters keyValueConsumer:BiConsumer<KeyValue, T> consumer that takes a `KeyValue` and mutates the `<T>` type resolverProvider:Function<Class<? extends ValueResolver>, ? extends ValueResolver> function converting a class extending a `ValueResolver` to an instance of that class expressionResolverProvider:Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver> function converting a class extending a `ValueExpressionResolver` to an instance of that class annotation:Class<? extends Annotation> annotation containing `KeyValue` related information toKeyValue:BiFunction<Annotation, Object, KeyValue> function converting the annotation and the expression or annotation value to a `KeyValue`

public AnnotationHandler(BiConsumer<KeyValue, T> keyValueConsumer, Function<Class<? extends ValueResolver>, ? extends ValueResolver> resolverProvider, Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver> expressionResolverProvider, Class<? extends Annotation> annotation, BiFunction<Annotation, Object, KeyValue> toKeyValue)

Creates a new instance of AnnotationHandler.

Parameters

keyValueConsumer:BiConsumer<KeyValue, T>: consumer that takes a KeyValue and mutates the <T> type
resolverProvider:Function<Class<? extends ValueResolver>, ? extends ValueResolver>: function converting a class extending a ValueResolver to an instance of that class
expressionResolverProvider:Function<Class<? extends ValueExpressionResolver>, ? extends ValueExpressionResolver>: function converting a class extending a ValueExpressionResolver to an instance of that class
annotation:Class<? extends Annotation>: annotation containing KeyValue related information
toKeyValue:BiFunction<Annotation, Object, KeyValue>: function converting the annotation and the expression or annotation value to a KeyValue

Method Detail

addAnnotatedArguments	back to summary
private void addAnnotatedArguments(T objectToModify, List<AnnotatedParameter> toBeAdded)

addAnnotatedParameters back to summary

addAnnotatedParameters	back to summary
public void addAnnotatedParameters(T objectToModify, ProceedingJoinPoint pjp) Modifies the object with `KeyValue` related information. Parameters objectToModify:T object to modify pjp:ProceedingJoinPoint proceeding join point

public void addAnnotatedParameters(T objectToModify, ProceedingJoinPoint pjp)

Modifies the object with KeyValue related information.