fish.payara.microprofile.metrics.cdi

Class AnnotationReader<T extends Annotation>

java.lang.Object

fish.payara.microprofile.metrics.cdi.AnnotationReader<T>

Type Parameters:

T - Type of the MP metrics annotation

public final class AnnotationReader<T extends Annotation>
extends Object

Utility that allows reading the different MP metrics Annotations from different annotated abstractions providing a common interface to allow generic handling and a common logic independent of the source of the Annotation. Supported are:

• AnnotatedElement
• Annotated
• InjectionPoint

It is important to realise that Annotated and InjectionPoint have to be used as a source when available as they allow to add or remove Annotation effectively acting as a runtime override of the compiled information provided by AnnotatedElement. This utility also encodes most of the logic as defined by the MP Metrics specification. This includes the logic of which annotation applied and how the metrics effective name if computed from annotation values and the annotated element. For this reason the methods are documented in great detail.

Since:

5.202

Author:

Jan Bernitt

Field Summary

Fields

Modifier and Type	Field and Description
static AnnotationReader<org.eclipse.microprofile.metrics.annotation.ConcurrentGauge>	CONCURRENT_GAUGE
static AnnotationReader<org.eclipse.microprofile.metrics.annotation.Counted>	COUNTED
static AnnotationReader<org.eclipse.microprofile.metrics.annotation.Gauge>	GAUGE
static AnnotationReader<org.eclipse.microprofile.metrics.annotation.Metered>	METERED
static AnnotationReader<org.eclipse.microprofile.metrics.annotation.Metric>	METRIC
static AnnotationReader<org.eclipse.microprofile.metrics.annotation.SimplyTimed>	SIMPLY_TIMED
static AnnotationReader<org.eclipse.microprofile.metrics.annotation.Timed>	TIMED

Method Summary

Modifier and Type	Method and Description
boolean	absolute(T annotation) Returns the metric absolute flag as defined by the provided Annotation
<E extends Member & AnnotatedElement> T	annotation(Class<?> bean, E element) Returns the effective annotation for the provided bean and element.
T	annotation(javax.enterprise.inject.spi.InjectionPoint point) Reads the effective Annotation for the provided InjectionPoint.
Class<T>	annotationType()
AnnotationReader<T>	asType(org.eclipse.microprofile.metrics.MetricType type) If this AnnotationReader reads Metric Annotation it can be associated with different MetricType so that the provided type is used when creating Metadata using the AnnotationReader.
String	description(T annotation) Returns the metric description as defined by the provided Annotation
String	displayName(T annotation) Returns the metric display name as defined by the provided Annotation
boolean	equals(Object obj)
static <T extends Annotation> AnnotationReader<T>	forAnnotation(Class<T> annotationType) Get AnnotationReader for a provided Annotation.
<M extends org.eclipse.microprofile.metrics.Metric> M	getOrRegister(javax.enterprise.inject.spi.InjectionPoint point, Class<M> metric, org.eclipse.microprofile.metrics.MetricRegistry registry) Resolves the Metric referred to by the provided InjectionPoint.
int	hashCode()
<E extends Member & AnnotatedElement> boolean	isPresent(Class<?> bean, E element) Checks if this AnnotationReader's annotationType() is present either at the provided AnnotatedElement or the provided bean Class.
boolean	isReference(T annotation) Checks if an Annotation does not provide any information beyond the required name and tags.
org.eclipse.microprofile.metrics.Metadata	metadata(javax.enterprise.inject.spi.AnnotatedMember<?> member) Returns the metric Metadata as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint.
<E extends Member & AnnotatedElement> org.eclipse.microprofile.metrics.Metadata	metadata(Class<?> bean, E element) Reads the effective Metadata for the provided bean Class and AnnotatedElement.
org.eclipse.microprofile.metrics.Metadata	metadata(javax.enterprise.inject.spi.InjectionPoint point) Returns the metric Metadata as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint.
org.eclipse.microprofile.metrics.Metadata	metadata(T annotation) Returns the full Metadata as defined by the provided Annotation
org.eclipse.microprofile.metrics.MetricID	metricID(javax.enterprise.inject.spi.AnnotatedMember<?> member) Returns the metric MetricID as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint.
<E extends Member & AnnotatedElement> org.eclipse.microprofile.metrics.MetricID	metricID(Class<?> bean, E element) Reads the effective MetricID for the provided bean Class and AnnotatedElement.
org.eclipse.microprofile.metrics.MetricID	metricID(javax.enterprise.inject.spi.InjectionPoint point) Returns the metric MetricID as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint.
org.eclipse.microprofile.metrics.MetricID	metricID(T annotation) Returns the MetricID as defined by the provided Annotation's name and tags attributes.
String	name(javax.enterprise.inject.spi.AnnotatedMember<?> member) Returns the metric name as defined by the MP specification for the annotation situation at hand for the provided AnnotatedMember.
<E extends Member & AnnotatedElement> String	name(Class<?> bean, E element) Reads the effective name for the provided bean Class and AnnotatedElement.
String	name(javax.enterprise.inject.spi.InjectionPoint point) Returns the metric name as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint.
String	name(T annotation) Returns the metric name as defined by the provided Annotation
static Iterable<AnnotationReader<?>>	readers()
boolean	reusable(T annotation) Returns the metric reusable flag as defined by the provided Annotation
org.eclipse.microprofile.metrics.Tag[]	tags(T annotation) Returns the metric tags as defined by the provided Annotation
static org.eclipse.microprofile.metrics.Tag[]	tagsFromString(String[] tags)
String	toString()
org.eclipse.microprofile.metrics.MetricType	type()
String	unit(T annotation) Returns the metric unit as defined by the provided Annotation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONCURRENT_GAUGE

