Class ElementUtils

java.lang.Object

com.oracle.truffle.dsl.processor.java.ElementUtils

public class ElementUtils
extends Object

THIS IS NOT PUBLIC API.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COMPRESSED_HEADER_SIZE
static final int	COMPRESSED_POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
ElementUtils()

Method Summary

Modifier and Type	Method	Description
static boolean	areTypesCompatible(TypeMirror type1, TypeMirror type2)
static String	basicTypeId(TypeMirror type)
static TypeMirror	boxType(ProcessorContext context, TypeMirror primitiveType)
static boolean	canThrowType(List<? extends TypeMirror> thrownTypes, TypeMirror exceptionType)
static boolean	canThrowTypeExact(List<? extends TypeMirror> thrownTypes, TypeMirror exceptionType)
static TypeElement	castTypeElement(TypeMirror mirror)
static List<AnnotationMirror>	collectAnnotations(AnnotationMirror markerAnnotation, String elementName, Element element, DeclaredType annotationClass)
static int	compareByTypeHierarchy(TypeMirror t1, Set<String> t1SuperSet, TypeMirror t2, Set<String> t2SuperSet)
static int	compareByTypeHierarchy(TypeMirror t1, TypeMirror t2)
static int	compareMethod(ExecutableElement method1, ExecutableElement method2)
static int	compareType(TypeMirror signature1, TypeMirror signature2)
static String	createConstantName(String simpleName)
static String	createReferenceName(ExecutableElement method)
static String	defaultValue(TypeMirror mirror)
static boolean	elementEquals(Element element1, Element element2)
static TypeMirror	eraseGenericTypes(TypeMirror type)
static boolean	executableEquals(ExecutableElement e1, ExecutableElement e2)
static TypeMirror	fillInGenericWildcards(TypeMirror type)
static List<ExecutableElement>	findAllPublicMethods(DeclaredType type, String methodName)
static AnnotationMirror	findAnnotationMirror(List<? extends AnnotationMirror> mirrors, TypeMirror expectedAnnotationType)
static AnnotationMirror	findAnnotationMirror(Element element, Class<?> expectedAnnotationType)
static AnnotationMirror	findAnnotationMirror(Element element, TypeMirror annotationType)
static ExecutableElement	findExecutableElement(DeclaredType type, String name)
static ExecutableElement	findExecutableElement(DeclaredType type, String name, int argumentCount)
static ExecutableElement	findMethod(Class<?> type, String methodName)
static ExecutableElement	findMethod(DeclaredType type, String methodName)
static ExecutableElement	findMethod(DeclaredType type, String methodName, int parameterCount)
static Optional<TypeElement>	findNearestEnclosingType(Element e)
static PackageElement	findPackageElement(Element e)
static Optional<TypeElement>	findParentEnclosingType(Element element)
static Optional<TypeElement>	findRootEnclosingType(Element element)
static ExecutableElement	findStaticMethod(TypeElement type, String methodName)
static VariableElement	findVariableElement(Element element, String name)
static VariableElement	findVariableElement(DeclaredType type, String name)
static String	firstLetterLowerCase(String name)
static String	firstLetterUpperCase(String name)
static String	fixECJBinaryNameIssue(String name)
static TypeElement	fromTypeMirror(TypeMirror mirror)
static <T> T	getAnnotationValue(Class<T> expectedType, AnnotationMirror mirror, String name)
static <T> T	getAnnotationValue(Class<T> expectedType, AnnotationMirror mirror, String name, boolean resolveDefault)
static AnnotationValue	getAnnotationValue(AnnotationMirror mirror, String name)	Temporary local implementation of getAnnotationValue(javax.lang.model.element.AnnotationMirror, java.lang.String) .
static AnnotationValue	getAnnotationValue(AnnotationMirror mirror, String name, boolean resolveDefault)	Temporary local implementation of getAnnotationValue(javax.lang.model.element.AnnotationMirror, java.lang.String, boolean) .
static <T> List<T>	getAnnotationValueList(Class<T> expectedListType, AnnotationMirror mirror, String name)
static String	getBinaryName(TypeElement provider)
static String	getClassQualifiedName(TypeElement e)
static TypeMirror	getCommonSuperType(ProcessorContext context, Collection<TypeMirror> types)
static int	getCompressedReferenceSize(TypeMirror mirror)
static List<ExecutableElement>	getDeclaredMethodsInSuperTypes(TypeElement declaringElement, String name, TypeMirror... params)	Gets the methods in the super type hierarchy (excluding interfaces) that are overridden by a method in a subtype.
static String	getDeclaredName(DeclaredType element, boolean includeTypeVariables)
static DeclaredType	getDeclaredType(TypeElement typeElem, TypeMirror... typeArgs)
static List<TypeElement>	getDeclaredTypes(TypeElement element)
static List<TypeElement>	getDirectSuperTypes(TypeElement element)
static List<Element>	getElementHierarchy(Element e)
static String	getEnclosedQualifiedName(DeclaredType mirror)
static List<Element>	getEnumValues(TypeElement type)
static SpecializationData.Idempotence	getIdempotent(ExecutableElement method)
static String	getPackageName(Element element)
static String	getPackageName(TypeMirror mirror)
static String	getQualifiedName(TypeElement element)
static String	getQualifiedName(TypeMirror mirror)
static List<String>	getQualifiedSuperTypeNames(TypeElement element)
static String	getReadableReference(Element relativeTo, Element element)
static String	getReadableSignature(ExecutableElement method)
static String	getReadableSignature(ExecutableElement method, int highlightParameter)
static List<AnnotationMirror>	getRepeatedAnnotation(List<? extends AnnotationMirror> mirrors, DeclaredType base)
static String	getSimpleName(TypeElement element)
static String	getSimpleName(TypeMirror mirror)
static TypeElement	getSuperType(TypeElement element)	Gets the element representing the super class of a given type element.
static List<TypeElement>	getSuperTypes(TypeElement element)
static TypeElement	getTypeElement(CharSequence typeName)
static String	getTypeSimpleId(TypeMirror mirror)
static String	getUniqueIdentifier(TypeMirror typeMirror)
static List<String>	getUniqueIdentifiers(List<TypeMirror> typeMirror)
static Modifier	getVisibility(Set<Modifier> modifier)
static boolean	hasError(TypeMirror mirror)
static boolean	hasGenericTypes(TypeMirror type)
static boolean	hasOverloads(TypeElement enclosingType, ExecutableElement e)
static boolean	isAssignable(TypeMirror from, TypeMirror to)
static boolean	isDeclaredIn(Element search, Element elementHierarchy)
static boolean	isDeclaredMethodInSuperType(TypeElement element, String name, TypeMirror[] params)
static boolean	isDefaultMethodOverridden(TypeElement declaringElement, String name, TypeMirror... params)	Determines whether declaringElement or any of its direct super types override a default interface method.
static boolean	isDeprecated(Element baseType)
static boolean	isDeprecated(TypeMirror baseType)
static boolean	isEnclosedIn(Element enclosedIn, Element element)
static boolean	isFinal(TypeMirror mirror)
static boolean	isNone(TypeMirror mirror)
static boolean	isObject(TypeMirror actualType)
static boolean	isPackageDeprecated(TypeElement baseType)
static boolean	isPrimitive(TypeMirror mirror)
static boolean	isSubtype(TypeMirror type1, TypeMirror type2)
static boolean	isSubtypeBoxed(ProcessorContext context, TypeMirror from, TypeMirror to)
static boolean	isVisible(Element accessingElement, Element accessedElement)
static boolean	isVoid(TypeMirror mirror)
static Set<Modifier>	modifiers(Modifier... modifier)
static boolean	needsCastTo(TypeMirror sourceType, TypeMirror targetType)
static String	printException(Throwable e)
static <T> T	resolveAnnotationValue(Class<T> expectedType, AnnotationValue value)
static void	setFinal(Set<Modifier> modifiers, boolean enabled)
static void	setVisibility(Set<Modifier> modifiers, Modifier visibility)
static boolean	signatureEquals(ExecutableElement e1, ExecutableElement e2)
static List<TypeMirror>	sortTypes(List<TypeMirror> list, boolean reverse)
static boolean	typeEquals(TypeMirror type1, TypeMirror type2)
static Object	unboxAnnotationValue(AnnotationValue value)
static List<TypeMirror>	uniqueSortedTypes(Collection<TypeMirror> types, boolean reverse)
static Collection<TypeMirror>	uniqueTypes(Collection<TypeMirror> types)
static boolean	variableEquals(VariableElement var1, VariableElement var2)

