Class DefaultDomain

java.lang.Object

org.microbean.construct.DefaultDomain

All Implemented Interfaces:

Constable, Domain

public class DefaultDomain
extends Object
implements Constable, Domain

A domain of Java constructs that can be used at annotation processing time or at runtime.

Author:

Laird Nelson

See Also:

• Domain
• RuntimeProcessingEnvironmentSupplier

Constructor Summary

Constructors

Constructor	Description
DefaultDomain()	Creates a new DefaultDomain for use at runtime.
DefaultDomain(Lock lock)	Creates a new DefaultDomain for use at runtime.
DefaultDomain(ProcessingEnvironment pe)	Creates a new DefaultDomain whose usage type is determined by the argument supplied to this constructor.
DefaultDomain(ProcessingEnvironment pe, Lock lock)	Creates a new DefaultDomain whose usage type is determined by the arguments supplied to this constructor.

Method Summary

Modifier and Type	Method	Description
UniversalType	arrayTypeOf(TypeMirror t)	Returns a UniversalType representing an ArrayType whose component type is the same as the supplied TypeMirror.
UniversalType	asMemberOf(DeclaredType containingType, Element e)	Returns a non-null TypeMirror representing the type of the supplied Element when that Element is viewed as a member of, or otherwise directly contained by, the supplied containingType.
boolean	assignable(TypeMirror payload, TypeMirror receiver)	Returns true if and only if the supplied payload (the first argument) is considered assignable to the supplied receiver (the second argument) according to the rules of the Java Language Specification.
StringName	binaryName(TypeElement e)	Returns the (non-null) binary name of the supplied TypeElement.
UniversalType	capture(TypeMirror t)	Applies capture conversion to the supplied TypeMirror, which is normally a wildcard type.
boolean	contains(TypeMirror t0, TypeMirror t1)	Returns true if and only if candidateContainer contains candidate, according to the Java Language Specification, section 4.5.1.
UniversalType	declaredType(CharSequence canonicalName)	A convenience method that returns the DeclaredType of a TypeElement that bears the supplied canonicalName, or null if there is no such TypeElement (and therefore no such DeclaredType).
UniversalType	declaredType(TypeElement typeElement, TypeMirror... typeArguments)	Returns the DeclaredType of the supplied TypeElement with the supplied TypeMirror arguments (if any), yielding a parameterized type.
UniversalType	declaredType(DeclaredType enclosingType, TypeElement typeElement, TypeMirror... typeArguments)	Returns the DeclaredType of the supplied TypeElement with the supplied TypeMirror arguments (if any), given a containing DeclaredType of which it is a member, yielding a parameterized type.
Optional<? extends ConstantDesc>	describeConstable()
List<? extends UniversalType>	directSupertypes(TypeMirror t)	Returns a non-null List of the direct supertypes of the supplied TypeMirror, which is normally a declared type.
UniversalElement	element(TypeMirror t)	Returns the Element responsible for declaring the supplied TypeMirror, which is most commonly a DeclaredType, a TypeVariable, a NoType with a TypeKind of TypeKind.MODULE, or a NoType with a TypeKind of TypeKind.PACKAGE, or null if there is no such Element.
UniversalType	elementType(TypeMirror t)	A convenience method that returns the element type of the supplied TypeMirror.
boolean	equals(Object other)
UniversalType	erasure(TypeMirror t)	Returns the erasure of the supplied TypeMirror.
UniversalElement	executableElement(TypeElement declaringElement, TypeMirror returnType, CharSequence name, TypeMirror... parameterTypes)	A convenience method that returns an ExecutableElement representing the static initializer, constructor or method described by the supplied arguments, or null if no such ExecutableElement exists.
int	hashCode()
UniversalElement	javaLangObject()	A convenience method that returns the TypeElement representing the class named java.lang.Object.
final Unlockable	lock()	Returns a non-null Unlockable that should be used in a try-with-resources block guarding operations that might cause symbol completion.
UniversalElement	moduleElement(CharSequence canonicalName)	Returns a ModuleElement representing the module named by the supplied qualifiedName, or null if there is no such ModuleElement.
StringName	name(CharSequence name)	Returns a Name representing the supplied CharSequence.
UniversalType	noType(TypeKind kind)	Returns a NoType bearing the supplied TypeKind, if the supplied TypeKind is either TypeKind.NONE or TypeKind.VOID.
UniversalType	nullType()	Returns a NullType implementation whose TypeKind is TypeKind.NULL.
UniversalElement	packageElement(CharSequence canonicalName)	Returns a PackageElement representing the package bearing the supplied canonicalName, or null if there is no such PackageElement.
UniversalElement	packageElement(ModuleElement asSeenFrom, CharSequence canonicalName)	Returns a PackageElement representing the package bearing the supplied canonicalName as seen from the module represented by the supplied ModuleElement, or null if there is no such PackageElement.
UniversalType	primitiveType(CharSequence canonicalName)	Returns the result of applying unboxing conversion to the (logical) TypeElement bearing the supplied canonicalName.
UniversalType	primitiveType(TypeElement e)	Returns the result of applying unboxing conversion to the type declared by the supplied TypeElement.
UniversalType	primitiveType(TypeKind kind)	Returns the PrimitiveType corresponding to the supplied TypeKind (if it is primitive).
UniversalType	primitiveType(TypeMirror t)	Returns the result of applying unboxing conversion to the supplied TypeMirror.
UniversalType	rawType(TypeMirror t)	A convenience method that returns the raw type corresponding to t, or null if t is incapable of yielding a raw type.
UniversalElement	recordComponentElement(ExecutableElement e)	Returns a RecordComponentElement corresponding to the supplied ExecutableElement, or null if there is no such RecordComponentElement.
boolean	sameType(TypeMirror t0, TypeMirror t1)	Returns true if and only if the two arguments represent the same type.
boolean	subsignature(ExecutableType t0, ExecutableType t1)	Returns true if and only if et0 is a subsignature of et1.
boolean	subtype(TypeMirror candidateSubtype, TypeMirror candidateSupertype)	Returns true if and only if candidateSubtype is a subtype of supertype.
String	toString(CharSequence name)	Converts the supplied CharSequence, which is often a Name, into a String, and returns the conversion, locking when appropriate to serialize symbol completion.
UniversalElement	typeElement(CharSequence canonicalName)	Returns a TypeElement representing the element bearing the supplied canonical name, or null if there is no such TypeElement.
UniversalElement	typeElement(ModuleElement asSeenFrom, CharSequence canonicalName)	Returns a TypeElement representing the element bearing the supplied canonical name, as read or seen from the module represented by the supplied ModuleElement, or null if there is no such TypeElement.
UniversalElement	typeElement(PrimitiveType t)	Returns a TypeElement representing the result of applying boxing conversion to the primitive type represented by the supplied PrimitiveType argument.
UniversalElement	typeElement(TypeKind primitiveTypeKind)	Returns a TypeElement representing the result of applying boxing conversion to the primitive type represented by the supplied TypeKind argument, if it is primitive.
UniversalElement	typeParameterElement(Parameterizable p, CharSequence name)	Returns the TypeParameterElement contained by the supplied Parameterizable whose name is equal to the supplied name, or null if there is no such TypeParameterElement.
UniversalType	typeVariable(Parameterizable p, CharSequence name)	A convenience method that returns the TypeVariable declared by the TypeParameterElement contained by the supplied Parameterizable whose name is equal to the supplied name, or null if there is no such TypeParameterElement or TypeVariable.
UniversalElement	variableElement(Element e, CharSequence name)	A convenience method that returns the first VariableElement with a variable ElementKind and bearing the supplied simpleName that the supplied enclosingElement encloses, or null if there is no such VariableElement.
UniversalType	wildcardType()	A convenience method that returns a new WildcardType with a TypeKind of TypeKind.WILDCARD, an extends bound of null, and a super bound of null.
UniversalType	wildcardType(TypeMirror extendsBound, TypeMirror superBound)	Returns a new WildcardType with a TypeKind of TypeKind.WILDCARD, an extends bound of the supplied extendsBound, and a super bound of the supplied superBound.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.microbean.construct.Domain

