io.micronaut.core.annotation

Interface AnnotationMapper<T extends Annotation>

Type Parameters:

T - The annotation type

All Known Implementing Classes:

PermitAllAnnotationMapper, PersistenceContextAnnotationMapper, RolesAllowedAnnotationMapper

public interface AnnotationMapper<T extends Annotation>

An AnnotationMapper is a type that is capable of mapping a given annotation to one or many annotations at compile time.

Use cases include if you wish to support different annotation types or specifications but wish to map them a common internal annotation annotation.

For example to support the JPA spec you may wish to map the PersistenceContext annotation to one or many other internal annotations with relying specifically on the JPA specification.

AnnotationMapper instances can be registered with the service loader pattern via META-INF/services and will be picked up at compile time

Since:

1.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
Class<T>	annotationType() The annotation type to be mapped.
List<AnnotationValue<?>>	map(AnnotationValue<T> annotation) The map method will be called for each instances of the annotation returned via the annotationType() method.

Method Detail

annotationType

Class<T> annotationType()

The annotation type to be mapped.

Returns:

The annotation type

map

List<AnnotationValue<?>> map(AnnotationValue<T> annotation)

The map method will be called for each instances of the annotation returned via the annotationType() method.

Parameters:

annotation - The annotation values

Returns:

A list of zero or many annotations and values to map to