Class UniversalConstruct<T extends AnnotatedConstruct>

java.lang.Object

org.microbean.construct.UniversalConstruct<T>

Type Parameters:

T - a type of AnnotatedConstruct, which may be only either Element or TypeMirror

All Implemented Interfaces:

Constable, AnnotatedConstruct

Direct Known Subclasses:

UniversalElement, UniversalType

public abstract sealed class UniversalConstruct<T extends AnnotatedConstruct>
extends Object
implements AnnotatedConstruct, Constable
permits UniversalElement, UniversalType

An abstract implementation of AnnotatedConstruct from which only UniversalElement and UniversalType descend.

Author:

Laird Nelson

See Also:

• AnnotatedConstruct
• UniversalElement
• UniversalType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UniversalConstruct(List<? extends AnnotationMirror> annotations, T delegate, PrimordialDomain domain)	Creates a new AnnotatedConstruct.
protected	UniversalConstruct(T delegate, PrimordialDomain domain)	Creates a new AnnotatedConstruct.

Method Summary

Modifier and Type	Method	Description
final T	delegate()	Returns the delegate to which operations are delegated.
final Optional<? extends ConstantDesc>	describeConstable()
final PrimordialDomain	domain()	Returns the PrimordialDomain supplied at construction time.
final boolean	equals(Object other)
final <A extends Annotation> A	getAnnotation(Class<A> annotationType)	Deprecated. The use of this method is discouraged.
final List<AnnotationMirror>	getAnnotationMirrors()	Returns a non-null, determinate, mutable, thread-safe List of AnnotationMirror instances representing the annotations to be considered directly present on this UniversalConstruct implementation.
final <A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType)	Deprecated. The use of this method is discouraged.
final int	hashCode()
final String	toString()
static final <T extends AnnotatedConstruct> T	unwrap(T t)	Unwraps the supplied AnnotatedConstruct implementation such that the returned value is not an instance of UniversalConstruct.

Methods inherited from class Object

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

Constructor Details

UniversalConstruct

protected UniversalConstruct(T delegate,
 PrimordialDomain domain)

Creates a new AnnotatedConstruct.

Parameters:

delegate - a delegate to which operations are delegated; must not be null

domain - a PrimordialDomain representing the construct domain from which the supplied delegate is presumed to have originated; must not be null

Throws:

NullPointerException - if either argument is null

See Also:

• UniversalConstruct(List, AnnotatedConstruct, PrimordialDomain)

UniversalConstruct

protected UniversalConstruct(List<? extends AnnotationMirror> annotations,
 T delegate,
 PrimordialDomain domain)

Creates a new AnnotatedConstruct.

Parameters:

annotations - a List of AnnotationMirror instances representing annotations, often synthetic, that this UniversalConstruct should bear; may be null in which case only the annotations from the supplied delegate will be used

delegate - a delegate to which operations are delegated; must not be null

domain - a PrimordialDomain representing the construct domain from which the supplied delegate is presumed to have originated; must not be null

Throws:

NullPointerException - if any argument is null

Method Details

delegate

public final T delegate()

Returns the delegate to which operations are delegated.

The delegate is guaranteed not to be an instance of UniversalConstruct.

Returns:

a non-null delegate

See Also:

• Element
• TypeMirror

describeConstable

public final 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

getAnnotationMirrors

public final List<AnnotationMirror> getAnnotationMirrors()

Returns a non-null, determinate, mutable, thread-safe List of AnnotationMirror instances representing the annotations to be considered directly present on this UniversalConstruct implementation.

Specified by:

getAnnotationMirrors in interface AnnotatedConstruct

Returns:

a non-null, determinate, mutable thread-safe List of AnnotationMirrors

See Also:

• AnnotatedConstruct.getAnnotationMirrors()

getAnnotation

@Deprecated
public final <A extends Annotation> A getAnnotation(Class<A> annotationType)

Deprecated.

The use of this method is discouraged.

Makes a best effort to return an Annotation of the appropriate type present on this UniversalConstruct implementation.

See the specification for the AnnotatedConstruct.getAnnotation(Class) method for important details.

UniversalConstruct implementations deliberately permit modification of their annotations. Consequently, this override first checks to see if there is at least one AnnotationMirror whose annotation type is declared by a TypeElement whose qualified name is equal to the canonical name of the supplied Class. If there is, then the getAnnotation(Class) method is invoked on the delegate and its result is returned. Otherwise, null is returned.

There are circumstances where the Annotation returned by this method may not accurately reflect a synthetic annotation added to this AnnotatedConstruct implementation's annotations.

In general, the use of this method is discouraged.

Specified by:

getAnnotation in interface AnnotatedConstruct

Parameters:

annotationType - a Class that is an annotation interface; must not be null

Returns:

an appropriate Annotation, or null

Throws:

NullPointerException - if annotationType is null

See Also:

• AnnotatedConstruct.getAnnotation(Class)

getAnnotationsByType

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

Deprecated.

The use of this method is discouraged.

Makes a best effort to return an array of Annotations of the appropriate type associated with this UniversalConstruct implementation.

See the specification for the AnnotatedConstruct.getAnnotationsByType(Class) method for important details.

UniversalConstruct implementations deliberately permit modification of their annotations. Consequently, this override first checks to see if there is at least one AnnotationMirror whose annotation type is declared by a TypeElement whose qualified name is equal to the canonical name of the supplied Class. If there is, then the getAnnotationsByType(Class) method is invoked on the delegate and its result is returned. Otherwise, an empty array is returned.

There are circumstances where the Annotation array returned by this method may not accurately reflect synthetic annotations added to this AnnotatedConstruct implementation's annotations.

In general, the use of this method is discouraged.

Specified by:

getAnnotationsByType in interface AnnotatedConstruct

Parameters:

annotationType - a Class that is an annotation interface; must not be null

Returns:

an appropriate Annotation, or null

Throws:

NullPointerException - if annotationType is null

See Also:

• AnnotatedConstruct.getAnnotation(Class)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object

unwrap

public static final <T extends AnnotatedConstruct>
T unwrap(T t)

Unwraps the supplied AnnotatedConstruct implementation such that the returned value is not an instance of UniversalConstruct.

Type Parameters:

T - an AnnotatedConstruct subtype (possibly UniversalElement or UniversalType)

Parameters:

t - an AnnotatedConstruct; may be null

Returns:

an object of the appropriate type that is guaranteed not to be an instance of UniversalConstruct

See Also:

• delegate()