public static final AnnotationReader<org.eclipse.microprofile.metrics.annotation.ConcurrentGauge> CONCURRENT_GAUGE

COUNTED

public static final AnnotationReader<org.eclipse.microprofile.metrics.annotation.Counted> COUNTED

GAUGE

public static final AnnotationReader<org.eclipse.microprofile.metrics.annotation.Gauge> GAUGE

METERED

public static final AnnotationReader<org.eclipse.microprofile.metrics.annotation.Metered> METERED

METRIC

public static final AnnotationReader<org.eclipse.microprofile.metrics.annotation.Metric> METRIC

TIMED

public static final AnnotationReader<org.eclipse.microprofile.metrics.annotation.Timed> TIMED

SIMPLY_TIMED

public static final AnnotationReader<org.eclipse.microprofile.metrics.annotation.SimplyTimed> SIMPLY_TIMED

Method Detail

forAnnotation

public static <T extends Annotation> AnnotationReader<T> forAnnotation(Class<T> annotationType)

Get AnnotationReader for a provided Annotation.

Parameters:

annotationType -

Returns:

The AnnotationReader for the provided Annotation type

Throws:

IllegalAccessException - In case no such reader exists

readers

public static Iterable<AnnotationReader<?>> readers()

Returns:

all available AnnotationReaders

annotationType

public Class<T> annotationType()

asType

public AnnotationReader<T> asType(org.eclipse.microprofile.metrics.MetricType type)

If this AnnotationReader reads Metric Annotation it can be associated with different MetricType so that the provided type is used when creating Metadata using the AnnotationReader.

Parameters:

type - any MetricType

Returns:

A new AnnotationReader using the provided MetricType

Throws:

IllegalStateException - In case this method is called on AnnotationReader that is not reading Metric Annotation.

type

public org.eclipse.microprofile.metrics.MetricType type()

Returns:

the MetricType used by this AnnotationReader when generating a Metadata object any of the variants of the metadata(Annotation) methods. Usually each Annotation is associated with a particular MetricType but for Metric Annotation the type can be changed using #asType(Class) methods.

annotation

public <E extends Member & AnnotatedElement> T annotation(Class<?> bean,
                                                          E element)

Returns the effective annotation for the provided bean and element.

Parameters:

bean - type of the bean that declared the provided element

element - a AnnotatedElement possibly annotated with this AnnotationReader's annotationType()

Returns:

the effective Annotation, or null. The element's annotations take precedence over the bean's annotations.

annotation

public T annotation(javax.enterprise.inject.spi.InjectionPoint point)

