Interface Domain

All Known Implementing Classes:

DefaultDomain

public interface Domain

A representation of a domain of valid Java constructs.

A domain is a set of valid Java constructs. A Domain provides access to a domain and its members.

A Java construct is either a type or an element.

A type is a usage of a Java type, most commonly represented as a TypeMirror.

An element ia a declaration of a Java program element, most commonly represented as an Element.

Domains impose constraints on the types and elements they contain, and on the kinds and semantics of operations that can be performed on them.

This interface is modeled on a deliberately restricted combination of the Elements and Types interfaces.

Domain implementations must be thread-safe.

Author:

Laird Nelson

Method Summary

Modifier and Type	Method	Description
ArrayType	arrayTypeOf(TypeMirror componentType)	Returns an ArrayType whose component type is the same as the supplied componentType.
TypeMirror	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.
Name	binaryName(TypeElement e)	Returns the (non-null) binary name of the supplied TypeElement.
boolean	bridge(ExecutableElement e)	Returns true if and only if the supplied ExecutableElement represents a bridge method.
TypeMirror	capture(TypeMirror wildcard)	Applies capture conversion to the supplied TypeMirror, which is normally a wildcard type.
boolean	contains(TypeMirror candidateContainer, TypeMirror candidate)	Returns true if and only if candidateContainer contains candidate, according to the Java Language Specification, section 4.5.1.
default DeclaredType	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).
DeclaredType	declaredType(TypeElement typeElement, TypeMirror... typeArguments)	Returns the DeclaredType of the supplied TypeElement with the supplied TypeMirror arguments (if any), yielding a parameterized type.
DeclaredType	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.
List<? extends TypeMirror>	directSupertypes(TypeMirror t)	Returns a non-null List of the direct supertypes of the supplied TypeMirror, which is normally a declared type.
Element	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.
default TypeMirror	elementType(TypeMirror t)	A convenience method that returns the element type of the supplied TypeMirror.
<T extends TypeMirror> T	erasure(T t)	Returns the erasure of the supplied TypeMirror.
default ExecutableElement	executableElement(Executable e)	Returns an ExecutableElement corresponding to the supplied Executable.
default ExecutableElement	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.
default boolean	generic(Element e)	A convenience method that returns true if and only if the supplied Element is generic.
default boolean	generic(TypeMirror t)	A convenience method that returns true if and only if the supplied TypeMirror is declared by an Element that is generic.
default TypeElement	javaLangObject()	A convenience method that returns the TypeElement representing the class named java.lang.Object.
default boolean	javaLangObject(Element e)	A convenience method that returns true if and only if the supplied Element represents the (essentially primordial) java.lang.Object Element.
default boolean	javaLangObject(TypeMirror t)	A convenience method that returns true if and only if the supplied TypeMirror represents the DeclaredType declared by the (essentially primordial) java.lang.Object element.
Unlockable	lock()	Semantically locks an opaque lock used to serialize symbol completion, and returns it in the form of an Unlockable.
ModuleElement	moduleElement(CharSequence qualifiedName)	Returns a ModuleElement representing the module named by the supplied qualifiedName, or null if there is no such ModuleElement.
Name	name(CharSequence name)	Returns a Name representing the supplied CharSequence.
NoType	noType(TypeKind kind)	Returns a NoType bearing the supplied TypeKind, if the supplied TypeKind is either TypeKind.NONE or TypeKind.VOID.
NullType	nullType()	Returns a NullType implementation whose TypeKind is TypeKind.NULL.
Elements.Origin	origin(Element e)	Returns the origin of the supplied Element.
PackageElement	packageElement(CharSequence canonicalName)	Returns a PackageElement representing the package bearing the supplied canonicalName, or null if there is no such PackageElement.
PackageElement	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.
default Parameterizable	parameterizable(GenericDeclaration gd)	Returns a Parameterizable corresponding to the supplied (reflective) GenericDeclaration.
default boolean	parameterized(TypeMirror t)	A convenience method that returns true if and only if t is a DeclaredType, has a TypeKind of DECLARED, and has an empty type arguments list.
default PrimitiveType	primitiveType(CharSequence canonicalName)	Returns the result of applying unboxing conversion to the (logical) TypeElement bearing the supplied canonicalName.
default PrimitiveType	primitiveType(TypeElement e)	Returns the result of applying unboxing conversion to the type declared by the supplied TypeElement.
PrimitiveType	primitiveType(TypeKind kind)	Returns the PrimitiveType corresponding to the supplied TypeKind (if it is primitive).
PrimitiveType	primitiveType(TypeMirror t)	Returns the result of applying unboxing conversion to the supplied TypeMirror.
default boolean	raw(TypeMirror t)	A convenience method that returns true if and only if the supplied TypeMirror is a raw type according to the rules of the Java Language Specification
default TypeMirror	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.
RecordComponentElement	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 et0, ExecutableType et1)	Returns true if and only if et0 is a subsignature of et1.
boolean	subtype(TypeMirror candidateSubtype, TypeMirror supertype)	Returns true if and only if candidateSubtype is a subtype of supertype.
default 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.
default TypeMirror	type(Type t)	A convenience method that returns the TypeMirror corresponding to the supplied (reflective) Type.
TypeElement	typeElement(CharSequence canonicalName)	Returns a TypeElement representing the element bearing the supplied canonical name, or null if there is no such TypeElement.
TypeElement	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.
default TypeElement	typeElement(PrimitiveType t)	Returns a TypeElement representing the result of applying boxing conversion to the primitive type represented by the supplied PrimitiveType argument.
default TypeElement	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.
default TypeParameterElement	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.
default TypeMirror[]	types(Type[] ts)	A convenience method that returns an array of TypeMirrors whose elements correspond, in order, to the elements in the supplied Type array.
default TypeVariable	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.
default VariableElement	variableElement(Element enclosingElement, CharSequence simpleName)	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.
default WildcardType	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.
WildcardType	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.