Methods inherited from class java.lang.Object

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

Field Details

COMPRESSED_POINTER_SIZE

public static final int COMPRESSED_POINTER_SIZE

See Also:

• Constant Field Values

COMPRESSED_HEADER_SIZE

public static final int COMPRESSED_HEADER_SIZE

See Also:

• Constant Field Values

Constructor Details

ElementUtils

public ElementUtils()

Method Details

findMethod

public static ExecutableElement findMethod(Class<?> type,
 String methodName)

findMethod

public static ExecutableElement findMethod(DeclaredType type,
 String methodName)

findAllPublicMethods

public static List<ExecutableElement> findAllPublicMethods(DeclaredType type,
 String methodName)

getEnumValues

public static List<Element> getEnumValues(TypeElement type)

findMethod

public static ExecutableElement findMethod(DeclaredType type,
 String methodName,
 int parameterCount)

findStaticMethod

public static ExecutableElement findStaticMethod(TypeElement type,
 String methodName)

defaultValue

public static String defaultValue(TypeMirror mirror)

getTypeElement

public static TypeElement getTypeElement(CharSequence typeName)

findExecutableElement

public static ExecutableElement findExecutableElement(DeclaredType type,
 String name)

findExecutableElement

public static ExecutableElement findExecutableElement(DeclaredType type,
 String name,
 int argumentCount)