generic, generic, javaLangObject, javaLangObject, parameterized, raw

Constructor Details

DefaultDomain

public DefaultDomain()

Creates a new DefaultDomain for use at runtime.

See Also:

• DefaultDomain(ProcessingEnvironment, Lock)

DefaultDomain

public DefaultDomain(ProcessingEnvironment pe)

Creates a new DefaultDomain whose usage type is determined by the argument supplied to this constructor.

Parameters:

pe - a ProcessingEnvironment; may be null in which case the return value of an invocation of Supplier.get() on the return value of an invocation of RuntimeProcessingEnvironmentSupplier.of() will be used instead

See Also:

• DefaultDomain(ProcessingEnvironment, Lock)
• SymbolCompletionLock

DefaultDomain

public DefaultDomain(Lock lock)

Creates a new DefaultDomain for use at runtime.

Parameters:

lock - a Lock to use to serialize symbol completion; may be null in which case a global ReentrantLock will be used instead

See Also:

• DefaultDomain(ProcessingEnvironment, Lock)
• RuntimeProcessingEnvironmentSupplier
• SymbolCompletionLock

DefaultDomain

public DefaultDomain(ProcessingEnvironment pe,
 Lock lock)

Creates a new DefaultDomain whose usage type is determined by the arguments supplied to this constructor.

