Class UniversalElement

java.lang.Object

org.microbean.construct.UniversalConstruct<Element>

org.microbean.construct.element.UniversalElement

All Implemented Interfaces:

Constable, AnnotatedConstruct, Element, ExecutableElement, ModuleElement, PackageElement, Parameterizable, QualifiedNameable, RecordComponentElement, TypeElement, TypeParameterElement, VariableElement

public final class UniversalElement
extends UniversalConstruct<Element>
implements ExecutableElement, ModuleElement, PackageElement, RecordComponentElement, TypeElement, TypeParameterElement, VariableElement

An Element and UniversalConstruct implementation.

Author:

Laird Nelson

See Also:

• Element.getKind()
• UniversalConstruct

Nested Class Summary

Nested classes/interfaces inherited from interface javax.lang.model.element.ModuleElement

ModuleElement.Directive, ModuleElement.DirectiveKind, ModuleElement.DirectiveVisitor<R,P>, ModuleElement.ExportsDirective, ModuleElement.OpensDirective, ModuleElement.ProvidesDirective, ModuleElement.RequiresDirective, ModuleElement.UsesDirective

Constructor Summary

Constructors

Constructor	Description
UniversalElement(Element delegate, Domain domain)	Creates a new UniversalElement.

Method Summary

Modifier and Type	Method	Description
final <R, P> R	accept(ElementVisitor<R,P> v, P p)
final UniversalType	asType()
final boolean	equals(Object other)
final boolean	generic()	Returns true if and only if this UniversalElement is a generic class declaration.
final UniversalElement	getAccessor()
final List<? extends UniversalType>	getBounds()
final Object	getConstantValue()
final AnnotationValueRecord	getDefaultValue()
final List<? extends UniversalDirective>	getDirectives()
final List<? extends UniversalElement>	getEnclosedElements()
final UniversalElement	getEnclosingElement()
final UniversalElement	getGenericElement()
final List<? extends UniversalType>	getInterfaces()
final ElementKind	getKind()
final Set<Modifier>	getModifiers()
final NestingKind	getNestingKind()
final List<? extends UniversalElement>	getParameters()
final StringName	getQualifiedName()
final UniversalType	getReceiverType()
final List<? extends UniversalElement>	getRecordComponents()
final UniversalType	getReturnType()
final StringName	getSimpleName()
final UniversalType	getSuperclass()
final List<? extends UniversalType>	getThrownTypes()
final List<? extends UniversalElement>	getTypeParameters()
final int	hashCode()
final boolean	isDefault()
final boolean	isOpen()
final boolean	isUnnamed()
final boolean	isVarArgs()
final boolean	javaLangObject()	A convenience method that returns true if this UniversalElement is the class declaration for java.lang.Object.
static final List<? extends UniversalElement>	of(Collection<? extends Element> es, Domain domain)	Returns a non-null, immutable List of UniversalElements whose elements wrap the supplied List's elements.
static final UniversalElement	of(Element e, Domain domain)	Returns a UniversalElement that is either the supplied Element (if it itself is null or is a UniversalElement) or one that wraps it.

Methods inherited from class org.microbean.construct.UniversalConstruct

delegate, describeConstable, domain, getAnnotation, getAnnotationMirrors, getAnnotationsByType, toString, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.lang.model.element.Element

getAnnotation, getAnnotationMirrors, getAnnotationsByType

Methods inherited from interface javax.lang.model.element.TypeElement

getPermittedSubclasses

Constructor Details

UniversalElement

public UniversalElement(Element delegate,
 Domain domain)

Creates a new UniversalElement.

Parameters:

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

domain - a 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.delegate()

Method Details

accept

public final <R,
P> R accept(ElementVisitor<R,P> v,
 P p)

Specified by:

accept in interface Element

asType

public final UniversalType asType()

Specified by:

asType in interface Element

Specified by:

asType in interface ExecutableElement

Specified by:

asType in interface ModuleElement

Specified by:

asType in interface PackageElement

Specified by:

asType in interface RecordComponentElement

Specified by:

asType in interface TypeElement

Specified by:

asType in interface TypeParameterElement

Specified by:

asType in interface VariableElement

equals

public final boolean equals(Object other)

Specified by:

equals in interface Element

Overrides:

equals in class Object

generic

public final boolean generic()

Returns true if and only if this UniversalElement is a generic class declaration.

Returns:

true if and only if this UniversalElement is a generic class declaration

External Specifications

• Java Language Specification, section 8.1.2

getAccessor

public final UniversalElement getAccessor()

Specified by:

getAccessor in interface RecordComponentElement

getBounds

public final List<? extends UniversalType> getBounds()

Specified by:

getBounds in interface TypeParameterElement

getConstantValue

public final Object getConstantValue()

Specified by:

getConstantValue in interface VariableElement

getDefaultValue