Reads the effective Annotation for the provided InjectionPoint.

Parameters:

point - source InjectionPoint for an annotated element having this AnnotationReader's annotationType(), not null

Returns:

the effective annotation for the provided InjectionPoint, never null

Throws:

IllegalArgumentException - In case the provided InjectionPoint isn't effectively annotated with this AnnotationReader's Annotation.

isPresent

public <E extends Member & AnnotatedElement> boolean isPresent(Class<?> bean,
                                                               E element)

Checks if this AnnotationReader's annotationType() is present either at the provided AnnotatedElement or the provided bean Class.

Parameters:

bean - type of the bean that declared the provided element

element - a AnnotatedElement possibly annotated with this AnnotationReader's annotationType()

Returns:

true, if provided element or bean are annotated with this AnnotationReader's annotationType(), else false.

name

public String name(T annotation)

Returns the metric name as defined by the provided Annotation

Parameters:

annotation - source annotation to read, not null

Returns:

name value of the provided source annotation

name

public String name(javax.enterprise.inject.spi.InjectionPoint point)

Returns the metric name as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint. This does take into account that annotations might have been added or removed at runtime.

Parameters:

point - source InjectionPoint for an annotated element having this AnnotationReader's annotationType(), not null

Returns:

full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case the provided InjectionPoint isn't effectively annotated with this AnnotationReader's Annotation.

name

public String name(javax.enterprise.inject.spi.AnnotatedMember<?> member)

Returns the metric name as defined by the MP specification for the annotation situation at hand for the provided AnnotatedMember. This does take into account that annotations might have been added or removed at runtime.

Parameters:

member - source AnnotatedMember for an annotated element having this AnnotationReader's annotationType(), not null

Returns:

full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case the provided AnnotatedMember isn't effectively annotated with this AnnotationReader's Annotation.

name

public <E extends Member & AnnotatedElement> String name(Class<?> bean,
                                                         E element)

Reads the effective name for the provided bean Class and AnnotatedElement. Either bean or element must have this AnnotationReader's Annotation.

Parameters:

bean - type of the bean that declared the provided element possibly annotated with this AnnotationReader's annotationType()

element - a AnnotatedElement possibly annotated with this AnnotationReader's annotationType()

Returns:

full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case neither the AnnotatedElement or the Class isn't annotated with this AnnotationReader's Annotation.

tags

public org.eclipse.microprofile.metrics.Tag[] tags(T annotation)

Returns the metric tags as defined by the provided Annotation

Parameters:

annotation - source annotation to read, not null

Returns:

tags value of the provided source annotation

metricID

public org.eclipse.microprofile.metrics.MetricID metricID(T annotation)

Returns the MetricID as defined by the provided Annotation's name and tags attributes.

Parameters:

annotation - source annotation to read, not null

Returns:

MetricID value of the provided source annotation

metricID

public org.eclipse.microprofile.metrics.MetricID metricID(javax.enterprise.inject.spi.InjectionPoint point)

Returns the metric MetricID as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint. This does take into account that annotations might have been added or removed at runtime.

Parameters:

point - source InjectionPoint for an annotated element having this AnnotationReader's annotationType(), not null

Returns:

MetricID with full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case the provided InjectionPoint isn't effectively annotated with this AnnotationReader's Annotation.

metricID

public org.eclipse.microprofile.metrics.MetricID metricID(javax.enterprise.inject.spi.AnnotatedMember<?> member)

Returns the metric MetricID as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint. This does take into account that annotations might have been added or removed at runtime.

Parameters:

point - source AnnotatedMember for an annotated element having this AnnotationReader's annotationType(), not null

Returns:

MetricID with full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case the provided AnnotatedMember isn't effectively annotated with this AnnotationReader's Annotation.

metricID

public <E extends Member & AnnotatedElement> org.eclipse.microprofile.metrics.MetricID metricID(Class<?> bean,
                                                                                                E element)

Reads the effective MetricID for the provided bean Class and AnnotatedElement. Either bean or element must have this AnnotationReader's Annotation.

Parameters:

bean - type of the bean that declared the provided element possibly annotated with this AnnotationReader's annotationType()

element - a AnnotatedElement possibly annotated with this AnnotationReader's annotationType()