Parameters:

pe - a ProcessingEnvironment; may be null in which case the return value of an invocation of Supplier.get() on the return value of an invocation of RuntimeProcessingEnvironmentSupplier.of() will be used instead

lock - a Lock to use to serialize symbol completion; if null and pe is null, then a global ReentrantLock will be used instead; if null and pe is non-null, then no serialization of symbol completion will occur and this DefaultDomain will not be safe for concurrent use by multiple threads

See Also:

• RuntimeProcessingEnvironmentSupplier
• SymbolCompletionLock

Method Details

arrayTypeOf

public UniversalType arrayTypeOf(TypeMirror t)

Returns a UniversalType representing an ArrayType whose component type is the same as the supplied TypeMirror.

Specified by:

arrayTypeOf in interface Domain

Parameters:

t - a TypeMirror representing a component type; must not be null

Returns:

a non-null UniversalType

Throws:

NullPointerException - if t is null

IllegalArgumentException - if t is unsuitable for use as a component type

See Also:

• Types.getArrayType(TypeMirror)

asMemberOf

public UniversalType asMemberOf(DeclaredType containingType,
 Element e)

Description copied from interface: Domain

Returns a non-null TypeMirror representing the type of the supplied Element when that Element is viewed as a member of, or otherwise directly contained by, the supplied containingType.