Method Details

arrayTypeOf

ArrayType arrayTypeOf(TypeMirror componentType)

Returns an ArrayType whose component type is the same as the supplied componentType.

Parameters:

componentType - the component type; must not be null

Returns:

a non-null ArrayType whose component type is the same as the supplied componentType

Throws:

NullPointerException - if componentType is null

IllegalArgumentException - if componentType is not a valid component type

See Also:

• Types.getArrayType(TypeMirror)

asMemberOf

TypeMirror 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.

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

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

Throws:

NullPointerException - if either containingType or e is null

IllegalArgumentException - if e cannot be viewed as a member of the supplied containingType (because it is the wrong kind, for example)

See Also:

• Types.asMemberOf(DeclaredType, Element)

assignable

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.

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

Throws:

NullPointerException - if either payload or receiver is null

IllegalArgumentException - if either TypeMirror is not one that can take part in an assignment

See Also:

• Types.isAssignable(TypeMirror, TypeMirror)

External Specifications

• Java Language Specification, section 5.2

binaryName

Name binaryName(TypeElement e)

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

Parameters:

e - a TypeElement; must not be null

Returns:

a non-null Name

Throws:

NullPointerException - if e is null

See Also:

• Elements.getBinaryName(TypeElement)

External Specifications

• Java Language Specification, section 13.1

bridge

boolean bridge(ExecutableElement e)

Returns true if and only if the supplied ExecutableElement represents a bridge method.

Parameters:

e - an ExecutableElement; must not be null

Returns:

true if and only if the supplied ExecutableElement represents a bridge method

Throws:

NullPointerException - if e is null

See Also:

• Elements.isBridge(ExecutableElement)

External Specifications

• Java Language Specification, section 8.4.8.3
• Java Language Specification, section 15.12.4.5

capture

TypeMirror capture(TypeMirror wildcard)

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

Parameters:

wildcard - 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

Throws:

NullPointerException - if wildcard is null

See Also:

• Types.capture(TypeMirror)

External Specifications

• Java Language Specification, section 5.1.10

contains

boolean contains(TypeMirror candidateContainer,
 TypeMirror candidate)

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

Parameters:

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

candidate - 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

Throws:

NullPointerException - if either argument is null

IllegalArgumentException - if either argument is either an executable type, a module type, or a package type

External Specifications

• Java Language Specification, section 4.5.1

declaredType

default DeclaredType 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).

Parameters:

canonicalName - a valid canonical name; must not be null

Returns:

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

See Also:

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

External Specifications

• Java Language Specification, section 6.7

declaredType

DeclaredType declaredType(TypeElement typeElement,
 TypeMirror... typeArguments)

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 declaredType(DeclaredType, TypeElement, TypeMirror...).

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

Throws:

NullPointerException - if typeElement or typeArguments is null

See Also:

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

External Specifications

• Java Language Specification, section 4.5

declaredType

DeclaredType 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.

