Module org.microbean.lang

Package org.microbean.lang

Class Lang

java.lang.Object

org.microbean.lang.Lang

public final class Lang
extends Object

A utility class for working with the javax.lang.model.* packages at runtime.

Author:

Laird Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Lang.ConstableTypeAndElementSource	A TypeAndElementSource implementation that is also Constable.

Method Summary

Modifier and Type	Method	Description
static final Set<? extends ModuleElement>	allModuleElements()
static final ArrayType	arrayType(Class<?> arrayClass)
static final ArrayType	arrayType(GenericArrayType g)
static final ArrayType	arrayTypeOf(TypeMirror componentType)
static final boolean	assignable(TypeMirror payload, TypeMirror receiver)	Returns true if and only if a bearer of the supplied payload is assignable to a bearer of the supplied receiver.
static final Name	binaryName(TypeElement e)
static final TypeMirror	box(TypeMirror t)
static final TypeElement	boxedClass(PrimitiveType t)
static final boolean	bridge(Element e)
static final boolean	canonicalConstructor(Element e)
static final TypeMirror	capture(TypeMirror t)
static final boolean	compactConstructor(Element e)
static final boolean	contains(TypeMirror t, TypeMirror s)
static final DeclaredType	declaredType(CharSequence canonicalName)
static final DeclaredType	declaredType(Class<?> c)
static final DeclaredType	declaredType(ParameterizedType p)
static final DeclaredType	declaredType(TypeElement typeElement, TypeMirror... typeArguments)
static final DeclaredType	declaredType(DeclaredType containingType, TypeElement typeElement, TypeMirror... typeArguments)
static final Optional<? extends ConstantDesc>	describeConstable(AnnotatedConstruct a)
static final Optional<? extends ConstantDesc>	describeConstable(Element e)
static final Optional<? extends ConstantDesc>	describeConstable(ExecutableElement e)
static final Optional<? extends ConstantDesc>	describeConstable(ModuleElement e)
static final Optional<? extends ConstantDesc>	describeConstable(Name n)
static final Optional<? extends ConstantDesc>	describeConstable(PackageElement e)
static final Optional<? extends ConstantDesc>	describeConstable(TypeElement e)
static final Optional<? extends ConstantDesc>	describeConstable(VariableElement e)
static final Optional<? extends ConstantDesc>	describeConstable(ArrayType t)
static final Optional<? extends ConstantDesc>	describeConstable(DeclaredType t)
static final Optional<? extends ConstantDesc>	describeConstable(NoType t)
static final Optional<? extends ConstantDesc>	describeConstable(NullType t)
static final Optional<? extends ConstantDesc>	describeConstable(PrimitiveType t)
static final Optional<? extends ConstantDesc>	describeConstable(TypeMirror t)
static final Optional<? extends ConstantDesc>	describeConstable(WildcardType t)
static final String	descriptor(TypeMirror t)
static final List<? extends TypeMirror>	directSupertypes(TypeMirror t)
static final Element	element(TypeMirror t)
static final String	elementSignature(Element e)
static final TypeMirror	erasure(TypeMirror t)
static final ExecutableElement	executableElement(Constructor<?> c)
static final ExecutableElement	executableElement(Executable e)
static final ExecutableElement	executableElement(Method m)
static final ExecutableElement	executableElement(TypeElement declaringClass, CharSequence name, List<? extends TypeMirror> parameterTypes)
static final ExecutableElement	executableElement(TypeElement declaringClass, CharSequence name, TypeMirror... parameterTypes)
static final ExecutableElement	executableElement(TypeElement declaringClass, List<? extends TypeMirror> parameterTypes)
static final ExecutableElement	executableElement(TypeElement declaringClass, TypeMirror... parameterTypes)
static final ExecutableType	executableType(Executable e)
static final boolean	functionalInterface(TypeElement e)
static final boolean	generic(Element e)
static final void	initialize()	Asynchronously and idempotently initializes the Lang class for use.
static final String	jvmBinaryName(TypeElement te)
static final TypeMirror	memberOf(DeclaredType t, Element e)
static final Set<? extends Modifier>	modifiers(long modifiers)
static final long	modifiers(Set<? extends Modifier> ms)
static final long	modifiers(Element e)
static final ModuleElement	moduleElement(CharSequence moduleName)
static final ModuleElement	moduleElement(Class<?> c)
static final ModuleElement	moduleElement(Module module)
static final ModuleElement	moduleOf(Element e)
static final Name	name(CharSequence name)
static final NoType	noType(TypeKind k)
static final NullType	nullType()
static final Elements.Origin	origin(Element e)
static final PackageElement	packageElement(CharSequence fullyQualifiedName)
static final PackageElement	packageElement(Class<?> c)
static final PackageElement	packageElement(Module module, Package pkg)
static final PackageElement	packageElement(Package pkg)
static final PackageElement	packageElement(ModuleElement moduleElement, CharSequence fullyQualifiedName)
static final PackageElement	packageElement(ModuleElement moduleElement, Package pkg)
static final PackageElement	packageOf(Element e)
static final Parameterizable	parameterizable(GenericDeclaration gd)
static final PrimitiveType	primitiveType(Class<?> c)
static final PrimitiveType	primitiveType(TypeKind k)
static final boolean	sameType(TypeMirror t, TypeMirror s)
static final boolean	subsignature(ExecutableType e, ExecutableType f)
static final boolean	subtype(TypeMirror payload, TypeMirror receiver)
static final TypeMirror	type(Field f)
static final TypeMirror	type(Type t)
static final TypeAndElementSource	typeAndElementSource()	Returns a TypeAndElementSource backed by relevant static methods in this class.
static final List<? extends TypeMirror>	typeArguments(TypeMirror t)
static final TypeElement	typeElement(CharSequence canonicalName)
static final TypeElement	typeElement(Class<?> c)
static final TypeElement	typeElement(ModuleElement moduleElement, CharSequence canonicalName)
static final TypeParameterElement	typeParameterElement(GenericDeclaration gd, String name)
static final TypeParameterElement	typeParameterElement(TypeVariable<?> t)
static final String	typeSignature(TypeMirror t)
static final TypeVariable	typeVariable(GenericDeclaration gd, String name)
static final TypeVariable	typeVariable(TypeVariable<?> t)
static final TypeMirror	unbox(TypeMirror t)
static final PrimitiveType	unboxedType(TypeMirror t)
static final <E extends Element> E	unwrap(E e)
static final TypeMirror[]	unwrap(TypeMirror[] ts)
static final <T extends TypeMirror> T	unwrap(T t)
static final VariableElement	variableElement(Field f)
static final VariableElement	variableElement(ExecutableElement declaringExecutable, int position)
static final VariableElement	variableElement(ExecutableElement declaringExecutable, CharSequence parameterName)
static final VariableElement	variableElement(TypeElement declaringClass, CharSequence fieldName)
static final WildcardType	wildcardType()
static final WildcardType	wildcardType(WildcardType t)
static final WildcardType	wildcardType(TypeMirror extendsBound, TypeMirror superBound)
static final <E extends Element> E	wrap(E e)
static final <T extends TypeMirror> T	wrap(T t)
static final List<? extends Element>	wrapElements(Collection<? extends Element> es)
static final List<? extends TypeMirror>	wrapTypes(Collection<? extends TypeMirror> ts)