public final AnnotationValueRecord getDefaultValue()

Specified by:

getDefaultValue in interface ExecutableElement

getDirectives

public final List<? extends UniversalDirective> getDirectives()

Specified by:

getDirectives in interface ModuleElement

getEnclosedElements

public final List<? extends UniversalElement> getEnclosedElements()

Specified by:

getEnclosedElements in interface Element

Specified by:

getEnclosedElements in interface ModuleElement

Specified by:

getEnclosedElements in interface PackageElement

Specified by:

getEnclosedElements in interface TypeElement

getEnclosingElement

public final UniversalElement getEnclosingElement()

Specified by:

getEnclosingElement in interface Element

Specified by:

getEnclosingElement in interface ExecutableElement

Specified by:

getEnclosingElement in interface ModuleElement

Specified by:

getEnclosingElement in interface PackageElement

Specified by:

getEnclosingElement in interface RecordComponentElement

Specified by:

getEnclosingElement in interface TypeElement

Specified by:

getEnclosingElement in interface TypeParameterElement

Specified by:

getEnclosingElement in interface VariableElement

getGenericElement

public final UniversalElement getGenericElement()

Specified by:

getGenericElement in interface TypeParameterElement

getInterfaces

public final List<? extends UniversalType> getInterfaces()

Specified by:

getInterfaces in interface TypeElement

getKind

public final ElementKind getKind()

Specified by:

getKind in interface Element

getModifiers

public final Set<Modifier> getModifiers()

Specified by:

getModifiers in interface Element

getNestingKind

public final NestingKind getNestingKind()

Specified by:

getNestingKind in interface TypeElement

getParameters

public final List<? extends UniversalElement> getParameters()

Specified by:

getParameters in interface ExecutableElement

getQualifiedName

public final StringName getQualifiedName()

Specified by:

getQualifiedName in interface ModuleElement

Specified by:

getQualifiedName in interface PackageElement

Specified by:

getQualifiedName in interface QualifiedNameable

Specified by:

getQualifiedName in interface TypeElement

getReceiverType

public final UniversalType getReceiverType()

Specified by:

getReceiverType in interface ExecutableElement

getRecordComponents

public final List<? extends UniversalElement> getRecordComponents()

Specified by:

getRecordComponents in interface TypeElement

getReturnType

public final UniversalType getReturnType()

Specified by:

getReturnType in interface ExecutableElement

getSimpleName

public final StringName getSimpleName()

Specified by:

getSimpleName in interface Element

Specified by:

getSimpleName in interface ExecutableElement

Specified by:

getSimpleName in interface ModuleElement

Specified by:

getSimpleName in interface PackageElement

Specified by:

getSimpleName in interface RecordComponentElement

Specified by:

getSimpleName in interface TypeElement

Specified by:

getSimpleName in interface VariableElement

getSuperclass

public final UniversalType getSuperclass()

Specified by:

getSuperclass in interface TypeElement

getThrownTypes

public final List<? extends UniversalType> getThrownTypes()

Specified by:

getThrownTypes in interface ExecutableElement

getTypeParameters

public final List<? extends UniversalElement> getTypeParameters()

Specified by:

getTypeParameters in interface ExecutableElement

Specified by:

getTypeParameters in interface Parameterizable

Specified by:

getTypeParameters in interface TypeElement

hashCode

public final int hashCode()

Specified by:

hashCode in interface Element

Overrides:

hashCode in class Object

isDefault

public final boolean isDefault()

Specified by:

isDefault in interface ExecutableElement

isOpen

public final boolean isOpen()

Specified by:

isOpen in interface ModuleElement

isUnnamed

public final boolean isUnnamed()

Specified by:

isUnnamed in interface ModuleElement

Specified by:

isUnnamed in interface PackageElement

Specified by:

isUnnamed in interface VariableElement

isVarArgs

public final boolean isVarArgs()

Specified by:

isVarArgs in interface ExecutableElement

javaLangObject

public final boolean javaLangObject()

A convenience method that returns true if this UniversalElement is the class declaration for java.lang.Object.

Returns:

true if this UniversalElement is the class declaration for java.lang.Object

of

public static final List<? extends UniversalElement> of(Collection<? extends Element> es,
 Domain domain)

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

Parameters:

es - a Collection of Elements; must not be null

domain - a Domain; must not be null

Returns:

a non-null, immutable List of UniversalElements

Throws:

NullPointerException - if either argument is null

of

public static final UniversalElement of(Element e,
 Domain domain)

Returns a UniversalElement that is either the supplied Element (if it itself is null or is a UniversalElement) or one that wraps it.

Parameters:

e - an Element; may be null in which case null will be returned

domain - a Domain; must not be null

Returns:

a UniversalElement, or null (if e is null)

Throws:

NullPointerException - if domain is null

See Also:

• UniversalElement(Element, Domain)