Class SyntheticAnnotationMirror

java.lang.Object

org.microbean.construct.element.SyntheticAnnotationMirror

All Implemented Interfaces:

Constable, AnnotationMirror

public final class SyntheticAnnotationMirror
extends Object
implements AnnotationMirror, Constable

An experimental AnnotationMirror implementation that is partially or wholly synthetic.

It is possible to create SyntheticAnnotationMirror instances representing annotations that a Java compiler will not produce. For example, annotations cannot refer to each other, directly or indirectly, but two SyntheticAnnotationMirrors may do so.

Author:

Laird Nelson

External Specifications

• Java Language Specification, section 9.6.1

Constructor Summary

Constructors

Constructor	Description
SyntheticAnnotationMirror(TypeElement annotationTypeElement)	Creates a new SyntheticAnnotationMirror.
SyntheticAnnotationMirror(TypeElement annotationTypeElement, Map<? extends String, ?> values)	Creates a new SyntheticAnnotationMirror.

Method Summary

Modifier and Type	Method	Description
final Optional<? extends ConstantDesc>	describeConstable()
final DeclaredType	getAnnotationType()
final Map<? extends ExecutableElement, ? extends AnnotationValue>	getElementValues()

Methods inherited from class Object

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

Constructor Details

SyntheticAnnotationMirror

public SyntheticAnnotationMirror(TypeElement annotationTypeElement)

Creates a new SyntheticAnnotationMirror.

Parameters:

annotationTypeElement - a TypeElement representing an annotation type; must not be null; must return ANNOTATION_TYPE from its getKind() method; SyntheticAnnotationTypeElement implementations are strongly preferred

Throws:

NullPointerException - if annotationTypeElement is null

IllegalArgumentException - if annotationTypeElement does not return ANNOTATION_TYPE from an invocation of its getKind() method, or if values has more entries in it than annotationTypeElement has anotation elements

See Also:

• SyntheticAnnotationMirror(TypeElement, Map)

SyntheticAnnotationMirror

public SyntheticAnnotationMirror(TypeElement annotationTypeElement,
 Map<? extends String, ?> values)

Creates a new SyntheticAnnotationMirror.

Parameters:

annotationTypeElement - a TypeElement representing an annotation type; must not be null; must return ANNOTATION_TYPE from its getKind() method; SyntheticAnnotationTypeElement implementations are strongly preferred

values - a Map of annotation values indexed by annotation element name; must not be null; must contain only values that are permissible for annotation elements

Throws:

NullPointerException - if any argument is null

IllegalArgumentException - if annotationTypeElement does not return ANNOTATION_TYPE from an invocation of its getKind() method, or if values has more entries in it than annotationTypeElement has anotation elements

Method Details

describeConstable

public final Optional<? extends ConstantDesc> describeConstable()

Specified by:

describeConstable in interface Constable

getAnnotationType

public final DeclaredType getAnnotationType()

Specified by:

getAnnotationType in interface AnnotationMirror

getElementValues

public final Map<? extends ExecutableElement, ? extends AnnotationValue> getElementValues()

Specified by:

getElementValues in interface AnnotationMirror