findVariableElement

public static VariableElement findVariableElement(DeclaredType type,
 String name)

findVariableElement

public static VariableElement findVariableElement(Element element,
 String name)

needsCastTo

public static boolean needsCastTo(TypeMirror sourceType,
 TypeMirror targetType)

createReferenceName

public static String createReferenceName(ExecutableElement method)

boxType

public static TypeMirror boxType(ProcessorContext context,
 TypeMirror primitiveType)

getDeclaredType

public static DeclaredType getDeclaredType(TypeElement typeElem,
 TypeMirror... typeArgs)

collectAnnotations

public static List<AnnotationMirror> collectAnnotations(AnnotationMirror markerAnnotation,
 String elementName,
 Element element,
 DeclaredType annotationClass)

getCommonSuperType

public static TypeMirror getCommonSuperType(ProcessorContext context,
 Collection<TypeMirror> types)

getReadableSignature

public static String getReadableSignature(ExecutableElement method)

hasOverloads

public static boolean hasOverloads(TypeElement enclosingType,
 ExecutableElement e)

getReadableSignature

public static String getReadableSignature(ExecutableElement method,
 int highlightParameter)

hasError

public static boolean hasError(TypeMirror mirror)

isSubtypeBoxed

public static boolean isSubtypeBoxed(ProcessorContext context,
 TypeMirror from,
 TypeMirror to)

isSubtype

public static boolean isSubtype(TypeMirror type1,
 TypeMirror type2)

isAssignable

public static boolean isAssignable(TypeMirror from,
 TypeMirror to)

modifiers

public static Set<Modifier> modifiers(Modifier... modifier)

getTypeSimpleId

public static String getTypeSimpleId(TypeMirror mirror)

getSimpleName

public static String getSimpleName(TypeElement element)

getSimpleName

public static String getSimpleName(TypeMirror mirror)

getDeclaredName

public static String getDeclaredName(DeclaredType element,
 boolean includeTypeVariables)

fixECJBinaryNameIssue

public static String fixECJBinaryNameIssue(String name)

getClassQualifiedName

public static String getClassQualifiedName(TypeElement e)

getQualifiedName

public static String getQualifiedName(TypeElement element)

getQualifiedName

public static String getQualifiedName(TypeMirror mirror)

isNone

public static boolean isNone(TypeMirror mirror)

isVoid

public static boolean isVoid(TypeMirror mirror)

isPrimitive