Given a DeclaredType representing the parameterized type corresponding to Outer<String> (see the 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.

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

Throws:

NullPointerException - if enclosingType, typeElement, or typeArguments is null

See Also:

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

External Specifications

• Java Language Specification, section 4.5

directSupertypes

List<? extends TypeMirror> directSupertypes(TypeMirror t)

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

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

Throws:

NullPointerException - if t is null

IllegalArgumentException - if either argument is either an executable type, a module type, or a package type

See Also:

• Types.directSupertypes(TypeMirror)

External Specifications

• Java Language Specification, section 4.10

element

Element 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.

Parameters:

t - a TypeMirror; must not be null

Returns:

an Element, or null

Throws:

NullPointerException - if t is null

See Also:

• Types.asElement(TypeMirror)

elementType

default TypeMirror elementType(TypeMirror t)

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.

Parameters:

t - a TypeMirror; must not be null

Returns:

the element type of the supplied TypeMirror; never null

Throws:

NullPointerException - if t is null

External Specifications

• Java Language Specification, section 10.1

erasure

<T extends TypeMirror> T erasure(T t)

Returns the erasure of the supplied TypeMirror.

Type Parameters:

T - a TypeMirror specialization

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

Throws:

NullPointerException - if t is null

IllegalArgumentException - if t is a NoType with a TypeKind of TypeKind.MODULE, or a NoType with a TypeKind of TypeKind.PACKAGE

See Also:

• Types.erasure(TypeMirror)

External Specifications

• Java Language Specification, section 4.6

executableElement

default ExecutableElement executableElement(Executable e)

Returns an ExecutableElement corresponding to the supplied Executable.

Parameters:

e - an Executable; must not be null

Returns:

an ExecutableElement corresponding to the supplied Executable; never null

Throws:

NullPointerException - if e is null

IllegalArgumentException - if somehow e is neither a Constructor nor a Method

executableElement

default ExecutableElement 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.

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

Throws:

NullPointerException - if any argument is null

generic

default boolean generic(Element e)

A convenience method that returns true if and only if the supplied Element is generic.

Parameters:

e - an Element; must not be null

Returns:

true if and only if the supplied Element is generic; false otherwise

Throws:

NullPointerException - if e is null

See Also:

• Parameterizable

External Specifications

• Java Language Specification, section 8.1.2
• Java Language Specification, section 8.4.4
• Java Language Specification, section 8.8.4
• Java Language Specification, section 9.1.2

generic

default boolean generic(TypeMirror t)

A convenience method that returns true if and only if the supplied TypeMirror is declared by an Element that is generic.

Parameters:

t - a TypeMirror; must not be null

Returns:

true if and only if the supplied TypeMirror is declared by an Element that is generic

Throws:

NullPointerException - if t is null

See Also:

• generic(Element)

External Specifications

• Java Language Specification, section 8.1.2
• Java Language Specification, section 8.4.4
• Java Language Specification, section 8.8.4
• Java Language Specification, section 9.1.2

javaLangObject

default boolean javaLangObject(Element e)

A convenience method that returns true if and only if the supplied Element represents the (essentially primordial) java.lang.Object Element.

Parameters:

e - an Element; must not be null

Returns:

true if and only if the supplied Element represents the (essentially primordial) java.lang.Object Element; false otherwise

Throws:

NullPointerException - if e is null

javaLangObject

default boolean javaLangObject(TypeMirror t)

A convenience method that returns true if and only if the supplied TypeMirror represents the DeclaredType declared by the (essentially primordial) java.lang.Object element.

Parameters:

t - a TypeMirror; must not be null

Returns:

true represents the DeclaredType declared by the (essentially primordial) java.lang.Object element; false otherwise

Throws:

NullPointerException - if t is null

See Also:

• javaLangObject(Element)

javaLangObject

default TypeElement javaLangObject()

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

Returns:

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

See Also:

• typeElement(CharSequence)

lock

Unlockable lock()

Semantically locks an opaque lock used to serialize symbol completion, and returns it in the form of an Unlockable.

Implementations of this method must not return null.

Returns:

an Unlockable in a semantically locked state; never null

See Also:

• Unlockable.close()

moduleElement

ModuleElement moduleElement(CharSequence qualifiedName)

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

Parameters:

qualifiedName - 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

Throws:

NullPointerException - if qualifiedName is null

See Also:

• Elements.getModuleElement(CharSequence)

External Specifications

• Java Language Specification, section 7.7

name

Name name(CharSequence name)

Returns a Name representing the supplied CharSequence.

Parameters:

name - a CharSequence; must not be null

Returns:

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

Throws:

NullPointerException - if name is null

See Also:

• lock()
• Elements.getName(CharSequence)

noType

NoType noType(TypeKind kind)

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

Parameters:

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

Returns:

a non-null NoType bearing the supplied TypeKind

Throws:

NullPointerException - if kind is null

IllegalArgumentException - if kind is non-null and neither TypeKind.NONE nor TypeKind.VOID

See Also:

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

External Specifications

• Java Language Specification, section 8.4.5

nullType

NullType nullType()

Returns a NullType implementation whose TypeKind is TypeKind.NULL.

Returns:

a non-null NullType

See Also:

• Types.getNullType()

External Specifications

• Java Language Specification, section 4.1

origin

Elements.Origin origin(Element e)

Returns the origin of the supplied Element.

Parameters:

e - a non-null Element

Returns:

a non-null Elements.Origin

See Also:

• Elements.getOrigin(Element)

packageElement

PackageElement packageElement(CharSequence canonicalName)

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

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

Throws:

NullPointerException - if canonicalName is null

See Also:

• Elements.getPackageElement(CharSequence)

External Specifications

• Java Language Specification, section 6.7

packageElement

PackageElement 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.

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

Throws:

NullPointerException - if either asSeenFrom or canonicalName is null

See Also:

• Elements.getPackageElement(ModuleElement, CharSequence)

External Specifications

• Java Language Specification, section 6.7

parameterizable

default Parameterizable parameterizable(GenericDeclaration gd)

Returns a Parameterizable corresponding to the supplied (reflective) GenericDeclaration.

Parameters:

gd - a GenericDeclaration; must not be null

Returns:

a Parameterizable corresponding to the supplied GenericDeclaration; never null

Throws:

NullPointerException - if gd is null

IllegalArgumentException - if gd is neither a Class nor an Executable

parameterized

default boolean parameterized(TypeMirror t)

A convenience method that returns true if and only if t is a DeclaredType, has a TypeKind of DECLARED, and has an empty type arguments list.

Parameters:

t - a TypeMirror; must not be null

Returns:

true if and only if t is a DeclaredType, has a TypeKind of DECLARED, and has an empty type arguments list; false otherwise

Throws:

NullPointerException - if t is null

primitiveType

default PrimitiveType primitiveType(CharSequence canonicalName)

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

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

Throws:

NullPointerException - if canonicalName is null

IllegalArgumentException - if canonicalName converted to a String is not equal to boolean, byte, char, double, float, int, long, short, java.lang.Boolean, java.lang.Byte, java.lang.Character, java.lang.Double, java.lang.Float, java.lang.Integer, java.lang.Long, or java.lang.Short

See Also:

• primitiveType(TypeKind)

External Specifications

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

primitiveType

default PrimitiveType primitiveType(TypeElement e)

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

Parameters:

e - a TypeElement; must not be null

Returns:

a non-null PrimitiveType with a primitive TypeKind

Throws:

NullPointerException - if e is null

IllegalArgumentException - if there is no unboxing conversion that can be applied to the type declared by e

See Also:

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

External Specifications

• Java Language Specification, section 5.1.8

primitiveType

PrimitiveType primitiveType(TypeKind kind)

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

Parameters:

kind - a primitive TypeKind; must not be null

Returns:

a non-null PrimitiveType with a primitive TypeKind

Throws:

NullPointerException - if kind is null

IllegalArgumentException - if kind is not primitive

See Also:

• Types.getPrimitiveType(TypeKind)

External Specifications

• Java Language Specification, section 4.2

primitiveType

PrimitiveType primitiveType(TypeMirror t)

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

Parameters:

t - a TypeMirror; must not be null

Returns:

a non-null PrimitiveType with a primitive TypeKind

Throws:

NullPointerException - if t is null

IllegalArgumentException - if there is no unboxing conversion that can be applied to t

See Also:

• Types.unboxedType(TypeMirror)

External Specifications

• Java Language Specification, section 5.1.8

raw

default boolean raw(TypeMirror t)

A convenience method that returns true if and only if the supplied TypeMirror is a raw type according to the rules of the Java Language Specification

Parameters:

t - a TypeMirror; must not be null

Returns:

true if and only if the supplied TypeMirror is a raw type according to the rules of the Java Language Specification

Throws:

NullPointerException - if t is null

External Specifications

• Java Language Specification, section 4.8

rawType

default TypeMirror 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.

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.

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

Throws:

NullPointerException - if t is null

External Specifications

• Java Language Specification, section 4.8

recordComponentElement

RecordComponentElement recordComponentElement(ExecutableElement e)

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

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

Throws:

NullPointerException - if e is null

External Specifications

• Java Language Specification, section 8.10.3

sameType

boolean sameType(TypeMirror t0,
 TypeMirror t1)

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

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

boolean subsignature(ExecutableType et0,
 ExecutableType et1)

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

Parameters:

et0 - the first ExecutableType; must not be null

et1 - the second ExecutableType; must not be null

Returns:

true if and only if et0 is a subsignature of et1

Throws:

NullPointerException - if either argument is null

ClassCastException - if this method is implemented in terms of the Types.isSubsignature(ExecutableType, ExecutableType) method, and if each of the supplied ExecutableType arguments does not have an EXECUTABLE TypeKind; this exception type is undocumented by the Types.isSubsignature(ExecutableType, ExecutableType) method and so is subject to change without prior notice

See Also:

• Types.isSubsignature(ExecutableType, ExecutableType)

External Specifications

• Java Language Specification, section 8.4.2

subtype

boolean subtype(TypeMirror candidateSubtype,
 TypeMirror supertype)

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

Parameters:

candidateSubtype - the first TypeMirror; must not be null

supertype - the second TypeMirror; must not be null

Returns:

true if and only if candidateSubtype is a subtype of supertype

Throws:

NullPointerException - if either argument is null

See Also:

• Types.isSubtype(TypeMirror, TypeMirror)

External Specifications

• Java Language Specification, section 4.10

toString

default 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.

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:

• lock()

type

default TypeMirror type(Type t)

A convenience method that returns the TypeMirror corresponding to the supplied (reflective) Type.

Parameters:

t - a Type; must not be null

Returns:

the TypeMirror corresponding to the supplied Type; never null

Throws:

NullPointerException - if t is null

IllegalArgumentException - if t is not a Class, GenericArrayType, ParameterizedType, TypeVariable or WildcardType

types

default TypeMirror[] types(Type[] ts)

A convenience method that returns an array of TypeMirrors whose elements correspond, in order, to the elements in the supplied Type array.

Parameters:

ts - an array of Types; must not be null

Returns:

an array of TypeMirrors whose elements correspond, in order, to the elements in the supplied Type array; never null

Throws:

NullPointerException - if ts is null or contains null elements

IllegalArgumentException - if any element of ts is deemed illegal by the type(Type) method

See Also:

• type(Type)

typeElement

TypeElement typeElement(CharSequence canonicalName)

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

Parameters:

canonicalName - a valid canonical name; must not be null

Returns:

a TypeElement, or null

Throws:

NullPointerException - if canonicalName is null

See Also:

• Elements.getTypeElement(CharSequence)

External Specifications

• Java Language Specification, section 6.7

typeElement

TypeElement 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.

Parameters:

asSeenFrom - a ModuleElement; must not be null

canonicalName - a valid canonical name; must not be null

Returns:

a TypeElement, or null

Throws:

NullPointerException - if either asSeenFrom or canonicalName is null

See Also:

• Elements.getTypeElement(ModuleElement, CharSequence)

External Specifications

• Java Language Specification, section 6.7

typeElement

default TypeElement typeElement(PrimitiveType t)

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 typeElement(TypeKind) method with the supplied PrimitiveType's affiliated TypeKind and returns its result.

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

Throws:

NullPointerException - if t is null

ClassCastException - if this method is implemented in terms of the Types.boxedClass(PrimitiveType) method, and if the supplied PrimitiveType does not have a primitive TypeKind; this exception type is undocumented by the Types.boxedClass(PrimitiveType) method and so is subject to change without prior notice

IllegalArgumentException - if primitiveTypeKind is not primitive

See Also:

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

External Specifications

• Java Language Specification, section 5.1.7

typeElement

default TypeElement 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.

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

Throws:

IllegalArgumentException - if primitiveTypeKind is not primitive

See Also:

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

External Specifications

• Java Language Specification, section 5.1.7

typeParameterElement

default TypeParameterElement 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.

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

default TypeVariable 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.

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:

• typeParameterElement(Parameterizable, CharSequence)

variableElement

default VariableElement variableElement(Element enclosingElement,
 CharSequence simpleName)

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.

Parameters:

enclosingElement - an Element; must not be null

simpleName - a CharSequence; must not be null

Returns:

a VariableElement, or null

Throws:

NullPointerException - if either argument is null

See Also:

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

wildcardType

default WildcardType 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.

Returns:

a new, non-null WildcardType

See Also:

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

External Specifications

• Java Language Specification, section 4.5.1

wildcardType

WildcardType 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.

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

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

Throws:

IllegalArgumentException - if both arguments are non-null or otherwise unsuitable for being the bounds of a WildcardType

See Also:

• Types.getWildcardType(TypeMirror, TypeMirror)

External Specifications

• Java Language Specification, section 4.5.1