Class UniversalConstruct<T extends AnnotatedConstruct, U extends UniversalConstruct<T,U>>

java.lang.Object

org.microbean.construct.UniversalConstruct<T,U>

Type Parameters:

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

U - a type representing one of the permitted subclasses

All Implemented Interfaces:

Constable, AnnotatedConstruct

Direct Known Subclasses:

UniversalElement, UniversalType

public abstract sealed class UniversalConstruct<T extends AnnotatedConstruct, U extends UniversalConstruct<T,U>>
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(T delegate, List<? extends AnnotationMirror> annotations, PrimordialDomain domain)	Creates a new AnnotatedConstruct.
protected	UniversalConstruct(T delegate, PrimordialDomain domain)	Creates a new AnnotatedConstruct.

Method Summary

Modifier and Type	Method	Description
protected abstract U	annotate(List<? extends AnnotationMirror> replacementAnnotations)	Experimental; returns a new UniversalConstruct instance annotated with only the supplied annotations, which are often synthetic.
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)
final List<? extends UniversalAnnotation>	getAnnotationMirrors()
final <A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType)
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(AnnotatedConstruct, List, PrimordialDomain)

UniversalConstruct

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

Creates a new AnnotatedConstruct.

Parameters:

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

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

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

See Also:

• annotate(List)

Method Details

annotate

protected abstract U annotate(List<? extends AnnotationMirror> replacementAnnotations)

Experimental; returns a new UniversalConstruct instance annotated with only the supplied annotations, which are often synthetic.

Parameters:

replacementAnnotations - a List of AnnotationMirrors; must not be null

Returns:

a new UniversalConstruct instance; never null

Throws:

NullPointerException - if replacementAnnotations is null

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<? extends UniversalAnnotation> getAnnotationMirrors()

Specified by:

getAnnotationMirrors in interface AnnotatedConstruct

getAnnotation

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

Specified by:

getAnnotation in interface AnnotatedConstruct

getAnnotationsByType

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

Specified by:

getAnnotationsByType in interface AnnotatedConstruct

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()