For example, when viewed as a member of the parameterized type Set<String>, the Set.add(Object) method (represented as an ExecutableElement) has a type whose method parameter is of type String (not String's erasure).

Specified by:

asMemberOf in interface Domain

Parameters:

containingType - the containing DeclaredType; must not be null

e - the member Element; must not be null

Returns:

a non-null type representing the type of the supplied Element when viewed as a member of the supplied containingType; never null

See Also:

• Types.asMemberOf(DeclaredType, Element)

assignable

public boolean assignable(TypeMirror payload,
 TypeMirror receiver)

Description copied from interface: Domain

Returns true if and only if the supplied payload (the first argument) is considered assignable to the supplied receiver (the second argument) according to the rules of the Java Language Specification.

Specified by:

assignable in interface Domain

Parameters:

payload - the TypeMirror being assigned; must not be null

receiver - the TypeMirror receiving the assignment; must not be null

Returns:

true if and only if payload is assignable to receiver

See Also:

• Types.isAssignable(TypeMirror, TypeMirror)

External Specifications

• Java Language Specification, section 5.2

binaryName

public StringName binaryName(TypeElement e)

Description copied from interface: Domain

Returns the (non-null) binary name of the supplied TypeElement.

Specified by:

binaryName in interface Domain

Parameters:

e - a TypeElement; must not be null

Returns:

a non-null Name

See Also:

• Elements.getBinaryName(TypeElement)

External Specifications

• Java Language Specification, section 13.1

capture

public UniversalType capture(TypeMirror t)

Description copied from interface: Domain

Applies capture conversion to the supplied TypeMirror, which is normally a wildcard type.

Specified by:

capture in interface Domain

Parameters:

t - a TypeMirror; must not be null; if not a wildcard type, then it will be returned unchanged

Returns:

a non-null TypeMirror representing the result of capture conversion applied to the supplied TypeMirror

See Also:

• Types.capture(TypeMirror)

External Specifications

• Java Language Specification, section 5.1.10

contains

public boolean contains(TypeMirror t0,
 TypeMirror t1)

Description copied from interface: Domain

Returns true if and only if candidateContainer contains candidate, according to the Java Language Specification, section 4.5.1.

Specified by:

contains in interface Domain

Parameters:

t0 - the putative containing type; normally a wildcard type; must not be null

t1 - the putative contained type; must not be null

Returns:

true if and only if candidateContainer contains candidate, according to the Java Language Specification, section 4.5.1; false otherwise

External Specifications

• Java Language Specification, section 4.5.1

declaredType

public UniversalType declaredType(CharSequence canonicalName)

Description copied from interface: Domain

A convenience method that returns the DeclaredType of a TypeElement that bears the supplied canonicalName, or null if there is no such TypeElement (and therefore no such DeclaredType).

Specified by:

declaredType in interface Domain

Parameters:

canonicalName - a valid canonical name; must not be null

Returns:

a DeclaredType with a TypeKind of TypeKind.DECLARED, or null

See Also:

• Domain.typeElement(CharSequence)
• Domain.declaredType(TypeElement, TypeMirror...)

External Specifications

• Java Language Specification, section 6.7

declaredType

public UniversalType declaredType(TypeElement typeElement,
 TypeMirror... typeArguments)

Description copied from interface: Domain

Returns the DeclaredType of the supplied TypeElement with the supplied TypeMirror arguments (if any), yielding a parameterized type.

Given a TypeElement representing the class named java.util.Set and a TypeMirror representing the type declared by java.lang.String, for example, this method will return a DeclaredType representing the parameterized type corresponding to java.util.Set<java.lang.String>.

The number of supplied type arguments must either equal the number of the supplied TypeElement's formal type parameters, or must be zero. If it is zero, and if the supplied TypeElement is generic, then the supplied TypeElement's raw type is returned.

If a parameterized type is returned, its TypeElement must not be contained within a generic outer class. The parameterized type Outer<String>.Inner<Number>, for example, may be constructed by first using this method to get the type Outer<String>, and then invoking Domain.declaredType(DeclaredType, TypeElement, TypeMirror...).

Specified by:

declaredType in interface Domain

Parameters:

typeElement - a TypeElement; must not be null

typeArguments - any type arguments (represented by TypeMirrors); must not be null

Returns:

a non-null DeclaredType with a TypeKind of TypeKind.DECLARED

See Also:

• Types.getDeclaredType(TypeElement, TypeMirror...)

External Specifications

• Java Language Specification, section 4.5

declaredType

public UniversalType declaredType(DeclaredType enclosingType,
 TypeElement typeElement,
 TypeMirror... typeArguments)

Description copied from interface: Domain

Returns the DeclaredType of the supplied TypeElement with the supplied TypeMirror arguments (if any), given a containing DeclaredType of which it is a member, yielding a parameterized type.

Given a DeclaredType representing the parameterized type corresponding to Outer<String> (see the Domain.declaredType(TypeElement, TypeMirror...) method), a TypeElement representing the class named Outer.Inner and a DeclaredType representing the non-generic class corresponding to Number, for example, this method will return a DeclaredType representing the parameterized type corresponding to Outer<String>.Inner<Number>.

The number of supplied type arguments must either equal the number of the supplied TypeElement's formal type parameters, or must be zero. If it is zero, and if the supplied TypeElement is generic, then the supplied TypeElement's raw type is returned.

Specified by:

declaredType in interface Domain

Parameters:

enclosingType - a DeclaredType representing the containing type; must not be null

typeElement - a TypeElement; must not be null

typeArguments - any type arguments (represented by TypeMirrors); must not be null

Returns:

a non-null DeclaredType with a TypeKind of TypeKind.DECLARED

See Also:

• Domain.declaredType(TypeElement, TypeMirror...)
• Types.getDeclaredType(DeclaredType, TypeElement, TypeMirror...)

External Specifications

• Java Language Specification, section 4.5

describeConstable

public Optional<? extends ConstantDesc> describeConstable()

Specified by:

describeConstable in interface Constable

directSupertypes

public List<? extends UniversalType> directSupertypes(TypeMirror t)

Description copied from interface: Domain

Returns a non-null List of the direct supertypes of the supplied TypeMirror, which is normally a declared type.

Specified by:

directSupertypes in interface Domain

Parameters:

t - a TypeMirror; must not be null; must not be an executable type, a module type, or a package type

Returns:

a non-null, immutable List of TypeMirrors representing the direct supertypes

See Also:

• Types.directSupertypes(TypeMirror)

External Specifications

• Java Language Specification, section 4.10

element

public UniversalElement element(TypeMirror t)

Description copied from interface: Domain

Returns the Element responsible for declaring the supplied TypeMirror, which is most commonly a DeclaredType, a TypeVariable, a NoType with a TypeKind of TypeKind.MODULE, or a NoType with a TypeKind of TypeKind.PACKAGE, or null if there is no such Element.

Specified by:

element in interface Domain

Parameters:

t - a TypeMirror; must not be null

Returns:

an Element, or null

See Also:

• Types.asElement(TypeMirror)

elementType

public UniversalType elementType(TypeMirror t)

Description copied from interface: Domain

A convenience method that returns the element type of the supplied TypeMirror.

The element type of an array type is the element type of its component type.

.

The element type of every other kind of type is the type itself. Note that the semantics of the prior sentence diverge deliberately, primarily for convenience, from those of the relevant section in the Java Language Specification.

Specified by:

elementType in interface Domain

Parameters:

t - a TypeMirror; must not be null

Returns:

the element type of the supplied TypeMirror; never null

External Specifications

• Java Language Specification, section 10.1

equals

public boolean equals(Object other)

Overrides:

equals in class Object

erasure

public UniversalType erasure(TypeMirror t)

Description copied from interface: Domain

Returns the erasure of the supplied TypeMirror.

Specified by:

erasure in interface Domain

Parameters:

t - the TypeMirror representing the type whose erasure should be returned; must not be null

Returns:

the erasure of the supplied TypeMirror; never null

See Also:

• Types.erasure(TypeMirror)

External Specifications

• Java Language Specification, section 4.6

executableElement

public UniversalElement executableElement(TypeElement declaringElement,
 TypeMirror returnType,
 CharSequence name,
 TypeMirror... parameterTypes)

Description copied from interface: Domain

A convenience method that returns an ExecutableElement representing the static initializer, constructor or method described by the supplied arguments, or null if no such ExecutableElement exists.

Specified by:

executableElement in interface Domain

Parameters:

declaringElement - a TypeElement representing the class that declares the executable; must not be null

returnType - the return type of the executable; must not be null

name - the name of the executable; must not be null

parameterTypes - TypeMirrors that represent the executable's parameter types

Returns:

an ExecutableElement with an ElementKind of ElementKind.CONSTRUCTOR, ElementKind.METHOD, or ElementKind.STATIC_INIT, or null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

javaLangObject

public UniversalElement javaLangObject()

Description copied from interface: Domain

A convenience method that returns the TypeElement representing the class named java.lang.Object.

Specified by:

javaLangObject in interface Domain

Returns:

a non-null TypeElement whose qualified name is equal to java.lang.Object

See Also:

• Domain.typeElement(CharSequence)

lock

public final Unlockable lock()

Returns a non-null Unlockable that should be used in a try-with-resources block guarding operations that might cause symbol completion.

Specified by:

lock in interface Domain

Returns:

a non-null Unlockable

See Also:

• Unlockable.close()

moduleElement

public UniversalElement moduleElement(CharSequence canonicalName)

Description copied from interface: Domain

Returns a ModuleElement representing the module named by the supplied qualifiedName, or null if there is no such ModuleElement.

Specified by:

moduleElement in interface Domain

Parameters:

canonicalName - a name suitable for naming a module; must not be null; may be empty, in which case a ModuleElement representing an unnamed module will be returned

Returns:

a ModuleElement, or null

See Also:

• Elements.getModuleElement(CharSequence)

External Specifications

• Java Language Specification, section 7.7

name

public StringName name(CharSequence name)

Description copied from interface: Domain

Returns a Name representing the supplied CharSequence.

Specified by:

name in interface Domain

Parameters:

name - a CharSequence; must not be null

Returns:

a non-null Name representing the supplied Domain.name(java.lang.CharSequence)

See Also:

• Domain.lock()
• Elements.getName(CharSequence)

noType

public UniversalType noType(TypeKind kind)

Description copied from interface: Domain

Returns a NoType bearing the supplied TypeKind, if the supplied TypeKind is either TypeKind.NONE or TypeKind.VOID.

Specified by:

noType in interface Domain

Parameters:

kind - a TypeKind; must be either TypeKind.NONE or TypeKind.VOID

Returns:

a non-null NoType bearing the supplied TypeKind

See Also:

• TypeKind.NONE
• TypeKind.VOID
• Types.getNoType(TypeKind)

External Specifications

• Java Language Specification, section 8.4.5

nullType

public UniversalType nullType()

Description copied from interface: Domain

Returns a NullType implementation whose TypeKind is TypeKind.NULL.

Specified by:

nullType in interface Domain

Returns:

a non-null NullType

See Also:

• Types.getNullType()

External Specifications

• Java Language Specification, section 4.1

packageElement

public UniversalElement packageElement(CharSequence canonicalName)

Description copied from interface: Domain

Returns a PackageElement representing the package bearing the supplied canonicalName, or null if there is no such PackageElement.

Specified by:

packageElement in interface Domain

Parameters:

canonicalName - a canonical name suitable for naming a package; must not be null; may be empty, in which case a ModuleElement representing an unnamed package will be returned

Returns:

a PackageElement, or null

See Also:

• Elements.getPackageElement(CharSequence)

External Specifications

• Java Language Specification, section 6.7

packageElement

public UniversalElement packageElement(ModuleElement asSeenFrom,
 CharSequence canonicalName)

Description copied from interface: Domain

Returns a PackageElement representing the package bearing the supplied canonicalName as seen from the module represented by the supplied ModuleElement, or null if there is no such PackageElement.

Specified by:

packageElement in interface Domain

Parameters:

asSeenFrom - a ModuleElement; must not be null

canonicalName - a canonical name suitable for naming a package; must not be null; may be empty, in which case a ModuleElement representing an unnamed package will be returned

Returns:

a PackageElement, or null

See Also:

• Elements.getPackageElement(ModuleElement, CharSequence)

External Specifications

• Java Language Specification, section 6.7

primitiveType

public UniversalType primitiveType(TypeKind kind)

Description copied from interface: Domain

Returns the PrimitiveType corresponding to the supplied TypeKind (if it is primitive).

Specified by:

primitiveType in interface Domain

Parameters:

kind - a primitive TypeKind; must not be null

Returns:

a non-null PrimitiveType with a primitive TypeKind

See Also:

• Types.getPrimitiveType(TypeKind)

External Specifications

• Java Language Specification, section 4.2

primitiveType

public UniversalType primitiveType(CharSequence canonicalName)

Description copied from interface: Domain

Returns the result of applying unboxing conversion to the (logical) TypeElement bearing the supplied canonicalName.

Specified by:

primitiveType in interface Domain

Parameters:

canonicalName - a canonical name of either a primitive type or a so-called "wrapper" type; must not be null

Returns:

a non-null PrimitiveType with a primitive TypeKind

See Also:

• Domain.primitiveType(TypeKind)

External Specifications

• Java Language Specification, section 5.1.8
• Java Language Specification, section 6.7

primitiveType

public UniversalType primitiveType(TypeElement e)

Description copied from interface: Domain

Returns the result of applying unboxing conversion to the type declared by the supplied TypeElement.

Specified by:

primitiveType in interface Domain

Parameters:

e - a TypeElement; must not be null

Returns:

a non-null PrimitiveType with a primitive TypeKind

See Also:

• Types.unboxedType(TypeMirror)
• Domain.primitiveType(TypeMirror)

External Specifications

• Java Language Specification, section 5.1.8

primitiveType

public UniversalType primitiveType(TypeMirror t)

Description copied from interface: Domain

Returns the result of applying unboxing conversion to the supplied TypeMirror.

Specified by:

primitiveType in interface Domain

Parameters:

t - a TypeMirror; must not be null

Returns:

a non-null PrimitiveType with a primitive TypeKind

See Also:

• Types.unboxedType(TypeMirror)

External Specifications

• Java Language Specification, section 5.1.8

rawType

public UniversalType rawType(TypeMirror t)

Description copied from interface: Domain

A convenience method that returns the raw type corresponding to t, or null if t is incapable of yielding a raw type.

Overrides of this method must conform to the requirements imposed by the relevant section of the relevant version of the Java Language Specification concerning raw types.

Specified by:

rawType in interface Domain

Parameters:

t - a TypeMirror; must not be null

Returns:

the raw type corresponding to the supplied TypeMirror, or null if t is incapable of yielding a raw type

External Specifications

• Java Language Specification, section 4.8

recordComponentElement

public UniversalElement recordComponentElement(ExecutableElement e)

Description copied from interface: Domain

Returns a RecordComponentElement corresponding to the supplied ExecutableElement, or null if there is no such RecordComponentElement.

Specified by:

recordComponentElement in interface Domain

Parameters:

e - an ExecutableElement enclosed by a record representing an accessor method; must not be null

Returns:

a RecordComponentElement corresponding to the supplied ExecutableElement, or null

External Specifications

• Java Language Specification, section 8.10.3

sameType

public boolean sameType(TypeMirror t0,
 TypeMirror t1)

Description copied from interface: Domain

Returns true if and only if the two arguments represent the same type.

This method differs from the Types.isSameType(TypeMirror, TypeMirror) method in two ways:

• Its arguments may be null. If both arguments are null, true is returned. If only one argument is null, false is returned.
• If the same Java object reference is passed as both arguments, true is returned (even if it has a TypeKind of TypeKind.WILDCARD).

Specified by:

sameType in interface Domain

Parameters:

t0 - the first TypeMirror; may be null

t1 - the second TypeMirror; may be null

Returns:

true if and only if the two arguments represent the same type; false otherwise

See Also:

• Types.isSameType(TypeMirror, TypeMirror)

External Specifications

• Java Language Specification, section 4.3.4
• Java Language Specification, section 4.5.1

subsignature

public boolean subsignature(ExecutableType t0,
 ExecutableType t1)

Description copied from interface: Domain

Returns true if and only if et0 is a subsignature of et1.

Specified by:

subsignature in interface Domain

Parameters:

t0 - the first ExecutableType; must not be null

t1 - the second ExecutableType; must not be null

Returns:

true if and only if et0 is a subsignature of et1

See Also:

• Types.isSubsignature(ExecutableType, ExecutableType)

External Specifications

• Java Language Specification, section 8.4.2

subtype

public boolean subtype(TypeMirror candidateSubtype,
 TypeMirror candidateSupertype)

Description copied from interface: Domain

Returns true if and only if candidateSubtype is a subtype of supertype.

Specified by:

subtype in interface Domain

Parameters:

candidateSubtype - the first TypeMirror; must not be null

candidateSupertype - the second TypeMirror; must not be null

Returns:

true if and only if candidateSubtype is a subtype of supertype

See Also:

• Types.isSubtype(TypeMirror, TypeMirror)

External Specifications

• Java Language Specification, section 4.10

toString

public String toString(CharSequence name)

Description copied from interface: Domain

Converts the supplied CharSequence, which is often a Name, into a String, and returns the conversion, locking when appropriate to serialize symbol completion.

Specified by:

toString in interface Domain

Parameters:

name - the CharSequence to convert; may be null in which case null will be returned

Returns:

a String, or null if name was null

See Also:

• Domain.lock()

typeElement

public UniversalElement typeElement(CharSequence canonicalName)

Description copied from interface: Domain

Returns a TypeElement representing the element bearing the supplied canonical name, or null if there is no such TypeElement.

Specified by:

typeElement in interface Domain

Parameters:

canonicalName - a valid canonical name; must not be null

Returns:

a TypeElement, or null

See Also:

• Elements.getTypeElement(CharSequence)

External Specifications

• Java Language Specification, section 6.7

typeElement

public UniversalElement typeElement(ModuleElement asSeenFrom,
 CharSequence canonicalName)

Description copied from interface: Domain

Returns a TypeElement representing the element bearing the supplied canonical name, as read or seen from the module represented by the supplied ModuleElement, or null if there is no such TypeElement.

Specified by:

typeElement in interface Domain

Parameters:

asSeenFrom - a ModuleElement; must not be null

canonicalName - a valid canonical name; must not be null

Returns:

a TypeElement, or null

See Also:

• Elements.getTypeElement(ModuleElement, CharSequence)

External Specifications

• Java Language Specification, section 6.7

typeElement

public UniversalElement typeElement(PrimitiveType t)

Description copied from interface: Domain

Returns a TypeElement representing the result of applying boxing conversion to the primitive type represented by the supplied PrimitiveType argument.

The default implementation of this method calls the Domain.typeElement(TypeKind) method with the supplied PrimitiveType's affiliated TypeKind and returns its result.

Specified by:

typeElement in interface Domain

Parameters:

t - a PrimitiveType with a TypeKind that is primitive; must not be null

Returns:

a non-null TypeElement representing the result of applying boxing conversion to the supplied argument

See Also:

• Domain.typeElement(TypeKind)
• Types.boxedClass(PrimitiveType)

External Specifications

• Java Language Specification, section 5.1.7

typeElement

public UniversalElement typeElement(TypeKind primitiveTypeKind)

Description copied from interface: Domain

Returns a TypeElement representing the result of applying boxing conversion to the primitive type represented by the supplied TypeKind argument, if it is primitive.

Specified by:

typeElement in interface Domain

Parameters:

primitiveTypeKind - a TypeKind that is primitive; must not be null

Returns:

a non-null TypeElement representing the result of applying boxing conversion to the supplied argument

See Also:

• Domain.typeElement(PrimitiveType)
• Types.boxedClass(PrimitiveType)

External Specifications

• Java Language Specification, section 5.1.7

typeParameterElement

public UniversalElement typeParameterElement(Parameterizable p,
 CharSequence name)

Description copied from interface: Domain

Returns the TypeParameterElement contained by the supplied Parameterizable whose name is equal to the supplied name, or null if there is no such TypeParameterElement.

Specified by:

typeParameterElement in interface Domain

Parameters:

p - a Parameterizable; must not be null

name - a name valid for a type parameter; must not be null

Returns:

a TypeParameterElement, or null

typeVariable

public UniversalType typeVariable(Parameterizable p,
 CharSequence name)

Description copied from interface: Domain

A convenience method that returns the TypeVariable declared by the TypeParameterElement contained by the supplied Parameterizable whose name is equal to the supplied name, or null if there is no such TypeParameterElement or TypeVariable.

Specified by:

typeVariable in interface Domain

Parameters:

p - a Parameterizable; must not be null

name - a name valid for a type parameter; must not be null

Returns:

a TypeVariable, or null

See Also:

• Domain.typeParameterElement(Parameterizable, CharSequence)

variableElement

public UniversalElement variableElement(Element e,
 CharSequence name)

Description copied from interface: Domain

A convenience method that returns the first VariableElement with a variable ElementKind and bearing the supplied simpleName that the supplied enclosingElement encloses, or null if there is no such VariableElement.

Specified by:

variableElement in interface Domain

Parameters:

e - an Element; must not be null

name - a CharSequence; must not be null

Returns:

a VariableElement, or null

See Also:

• Element.getEnclosedElements()
• ElementKind.isVariable()
• Element.getSimpleName()
• VariableElement

wildcardType

public UniversalType wildcardType()

Description copied from interface: Domain

A convenience method that returns a new WildcardType with a TypeKind of TypeKind.WILDCARD, an extends bound of null, and a super bound of null.

Specified by:

wildcardType in interface Domain

Returns:

a new, non-null WildcardType

See Also:

• Domain.wildcardType(TypeMirror, TypeMirror)
• Types.getWildcardType(TypeMirror, TypeMirror)

External Specifications

• Java Language Specification, section 4.5.1

wildcardType

public UniversalType wildcardType(TypeMirror extendsBound,
 TypeMirror superBound)

Description copied from interface: Domain

Returns a new WildcardType with a TypeKind of TypeKind.WILDCARD, an extends bound of the supplied extendsBound, and a super bound of the supplied superBound.

Any argument may be null. Both arguments may not be non-null.

Specified by:

wildcardType in interface Domain

Parameters:

extendsBound - the upper bound of the new WildcardType; may be null

superBound - the lower bound of the new WildcardType; may be null

Returns:

a new, non-null WildcardType

See Also:

• Types.getWildcardType(TypeMirror, TypeMirror)

External Specifications

• Java Language Specification, section 4.5.1