Methods inherited from class java.lang.Object

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

Method Details

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(Name n)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(AnnotatedConstruct a)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(Element e)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(ExecutableElement e)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(ModuleElement e)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(PackageElement e)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(TypeElement e)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(VariableElement e)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(TypeMirror t)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(ArrayType t)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(DeclaredType t)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(NoType t)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(NullType t)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(PrimitiveType t)

describeConstable

public static final Optional<? extends ConstantDesc> describeConstable(WildcardType t)

allModuleElements

public static final Set<? extends ModuleElement> allModuleElements()

binaryName

public static final Name binaryName(TypeElement e)

functionalInterface

public static final boolean functionalInterface(TypeElement e)

generic

public static final boolean generic(Element e)

capture

public static final TypeMirror capture(TypeMirror t)

contains

public static final boolean contains(TypeMirror t,
 TypeMirror s)

element

public static final Element element(TypeMirror t)

memberOf

public static final TypeMirror memberOf(DeclaredType t,
 Element e)

box

public static final TypeMirror box(TypeMirror t)

unbox

public static final TypeMirror unbox(TypeMirror t)

boxedClass

public static final TypeElement boxedClass(PrimitiveType t)

bridge

public static final boolean bridge(Element e)

compactConstructor

public static final boolean compactConstructor(Element e)

canonicalConstructor

public static final boolean canonicalConstructor(Element e)

unboxedType

public static final PrimitiveType unboxedType(TypeMirror t)

elementSignature

public static final String elementSignature(Element e)

typeSignature

public static final String typeSignature(TypeMirror t)

descriptor

public static final String descriptor(TypeMirror t)

jvmBinaryName

public static final String jvmBinaryName(TypeElement te)

directSupertypes

public static final List<? extends TypeMirror> directSupertypes(TypeMirror t)

subsignature

public static final boolean subsignature(ExecutableType e,
 ExecutableType f)

erasure

public static final TypeMirror erasure(TypeMirror t)

typeAndElementSource

public static final TypeAndElementSource typeAndElementSource()

Returns a TypeAndElementSource backed by relevant static methods in this class.

Returns:

a TypeAndElementSource; never null

See Also:

• TypeAndElementSource

modifiers

public static final long modifiers(Element e)

modifiers

public static final long modifiers(Set<? extends Modifier> ms)

modifiers

public static final Set<? extends Modifier> modifiers(long modifiers)

moduleElement

public static final ModuleElement moduleElement(Class<?> c)

moduleElement

public static final ModuleElement moduleElement(Module module)

moduleElement

public static final ModuleElement moduleElement(CharSequence moduleName)

moduleOf

public static final ModuleElement moduleOf(Element e)

name

public static final Name name(CharSequence name)

origin

public static final Elements.Origin origin(Element e)

packageElement

public static final PackageElement packageElement(Class<?> c)

packageElement

public static final PackageElement packageElement(Package pkg)

