org.checkerframework.javacutil

Class Resolver

java.lang.Object

org.checkerframework.javacutil.Resolver

public class Resolver
extends Object

A Utility class to find symbols corresponding to string references.

Constructor Summary

Constructors

Constructor and Description
Resolver(ProcessingEnvironment env)

Method Summary

Modifier and Type	Method and Description
protected Object	buildMethodContext() Build an instance of Resolve$MethodResolutionContext.
Element	findClass(String name, TreePath path) Finds the class literal with name name.
@Nullable com.sun.tools.javac.code.Symbol.ClassSymbol	findClassInPackage(String name, com.sun.tools.javac.code.Symbol.PackageSymbol pck, TreePath path) Finds the class with name name in a given package.
@Nullable VariableElement	findField(String name, TypeMirror type, TreePath path) Finds the field with name name in a given type.
@Nullable VariableElement	findLocalVariableOrParameterOrField(String name, TreePath path) Finds the local variable with name name in the given scope.
Element	findMethod(String methodName, TypeMirror receiverType, TreePath path, List<TypeMirror> argumentTypes) Finds the method element for a given name and list of expected parameter types.
@Nullable com.sun.tools.javac.code.Symbol.PackageSymbol	findPackage(String name, TreePath path) Finds the package with name name.
com.sun.tools.javac.comp.Env<com.sun.tools.javac.comp.AttrContext>	getEnvForPath(TreePath path) Determine the environment for the given path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Resolver

public Resolver(ProcessingEnvironment env)

Method Detail

getEnvForPath

public com.sun.tools.javac.comp.Env<com.sun.tools.javac.comp.AttrContext> getEnvForPath(TreePath path)

Determine the environment for the given path.

Parameters:

path - the tree path to the local scope

Returns:

the corresponding attribution environment

findPackage

public @Nullable com.sun.tools.javac.code.Symbol.PackageSymbol findPackage(String name,
                                                                           TreePath path)

Finds the package with name name.

Parameters:

name - the name of the package

path - the tree path to the local scope

Returns:

the PackageSymbol for the package if it is found, null otherwise

findField

public @Nullable VariableElement findField(String name,
                                           TypeMirror type,
                                           TreePath path)

Finds the field with name name in a given type.

The method adheres to all the rules of Java's scoping (while also considering the imports) for name resolution.

Parameters:

name - the name of the field

type - the type of the receiver (i.e., the type in which to look for the field).

path - the tree path to the local scope

Returns:

the element for the field, null otherwise

findLocalVariableOrParameterOrField

public @Nullable VariableElement findLocalVariableOrParameterOrField(String name,
                                                                     TreePath path)

Finds the local variable with name name in the given scope.

Parameters:

name - the name of the local variable

path - the tree path to the local scope

Returns:

the element for the local variable, null otherwise

findClass

public Element findClass(String name,
                         TreePath path)

Finds the class literal with name name.

The method adheres to all the rules of Java's scoping (while also considering the imports) for name resolution.

Parameters:

name - the name of the class

path - the tree path to the local scope

Returns:

the element for the class

findClassInPackage

public @Nullable com.sun.tools.javac.code.Symbol.ClassSymbol findClassInPackage(String name,
                                                                                com.sun.tools.javac.code.Symbol.PackageSymbol pck,
                                                                                TreePath path)

Finds the class with name name in a given package.

Parameters:

name - the name of the class

pck - the PackageSymbol for the package

path - the tree path to the local scope

Returns:

the ClassSymbol for the class if it is found, null otherwise

findMethod

public Element findMethod(String methodName,
                          TypeMirror receiverType,
                          TreePath path,
                          List<TypeMirror> argumentTypes)

Finds the method element for a given name and list of expected parameter types.

The method adheres to all the rules of Java's scoping (while also considering the imports) for name resolution.

Parameters:

methodName - name of the method to find

receiverType - type of the receiver of the method

path - tree path

Returns:

the method element (if found)

buildMethodContext

protected Object buildMethodContext()
                             throws ClassNotFoundException,
                                    InstantiationException,
                                    IllegalAccessException,
                                    InvocationTargetException,
                                    NoSuchFieldException

Build an instance of Resolve$MethodResolutionContext.

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

InvocationTargetException

NoSuchFieldException