Module org.microbean.lang

Package org.microbean.lang

Class AnnotatedConstruct

java.lang.Object

org.microbean.lang.AnnotatedConstruct

All Implemented Interfaces:

AnnotatedConstruct

Direct Known Subclasses:

Element, TypeMirror

public abstract sealed class AnnotatedConstruct
extends Object
implements AnnotatedConstruct
permits Element, TypeMirror

A mutable implementation of the AnnotatedConstruct interface.

Author:

Laird Nelson

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AnnotatedConstruct()	Creates a new AnnotatedConstruct.
protected	AnnotatedConstruct(Collection<? extends AnnotationMirror> annotationMirrors)	Creates a new AnnotatedConstruct.
protected	AnnotatedConstruct(AnnotationMirror annotationMirror)	Creates a new AnnotatedConstruct.

Method Summary

Modifier and Type	Method	Description
void	addAnnotationMirror(AnnotationMirror a)	Adds an AnnotationMirror to this AnnotatedConstruct.
final void	addAnnotationMirrors(Iterable<? extends AnnotationMirror> as)	Adds AnnotationMirrors to this AnnotatedConstruct.
<A extends Annotation> A	getAnnotation(Class<A> annotationType)
List<? extends AnnotationMirror>	getAnnotationMirrors()
<A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType)
protected AnnotationMirror	validateAnnotationMirror(AnnotationMirror a)	Returns a valid version of the supplied AnnotationMirror, or throws some kind of RuntimeException if validation fails.

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotatedConstruct

protected AnnotatedConstruct()

Creates a new AnnotatedConstruct.

See Also:

• AnnotatedConstruct(Collection)

AnnotatedConstruct

protected AnnotatedConstruct(AnnotationMirror annotationMirror)

Creates a new AnnotatedConstruct.

Parameters:

annotationMirror - an AnnotationMirror to be borne by the new object

See Also:

• AnnotatedConstruct(Collection)

AnnotatedConstruct

protected AnnotatedConstruct(Collection<? extends AnnotationMirror> annotationMirrors)

Creates a new AnnotatedConstruct.

Parameters:

annotationMirrors - a Collection of AnnotationMirrors to be borne by the new object

Method Details

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType)

Specified by:

getAnnotation in interface AnnotatedConstruct

getAnnotationsByType

public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)

Specified by:

getAnnotationsByType in interface AnnotatedConstruct

getAnnotationMirrors

public List<? extends AnnotationMirror> getAnnotationMirrors()

Specified by:

getAnnotationMirrors in interface AnnotatedConstruct

addAnnotationMirror

public void addAnnotationMirror(AnnotationMirror a)

Adds an AnnotationMirror to this AnnotatedConstruct.

Parameters:

a - the AnnotationMirror to add; must not be null

Throws:

NullPointerException - if a is null

addAnnotationMirrors

public final void addAnnotationMirrors(Iterable<? extends AnnotationMirror> as)

Adds AnnotationMirrors to this AnnotatedConstruct.

Parameters:

as - the AnnotationMirrors to add; must not be null and must not produce null elements

Throws:

NullPointerException - if as is null or produces a null element

validateAnnotationMirror

protected AnnotationMirror validateAnnotationMirror(AnnotationMirror a)

Returns a valid version of the supplied AnnotationMirror, or throws some kind of RuntimeException if validation fails.

This implementation simply checks to see if the supplied AnnotationMirror is non-null.

Parameters:

a - the AnnotationMirror to validate; must not be null

Returns:

a valid version of the supplied AnnotationMirror; this implementation simply returns the supplied AnnotationMirror

Throws:

NullPointerException - if a is null