public static boolean isPrimitive(TypeMirror mirror)

isFinal

public static boolean isFinal(TypeMirror mirror)

getQualifiedSuperTypeNames

public static List<String> getQualifiedSuperTypeNames(TypeElement element)

getDeclaredTypes

public static List<TypeElement> getDeclaredTypes(TypeElement element)

isEnclosedIn

public static boolean isEnclosedIn(Element enclosedIn,
 Element element)

getElementHierarchy

public static List<Element> getElementHierarchy(Element e)

findRootEnclosingType

public static Optional<TypeElement> findRootEnclosingType(Element element)

findParentEnclosingType

public static Optional<TypeElement> findParentEnclosingType(Element element)

findNearestEnclosingType

public static Optional<TypeElement> findNearestEnclosingType(Element e)

getDirectSuperTypes

public static List<TypeElement> getDirectSuperTypes(TypeElement element)

getSuperType

public static TypeElement getSuperType(TypeElement element)

Gets the element representing the super class of a given type element.

isDeprecated

public static boolean isDeprecated(TypeMirror baseType)

isDeprecated

public static boolean isDeprecated(Element baseType)

isPackageDeprecated

public static boolean isPackageDeprecated(TypeElement baseType)

getSuperTypes

public static List<TypeElement> getSuperTypes(TypeElement element)

getPackageName

public static String getPackageName(Element element)

getEnclosedQualifiedName

public static String getEnclosedQualifiedName(DeclaredType mirror)

getPackageName

public static String getPackageName(TypeMirror mirror)

createConstantName

public static String createConstantName(String simpleName)

fromTypeMirror

public static TypeElement fromTypeMirror(TypeMirror mirror)

getAnnotationValue

public static AnnotationValue getAnnotationValue(AnnotationMirror mirror,
 String name)

Temporary local implementation of getAnnotationValue(javax.lang.model.element.AnnotationMirror, java.lang.String) . The ElementUtils.getAnnotationValue does not work on Eclipse JDT compiler when an annotation type is nested in a generic type, see issue: https://bugs.eclipse.org/bugs/show_bug.cgi?id=544940

getAnnotationValue

public static AnnotationValue getAnnotationValue(AnnotationMirror mirror,
 String name,
 boolean resolveDefault)

Temporary local implementation of getAnnotationValue(javax.lang.model.element.AnnotationMirror, java.lang.String, boolean) . The ElementUtils.getAnnotationValue does not work on Eclipse JDT compiler when an annotation type is nested in a generic type, see issue: https://bugs.eclipse.org/bugs/show_bug.cgi?id=544940

getAnnotationValueList

public static <T> List<T> getAnnotationValueList(Class<T> expectedListType,
 AnnotationMirror mirror,
 String name)

getAnnotationValue

public static <T> T getAnnotationValue(Class<T> expectedType,
 AnnotationMirror mirror,
 String name)

getAnnotationValue

public static <T> T getAnnotationValue(Class<T> expectedType,
 AnnotationMirror mirror,
 String name,
 boolean resolveDefault)

resolveAnnotationValue

public static <T> T resolveAnnotationValue(Class<T> expectedType,
 AnnotationValue value)

unboxAnnotationValue

public static Object unboxAnnotationValue(AnnotationValue value)

printException

public static String printException(Throwable e)

findAnnotationMirror

public static AnnotationMirror findAnnotationMirror(Element element,
 Class<?> expectedAnnotationType)

findAnnotationMirror

public static AnnotationMirror findAnnotationMirror(List<? extends AnnotationMirror> mirrors,
 TypeMirror expectedAnnotationType)

findAnnotationMirror

public static AnnotationMirror findAnnotationMirror(Element element,
 TypeMirror annotationType)

findPackageElement

public static PackageElement findPackageElement(Element e)

firstLetterUpperCase

public static String firstLetterUpperCase(String name)

firstLetterLowerCase

public static String firstLetterLowerCase(String name)

isDeclaredMethodInSuperType

public static boolean isDeclaredMethodInSuperType(TypeElement element,
 String name,
 TypeMirror[] params)

getDeclaredMethodsInSuperTypes

