Class UniversalAnnotation

java.lang.Object

org.microbean.construct.element.UniversalAnnotation

All Implemented Interfaces:

Constable, AnnotationMirror

public final class UniversalAnnotation
extends Object
implements AnnotationMirror, Constable

An AnnotationMirror implementation.

Author:

Laird Nelson

See Also:

• AnnotationMirror

Constructor Summary

Constructors

Constructor	Description
UniversalAnnotation(AnnotationMirror delegate, PrimordialDomain domain)	Creates a new UniversalAnnotation.

Method Summary

Modifier and Type	Method	Description
final AnnotationMirror	delegate()	Returns the delegate to which operations are delegated.
Optional<? extends ConstantDesc>	describeConstable()
final PrimordialDomain	domain()	Returns the PrimordialDomain supplied at construction time.
final boolean	equals(Object other)
final UniversalType	getAnnotationType()
final Map<? extends UniversalElement, ? extends UniversalAnnotationValue>	getElementValues()
final int	hashCode()
static final List<? extends UniversalAnnotation>	of(Collection<? extends AnnotationMirror> as, PrimordialDomain domain)	Returns a non-null, immutable List of UniversalAnnotations whose elements wrap the supplied List's elements.
static final UniversalAnnotation	of(AnnotationMirror a, PrimordialDomain d)	Returns a non-null UniversalAnnotation that is either the supplied AnnotationMirror (if it itself is an UniversalAnnotation) or one that wraps it.
static final AnnotationMirror	unwrap(AnnotationMirror a)	Unwraps the supplied AnnotationMirror implementation such that the returned value is not an instance of UniversalAnnotation.

Methods inherited from class Object

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

Constructor Details

UniversalAnnotation

public UniversalAnnotation(AnnotationMirror delegate,
 PrimordialDomain domain)

Creates a new UniversalAnnotation.

Parameters:

delegate - an AnnotationMirror to which operations will be delegated; must not be null

domain - a PrimordialDomain; must not be null

Throws:

NullPointerException - if either argument is null

Method Details

delegate

public final AnnotationMirror delegate()

Returns the delegate to which operations are delegated.

Returns:

a non-null delegate

See Also:

• AnnotationMirror

describeConstable

public Optional<? extends ConstantDesc> describeConstable()

Specified by:

describeConstable in interface Constable

domain

public final PrimordialDomain domain()

Returns the PrimordialDomain supplied at construction time.

Returns:

the non-null PrimordialDomain supplied at construction time

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

getAnnotationType

public final UniversalType getAnnotationType()

Specified by:

getAnnotationType in interface AnnotationMirror

getElementValues

public final Map<? extends UniversalElement, ? extends UniversalAnnotationValue> getElementValues()

Specified by:

getElementValues in interface AnnotationMirror

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

of

public static final UniversalAnnotation of(AnnotationMirror a,
 PrimordialDomain d)

Returns a non-null UniversalAnnotation that is either the supplied AnnotationMirror (if it itself is an UniversalAnnotation) or one that wraps it.

Parameters:

a - an AnnotationMirror; must not be null

d - a PrimordialDomain; must not be null

Returns:

a non-null UniversalAnnotation

Throws:

NullPointerException - if either argument is null

See Also:

• UniversalAnnotation(AnnotationMirror, PrimordialDomain)

of

public static final List<? extends UniversalAnnotation> of(Collection<? extends AnnotationMirror> as,
 PrimordialDomain domain)

Returns a non-null, immutable List of UniversalAnnotations whose elements wrap the supplied List's elements.

Parameters:

as - a Collection of AnnotationMirrors; must not be null

domain - a PrimordialDomain; must not be null

Returns:

a non-null, immutable List of UniversalAnnotations

Throws:

NullPointerException - if either argument is null

unwrap

public static final AnnotationMirror unwrap(AnnotationMirror a)

Unwraps the supplied AnnotationMirror implementation such that the returned value is not an instance of UniversalAnnotation.

Parameters:

a - an AnnotationMirror; may be null

Returns:

an AnnotationMirror that is guaranteed not to be an instance of UniversalAnnotation

See Also:

• delegate()