org.checkerframework.javacutil

Class InternalUtils

java.lang.Object

org.checkerframework.javacutil.InternalUtils

public class InternalUtils
extends java.lang.Object

Static utility methods used by annotation abstractions in this package. Some methods in this class depend on the use of Sun javac internals; any procedure in the Checker Framework that uses a non-public API should be placed here.

Method Summary

Modifier and Type	Method and Description
static javax.lang.model.element.AnnotationMirror	annotationFromAnnotationTree(com.sun.source.tree.AnnotationTree tree)
static java.util.List<? extends javax.lang.model.element.AnnotationMirror>	annotationsFromArrayCreation(com.sun.source.tree.NewArrayTree node, int level)
static java.util.List<? extends javax.lang.model.element.AnnotationMirror>	annotationsFromTree(com.sun.source.tree.AnnotatedTypeTree node)
static java.util.List<? extends javax.lang.model.element.AnnotationMirror>	annotationsFromTree(com.sun.source.tree.TypeParameterTree node)
static java.util.List<javax.lang.model.element.AnnotationMirror>	annotationsFromTypeAnnotationTrees(java.util.List<? extends com.sun.source.tree.AnnotationTree> annos)
static int	compareDiagnosticPosition(com.sun.source.tree.Tree tree1, com.sun.source.tree.Tree tree2) Compares tree1 to tree2 by the position at which a diagnostic (e.g., an error message) for the tree should be printed.
static javax.lang.model.element.ExecutableElement	constructor(com.sun.source.tree.NewClassTree tree) Determines the symbol for a constructor given an invocation via new.
static com.sun.tools.javac.code.Symbol	findFunction(com.sun.source.tree.Tree tree, javax.annotation.processing.ProcessingEnvironment env) The type of the lambda or method reference tree is a functional interface type.
static javax.lang.model.type.WildcardType	getCapturedWildcard(javax.lang.model.type.TypeVariable typeVar) If typeVar is a captured wildcard, returns that wildcard; otherwise returns null.
static java.lang.ClassLoader	getClassLoaderForClass(java.lang.Class<? extends java.lang.Object> clazz) Obtain the class loader for clazz.
static com.sun.tools.javac.util.Context	getJavacContext(javax.annotation.processing.ProcessingEnvironment env) Helper function to extract the javac Context from the javac processing environment.
static javax.lang.model.element.TypeElement	getTypeElement(javax.lang.model.type.TypeMirror type) Returns the type element for type if type is a class, interface, annotation type, or enum.
static javax.lang.model.type.TypeMirror	greatestLowerBound(javax.annotation.processing.ProcessingEnvironment processingEnv, javax.lang.model.type.TypeMirror tm1, javax.lang.model.type.TypeMirror tm2) Returns the greatest lower bound of two TypeMirrors, ignoring any annotations on the types.
static boolean	isAnonymousConstructor(com.sun.source.tree.MethodTree method) Determines whether or not the node referred to by the given TreePath is an anonymous constructor (the constructor for an anonymous class.
static boolean	isCaptured(javax.lang.model.type.TypeVariable typeVar) Returns whether a TypeVariable represents a captured type.
static boolean	isClassType(javax.lang.model.type.TypeMirror type) Returns whether a TypeMirror represents a class type.
static boolean	isFunctionalInterface(javax.lang.model.type.TypeMirror type, javax.annotation.processing.ProcessingEnvironment env) Returns whether or not type is a functional interface type (as defined in JLS 9.8).
static javax.lang.model.type.TypeMirror	leastUpperBound(javax.annotation.processing.ProcessingEnvironment processingEnv, javax.lang.model.type.TypeMirror tm1, javax.lang.model.type.TypeMirror tm2) Returns the least upper bound of two TypeMirrors, ignoring any annotations on the types.
static javax.lang.model.type.TypeMirror	substituteMethodReturnType(javax.annotation.processing.ProcessingEnvironment env, javax.lang.model.element.Element methodElement, javax.lang.model.type.TypeMirror substitutedReceiverType) Returns the return type of a method, given the receiver of the method call.
static @Nullable javax.lang.model.element.Element	symbol(com.sun.source.tree.Tree tree) Gets the Element ("symbol") for the given Tree API node.
static javax.lang.model.type.TypeMirror	typeOf(com.sun.source.tree.Tree tree)

Methods inherited from class java.lang.Object

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

Method Detail

symbol

public static @Nullable javax.lang.model.element.Element symbol(com.sun.source.tree.Tree tree)

Gets the Element ("symbol") for the given Tree API node.

Parameters:

tree - the Tree node to get the symbol for

Returns:

the Symbol for the given tree, or null if one could not be found

Throws:

java.lang.IllegalArgumentException - if tree is null or is not a valid javac-internal tree (JCTree)

isAnonymousConstructor

public static boolean isAnonymousConstructor(com.sun.source.tree.MethodTree method)

Determines whether or not the node referred to by the given TreePath is an anonymous constructor (the constructor for an anonymous class.

Parameters:

method - the TreePath for a node that may be an anonymous constructor

Returns:

true if the given path points to an anonymous constructor, false if it does not

constructor

public static javax.lang.model.element.ExecutableElement constructor(com.sun.source.tree.NewClassTree tree)

Determines the symbol for a constructor given an invocation via new.

If the tree is a declaration of an anonymous class, then method returns constructor that gets invoked in the extended class, rather than the anonymous constructor implicitly added by the constructor (JLS 15.9.5.1)

Parameters:

tree - the constructor invocation

Returns:

the ExecutableElement corresponding to the constructor call in tree

annotationsFromTypeAnnotationTrees

public static final java.util.List<javax.lang.model.element.AnnotationMirror> annotationsFromTypeAnnotationTrees(java.util.List<? extends com.sun.source.tree.AnnotationTree> annos)

annotationFromAnnotationTree

public static javax.lang.model.element.AnnotationMirror annotationFromAnnotationTree(com.sun.source.tree.AnnotationTree tree)

annotationsFromTree

public static final java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationsFromTree(com.sun.source.tree.AnnotatedTypeTree node)

annotationsFromTree

public static final java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationsFromTree(com.sun.source.tree.TypeParameterTree node)

annotationsFromArrayCreation

public static final java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationsFromArrayCreation(com.sun.source.tree.NewArrayTree node,
                                                                                                                     int level)

typeOf

public static javax.lang.model.type.TypeMirror typeOf(com.sun.source.tree.Tree tree)

isCaptured

public static boolean isCaptured(javax.lang.model.type.TypeVariable typeVar)

Returns whether a TypeVariable represents a captured type.

getCapturedWildcard

public static javax.lang.model.type.WildcardType getCapturedWildcard(javax.lang.model.type.TypeVariable typeVar)

If typeVar is a captured wildcard, returns that wildcard; otherwise returns null.

isClassType

public static boolean isClassType(javax.lang.model.type.TypeMirror type)

Returns whether a TypeMirror represents a class type.

leastUpperBound

public static javax.lang.model.type.TypeMirror leastUpperBound(javax.annotation.processing.ProcessingEnvironment processingEnv,
                                                               javax.lang.model.type.TypeMirror tm1,
                                                               javax.lang.model.type.TypeMirror tm2)

Returns the least upper bound of two TypeMirrors, ignoring any annotations on the types.

Wrapper around Types.lub to add special handling for null types, primitives, and wildcards.

Parameters:

processingEnv - the ProcessingEnvironment to use

tm1 - a TypeMirror

tm2 - a TypeMirror

Returns:

the least upper bound of tm1 and tm2.

greatestLowerBound

public static javax.lang.model.type.TypeMirror greatestLowerBound(javax.annotation.processing.ProcessingEnvironment processingEnv,
                                                                  javax.lang.model.type.TypeMirror tm1,
                                                                  javax.lang.model.type.TypeMirror tm2)

Returns the greatest lower bound of two TypeMirrors, ignoring any annotations on the types.

Wrapper around Types.glb to add special handling for null types, primitives, and wildcards.

Parameters:

processingEnv - the ProcessingEnvironment to use

tm1 - a TypeMirror

tm2 - a TypeMirror

Returns:

the greatest lower bound of tm1 and tm2.

substituteMethodReturnType

public static javax.lang.model.type.TypeMirror substituteMethodReturnType(javax.annotation.processing.ProcessingEnvironment env,
                                                                          javax.lang.model.element.Element methodElement,
                                                                          javax.lang.model.type.TypeMirror substitutedReceiverType)

Returns the return type of a method, given the receiver of the method call.

getJavacContext

public static com.sun.tools.javac.util.Context getJavacContext(javax.annotation.processing.ProcessingEnvironment env)

Helper function to extract the javac Context from the javac processing environment.

Parameters:

env - the processing environment

Returns:

the javac Context

getTypeElement

public static javax.lang.model.element.TypeElement getTypeElement(javax.lang.model.type.TypeMirror type)

Returns the type element for type if type is a class, interface, annotation type, or enum. Otherwise, returns null.

Parameters:

type - whose element is returned

Returns:

the type element for type if type is a class, interface, annotation type, or enum; otherwise, returns null

getClassLoaderForClass

public static java.lang.ClassLoader getClassLoaderForClass(java.lang.Class<? extends java.lang.Object> clazz)

Obtain the class loader for clazz. If that is not available, return the system class loader.

Parameters:

clazz - the class whose class loader to find

Returns:

the class loader used to clazz, or the system class loader, or null if both are unavailable

compareDiagnosticPosition

public static int compareDiagnosticPosition(com.sun.source.tree.Tree tree1,
                                            com.sun.source.tree.Tree tree2)

Compares tree1 to tree2 by the position at which a diagnostic (e.g., an error message) for the tree should be printed.

isFunctionalInterface

public static boolean isFunctionalInterface(javax.lang.model.type.TypeMirror type,
                                            javax.annotation.processing.ProcessingEnvironment env)

Returns whether or not type is a functional interface type (as defined in JLS 9.8).

Parameters:

type - possible functional interface type

env - ProcessingEnvironment

Returns:

whether or not type is a functional interface type (as defined in JLS 9.8)

findFunction

public static com.sun.tools.javac.code.Symbol findFunction(com.sun.source.tree.Tree tree,
                                                           javax.annotation.processing.ProcessingEnvironment env)

The type of the lambda or method reference tree is a functional interface type. This method returns the single abstract method declared by that functional interface. (The type of this method is referred to as the function type.)

Parameters:

tree - lambda or member reference tree

env - ProcessingEnvironment

Returns:

the single abstract method declared by the type of the tree