packageElement

public static final PackageElement packageElement(CharSequence fullyQualifiedName)

packageElement

public static final PackageElement packageElement(Module module,
 Package pkg)

packageElement

public static final PackageElement packageElement(ModuleElement moduleElement,
 Package pkg)

packageElement

public static final PackageElement packageElement(ModuleElement moduleElement,
 CharSequence fullyQualifiedName)

packageOf

public static final PackageElement packageOf(Element e)

arrayType

public static final ArrayType arrayType(Class<?> arrayClass)

arrayType

public static final ArrayType arrayType(GenericArrayType g)

arrayTypeOf

public static final ArrayType arrayTypeOf(TypeMirror componentType)

declaredType

public static final DeclaredType declaredType(Class<?> c)

declaredType

public static final DeclaredType declaredType(ParameterizedType p)

declaredType

public static final DeclaredType declaredType(CharSequence canonicalName)

declaredType

public static final DeclaredType declaredType(TypeElement typeElement,
 TypeMirror... typeArguments)

declaredType

public static final DeclaredType declaredType(DeclaredType containingType,
 TypeElement typeElement,
 TypeMirror... typeArguments)

typeArguments

public static final List<? extends TypeMirror> typeArguments(TypeMirror t)

executableElement

public static final ExecutableElement executableElement(Executable e)

executableElement

public static final ExecutableElement executableElement(Constructor<?> c)

executableElement

public static final ExecutableElement executableElement(Method m)

executableElement

public static final ExecutableElement executableElement(TypeElement declaringClass,
 List<? extends TypeMirror> parameterTypes)

executableElement

public static final ExecutableElement executableElement(TypeElement declaringClass,
 TypeMirror... parameterTypes)

executableElement

public static final ExecutableElement executableElement(TypeElement declaringClass,
 CharSequence name,
 List<? extends TypeMirror> parameterTypes)

executableElement

public static final ExecutableElement executableElement(TypeElement declaringClass,
 CharSequence name,
 TypeMirror... parameterTypes)

executableType

public static final ExecutableType executableType(Executable e)

noType

public static final NoType noType(TypeKind k)

nullType

public static final NullType nullType()

primitiveType

public static final PrimitiveType primitiveType(Class<?> c)

primitiveType

public static final PrimitiveType primitiveType(TypeKind k)

sameType

public static final boolean sameType(TypeMirror t,
 TypeMirror s)

typeElement

public static final TypeElement typeElement(Class<?> c)

typeElement

public static final TypeElement typeElement(CharSequence canonicalName)

typeElement

public static final TypeElement typeElement(ModuleElement moduleElement,
 CharSequence canonicalName)

parameterizable

public static final Parameterizable parameterizable(GenericDeclaration gd)

typeParameterElement

public static final TypeParameterElement typeParameterElement(TypeVariable<?> t)

typeParameterElement

public static final TypeParameterElement typeParameterElement(GenericDeclaration gd,
 String name)

typeVariable

public static final TypeVariable typeVariable(TypeVariable<?> t)

typeVariable

public static final TypeVariable typeVariable(GenericDeclaration gd,
 String name)

variableElement

public static final VariableElement variableElement(Field f)

variableElement

public static final VariableElement variableElement(TypeElement declaringClass,
 CharSequence fieldName)

variableElement

public static final VariableElement variableElement(ExecutableElement declaringExecutable,
 CharSequence parameterName)

variableElement

public static final VariableElement variableElement(ExecutableElement declaringExecutable,
 int position)

wildcardType

public static final WildcardType wildcardType()

wildcardType

public static final WildcardType wildcardType(WildcardType t)

wildcardType

public static final WildcardType wildcardType(TypeMirror extendsBound,
 TypeMirror superBound)

assignable

public static final boolean assignable(TypeMirror payload,
 TypeMirror receiver)

Returns true if and only if a bearer of the supplied payload is assignable to a bearer of the supplied receiver.

Parameters:

payload - a type borne by the "right hand side" of a potential assignment; must not be null

receiver - a type borne by the "left hand side" of a potential assignment; must not be null

Returns:

true if and only if a bearer of the supplied payload is assignable to a bearer of the supplied receiver

Throws:

NullPointerException - if any argument is null

See Also:

• Types.isAssignable(TypeMirror, TypeMirror)

subtype

public static final boolean subtype(TypeMirror payload,
 TypeMirror receiver)

type

public static final TypeMirror type(Type t)

type

public static final TypeMirror type(Field f)

initialize

public static final void initialize()

Asynchronously and idempotently initializes the Lang class for use.

This method is automatically called by the internals of this class when appropriate, but is public to support eager initialization use cases.

unwrap

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

unwrap

public static final TypeMirror[] unwrap(TypeMirror[] ts)

unwrap

public static final <E extends Element> E unwrap(E e)

wrap

public static final <T extends TypeMirror> T wrap(T t)

wrap

public static final <E extends Element> E wrap(E e)

wrapTypes

public static final List<? extends TypeMirror> wrapTypes(Collection<? extends TypeMirror> ts)

wrapElements

public static final List<? extends Element> wrapElements(Collection<? extends Element> es)