Returns:

MetricID with full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case neither the AnnotatedElement or the Class isn't annotated with this AnnotationReader's Annotation.

displayName

public String displayName(T annotation)

Returns the metric display name as defined by the provided Annotation

Parameters:

annotation - source annotation to read, not null

Returns:

display name value of the provided source annotation

description

public String description(T annotation)

Returns the metric description as defined by the provided Annotation

Parameters:

annotation - source annotation to read, not null

Returns:

description of the provided source annotation

unit

public String unit(T annotation)

Returns the metric unit as defined by the provided Annotation

Parameters:

annotation - source annotation to read, not null

Returns:

unit of the provided source annotation

reusable

public boolean reusable(T annotation)

Returns the metric reusable flag as defined by the provided Annotation

Parameters:

annotation - source annotation to read, not null

Returns:

reusable flag of the provided source annotation

absolute

public boolean absolute(T annotation)

Returns the metric absolute flag as defined by the provided Annotation

Parameters:

annotation - source annotation to read, not null

Returns:

absolute flag of the provided source annotation

metadata

public org.eclipse.microprofile.metrics.Metadata metadata(T annotation)

Returns the full Metadata as defined by the provided Annotation

Parameters:

annotation - source annotation to read, not null

Returns:

Metadata of the provided source annotation

metadata

public org.eclipse.microprofile.metrics.Metadata metadata(javax.enterprise.inject.spi.InjectionPoint point)

Returns the metric Metadata as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint. This does take into account that annotations might have been added or removed at runtime.

Parameters:

point - source InjectionPoint for an annotated element having this AnnotationReader's annotationType(), not null

Returns:

Metadata with full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case the provided InjectionPoint isn't effectively annotated with this AnnotationReader's Annotation.

metadata

public org.eclipse.microprofile.metrics.Metadata metadata(javax.enterprise.inject.spi.AnnotatedMember<?> member)

Returns the metric Metadata as defined by the MP specification for the annotation situation at hand for the provided InjectionPoint. This does take into account that annotations might have been added or removed at runtime.

Parameters:

point - source AnnotatedMember for an annotated element having this AnnotationReader's annotationType(), not null

Returns:

Metadata with full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case the provided AnnotatedMember isn't effectively annotated with this AnnotationReader's Annotation.

metadata

public <E extends Member & AnnotatedElement> org.eclipse.microprofile.metrics.Metadata metadata(Class<?> bean,
                                                                                                E element)

Reads the effective Metadata for the provided bean Class and AnnotatedElement. Either bean or element must have this AnnotationReader's Annotation.

Parameters:

bean - type of the bean that declared the provided element possibly annotated with this AnnotationReader's annotationType()

element - a AnnotatedElement possibly annotated with this AnnotationReader's annotationType()

Returns:

Metadata with full metric name as required by the MP specification

Throws:

IllegalArgumentException - In case neither the AnnotatedElement or the Class isn't annotated with this AnnotationReader's Annotation.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isReference

public boolean isReference(T annotation)

Checks if an Annotation does not provide any information beyond the required name and tags.

Parameters:

annotation - source annotation to read, not null

Returns:

true, of no property is set to a value that would require using Metadata when registering, else false.

getOrRegister

public <M extends org.eclipse.microprofile.metrics.Metric> M getOrRegister(javax.enterprise.inject.spi.InjectionPoint point,
                                                                           Class<M> metric,
                                                                           org.eclipse.microprofile.metrics.MetricRegistry registry)

Resolves the Metric referred to by the provided InjectionPoint. If it does not exist, the metric is created. Lookup and creation are one atomic operation. Depending on the provided information in the effective Annotation for the provided InjectionPoint the metric is resolved or registered using Metadata, name and Tags or just its name. A Gauge can only be resolved, not created.

Parameters:

point - source InjectionPoint for an annotated element having this AnnotationReader's annotationType(), not null

metric - type of the Metric to find or create, not null

registry - MetricRegistry to use, not null

Returns:

the resolved or registered metric, or null if a Gauge did not exist

tagsFromString

public static org.eclipse.microprofile.metrics.Tag[] tagsFromString(String[] tags)