public static List<ExecutableElement> getDeclaredMethodsInSuperTypes(TypeElement declaringElement,
 String name,
 TypeMirror... params)

Gets the methods in the super type hierarchy (excluding interfaces) that are overridden by a method in a subtype.

Parameters:

declaringElement - the subtype element declaring the method

name - the name of the method

params - the signature of the method

isDefaultMethodOverridden

public static boolean isDefaultMethodOverridden(TypeElement declaringElement,
 String name,
 TypeMirror... params)

Determines whether declaringElement or any of its direct super types override a default interface method.

Any declaration of the given method and signature in the direct super type hierarchy - even if it is abstract - is considered to override the default method.

Parameters:

declaringElement - the type to check

name - the name of the default interface method

params - the signature of the method

Returns:

true if any the default method is overridden

typeEquals

public static boolean typeEquals(TypeMirror type1,
 TypeMirror type2)

areTypesCompatible

public static boolean areTypesCompatible(TypeMirror type1,
 TypeMirror type2)

getUniqueIdentifiers

public static List<String> getUniqueIdentifiers(List<TypeMirror> typeMirror)

getUniqueIdentifier

public static String getUniqueIdentifier(TypeMirror typeMirror)

compareByTypeHierarchy

public static int compareByTypeHierarchy(TypeMirror t1,
 TypeMirror t2)

compareByTypeHierarchy

public static int compareByTypeHierarchy(TypeMirror t1,
 Set<String> t1SuperSet,
 TypeMirror t2,
 Set<String> t2SuperSet)

canThrowTypeExact

public static boolean canThrowTypeExact(List<? extends TypeMirror> thrownTypes,
 TypeMirror exceptionType)

canThrowType

public static boolean canThrowType(List<? extends TypeMirror> thrownTypes,
 TypeMirror exceptionType)

setFinal

public static void setFinal(Set<Modifier> modifiers,
 boolean enabled)

setVisibility

public static void setVisibility(Set<Modifier> modifiers,
 Modifier visibility)

getVisibility

public static Modifier getVisibility(Set<Modifier> modifier)

isObject

public static boolean isObject(TypeMirror actualType)

fillInGenericWildcards

public static TypeMirror fillInGenericWildcards(TypeMirror type)

hasGenericTypes

public static boolean hasGenericTypes(TypeMirror type)

eraseGenericTypes

public static TypeMirror eraseGenericTypes(TypeMirror type)

variableEquals

public static boolean variableEquals(VariableElement var1,
 VariableElement var2)

signatureEquals

public static boolean signatureEquals(ExecutableElement e1,
 ExecutableElement e2)

executableEquals

public static boolean executableEquals(ExecutableElement e1,
 ExecutableElement e2)

elementEquals

public static boolean elementEquals(Element element1,
 Element element2)

sortTypes

public static List<TypeMirror> sortTypes(List<TypeMirror> list,
 boolean reverse)

compareType

public static int compareType(TypeMirror signature1,
 TypeMirror signature2)

uniqueSortedTypes

public static List<TypeMirror> uniqueSortedTypes(Collection<TypeMirror> types,
 boolean reverse)

uniqueTypes

public static Collection<TypeMirror> uniqueTypes(Collection<TypeMirror> types)

compareMethod

public static int compareMethod(ExecutableElement method1,
 ExecutableElement method2)

getRepeatedAnnotation

public static List<AnnotationMirror> getRepeatedAnnotation(List<? extends AnnotationMirror> mirrors,
 DeclaredType base)

isVisible

public static boolean isVisible(Element accessingElement,
 Element accessedElement)

castTypeElement

public static TypeElement castTypeElement(TypeMirror mirror)

getReadableReference

public static String getReadableReference(Element relativeTo,
 Element element)

isDeclaredIn

public static boolean isDeclaredIn(Element search,
 Element elementHierarchy)

getBinaryName

public static String getBinaryName(TypeElement provider)

basicTypeId

public static String basicTypeId(TypeMirror type)

getCompressedReferenceSize

public static int getCompressedReferenceSize(TypeMirror mirror)

getIdempotent

public static SpecializationData.Idempotence getIdempotent(ExecutableElement method)