org.checkerframework.framework.util

Interface StringToJavaExpression

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface StringToJavaExpression

This interface is both a functional interface, see toJavaExpression(String), and also a collection of static methods that convert a string to a JavaExpression at common locations.

Some conversion routines merely do parsing. Other conversion routines parse and then transform the result of parsing into another JavaExpression; for all the static methods, this transformation is viewpoint-adaptation.

To parse a string "at a location" means to parse it as if it were written in an annotation that is written on that location.

Method Summary

Modifier and Type	Method and Description
static JavaExpression	atConstructorInvocation(String expression, NewClassTree newClassTree, SourceChecker checker) Parses a string as if it were written at the declaration of the invoked constructor and then viewpoint-adapts the result to the call site.
static JavaExpression	atFieldAccess(String expression, MemberSelectTree fieldAccess, SourceChecker checker) uf found Parses a string as if it were written at the declaration of the field and then viewpoint-adapts the result to the use.
static JavaExpression	atFieldDecl(String expression, VariableElement fieldElement, SourceChecker checker) Parses a string to a JavaExpression as if it were written at fieldElement.
static JavaExpression	atLambdaParameter(String expression, LambdaExpressionTree lambdaTree, TreePath parentPath, SourceChecker checker) Parses a string as if it were written at one of the parameters of lambdaTree.
static JavaExpression	atMethodBody(String expression, MethodTree methodTree, SourceChecker checker) Parses a string to a JavaExpression as if it were written at methodTree.
static JavaExpression	atMethodDecl(String expression, ExecutableElement method, SourceChecker checker) Parses a string to a JavaExpression as if it were written at method.
static JavaExpression	atMethodInvocation(String expression, MethodInvocationNode methodInvocationNode, SourceChecker checker) Parses a string as if it were written at the declaration of the invoked method and then viewpoint-adapts the result to the call site.
static JavaExpression	atMethodInvocation(String expression, MethodInvocationTree methodInvocationTree, SourceChecker checker) Parses a string as if it were written at the declaration of the invoked method and then viewpoint-adapts the result to the call site.
static JavaExpression	atPath(String expression, TreePath localVarPath, SourceChecker checker) Parses a string as if it were written at localVarPath.
static JavaExpression	atTypeDecl(String expression, TypeElement typeElement, SourceChecker checker) Parses a string to a JavaExpression as if it were written at typeElement.
@Nullable JavaExpression	toJavaExpression(String stringExpr) Convert a string to a JavaExpression.

Method Detail

toJavaExpression

@Nullable JavaExpression toJavaExpression(String stringExpr)
                                   throws JavaExpressionParseUtil.JavaExpressionParseException

Convert a string to a JavaExpression. Returns null if no conversion exists.

Conversion includes parsing stringExpr to a JavaExpression and optionally transforming the result of parsing into another JavaExpression. An example of transformation is viewpoint adaptation.

Parameters:

stringExpr - a Java expression

Returns:

a JavaExpression or null if no conversion from stringExpr exists

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if stringExpr cannot be parsed to a JavaExpression

atTypeDecl

static JavaExpression atTypeDecl(String expression,
                                 TypeElement typeElement,
                                 SourceChecker checker)
                          throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string to a JavaExpression as if it were written at typeElement.

Parameters:

expression - a Java expression to parse

typeElement - type element at which expression is parsed

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atFieldDecl

static JavaExpression atFieldDecl(String expression,
                                  VariableElement fieldElement,
                                  SourceChecker checker)
                           throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string to a JavaExpression as if it were written at fieldElement.

Parameters:

expression - a Java expression to parse

fieldElement - variable element at which expression is parsed

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atMethodDecl

static JavaExpression atMethodDecl(String expression,
                                   ExecutableElement method,
                                   SourceChecker checker)
                            throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string to a JavaExpression as if it were written at method. The returned JavaExpression uses FormalParameters to represent parameters. Use atMethodBody(String, MethodTree, SourceChecker) if parameters should be LocalVariables instead.

Parameters:

expression - a Java expression to parse

method - method element at which expression is parsed

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atMethodBody

static JavaExpression atMethodBody(String expression,
                                   MethodTree methodTree,
                                   SourceChecker checker)
                            throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string to a JavaExpression as if it were written at methodTree. The returned JavaExpression uses LocalVariables to represent parameters. Use atMethodDecl(String, ExecutableElement, SourceChecker) if parameters should be FormalParameters instead.

Parameters:

expression - a Java expression to parse

methodTree - method declaration tree at which expression is parsed

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atMethodInvocation

static JavaExpression atMethodInvocation(String expression,
                                         MethodInvocationTree methodInvocationTree,
                                         SourceChecker checker)
                                  throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string as if it were written at the declaration of the invoked method and then viewpoint-adapts the result to the call site.

Parameters:

expression - a Java expression to parse

methodInvocationTree - method invocation tree

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atMethodInvocation

static JavaExpression atMethodInvocation(String expression,
                                         MethodInvocationNode methodInvocationNode,
                                         SourceChecker checker)
                                  throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string as if it were written at the declaration of the invoked method and then viewpoint-adapts the result to the call site.

Parameters:

expression - a Java expression to parse

methodInvocationNode - method invocation node

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atConstructorInvocation

static JavaExpression atConstructorInvocation(String expression,
                                              NewClassTree newClassTree,
                                              SourceChecker checker)
                                       throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string as if it were written at the declaration of the invoked constructor and then viewpoint-adapts the result to the call site.

Parameters:

expression - a Java expression to parse

newClassTree - constructor invocation

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atFieldAccess

static JavaExpression atFieldAccess(String expression,
                                    MemberSelectTree fieldAccess,
                                    SourceChecker checker)
                             throws JavaExpressionParseUtil.JavaExpressionParseException

uf found Parses a string as if it were written at the declaration of the field and then viewpoint-adapts the result to the use.

Parameters:

expression - a Java expression to parse

fieldAccess - the field access tree

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atLambdaParameter

static JavaExpression atLambdaParameter(String expression,
                                        LambdaExpressionTree lambdaTree,
                                        TreePath parentPath,
                                        SourceChecker checker)
                                 throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string as if it were written at one of the parameters of lambdaTree. Parameters of the lambda are expressed as LocalVariables.

Parameters:

expression - a Java expression to parse

lambdaTree - the lambda tree

parentPath - path to the parent of lambdaTree; required because the expression can reference final local variables of the enclosing method

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed

atPath

static JavaExpression atPath(String expression,
                             TreePath localVarPath,
                             SourceChecker checker)
                      throws JavaExpressionParseUtil.JavaExpressionParseException

Parses a string as if it were written at localVarPath.

Parameters:

expression - a Java expression to parse

localVarPath - location at which expression is parsed

checker - checker used to get the ProcessingEnvironment and current CompilationUnitTree

Returns:

a JavaExpression for expression

Throws:

JavaExpressionParseUtil.JavaExpressionParseException - if expression cannot be parsed