org.checkerframework.framework.util

Class JavaExpressionParseUtil.JavaExpressionContext

java.lang.Object

org.checkerframework.framework.util.JavaExpressionParseUtil.JavaExpressionContext

Enclosing class:

JavaExpressionParseUtil

public static class JavaExpressionParseUtil.JavaExpressionContext
extends Object

Context used to parse a Java expression. When parsing expression E in annotation @A(E), the context is the program element that is annotated by @A(E).

Field Summary

Fields

Modifier and Type	Field and Description
List<JavaExpression>	arguments In a context for a method declaration or lambda, the formals.
BaseContext	checkerContext The checker context.
boolean	parsingMember Whether or not the FlowExpressionParser is parsing the "member" part of a member select.
JavaExpression	receiver The value of this in this context.
boolean	useLocalScope Whether the TreePath should be used to find identifiers.

Constructor Summary

Constructors

Constructor and Description
JavaExpressionContext(JavaExpression receiver, List<JavaExpression> arguments, BaseContext checkerContext) Creates a context for parsing a Java expression.

Method Summary

Modifier and Type	Method and Description
static JavaExpressionParseUtil.JavaExpressionContext	buildContextForClassDeclaration(ClassTree classTree, BaseContext checkerContext) Returns a JavaExpressionParseUtil.JavaExpressionContext for the class classTree as seen at the class declaration.
static JavaExpressionParseUtil.JavaExpressionContext	buildContextForLambda(LambdaExpressionTree lambdaTree, TreePath path, BaseContext checkerContext) Creates a JavaExpressionParseUtil.JavaExpressionContext for the given lambda.
static JavaExpressionParseUtil.JavaExpressionContext	buildContextForMethodDeclaration(MethodTree methodDeclaration, Tree enclosingTree, BaseContext checkerContext) Creates a JavaExpressionParseUtil.JavaExpressionContext for the method declared in methodDeclaration.
static JavaExpressionParseUtil.JavaExpressionContext	buildContextForMethodDeclaration(MethodTree methodDeclaration, TreePath currentPath, BaseContext checkerContext) Creates a JavaExpressionParseUtil.JavaExpressionContext for the method declared in methodDeclaration.
static JavaExpressionParseUtil.JavaExpressionContext	buildContextForMethodDeclaration(MethodTree methodDeclaration, TypeMirror enclosingType, BaseContext checkerContext) Creates a JavaExpressionParseUtil.JavaExpressionContext for the method declared in methodDeclaration.
static JavaExpressionParseUtil.JavaExpressionContext	buildContextForMethodUse(MethodInvocationNode methodInvocation, BaseContext checkerContext) Returns a JavaExpressionParseUtil.JavaExpressionContext for the method called by methodInvocation, as seen at the method use (i.e., at the call site).
static JavaExpressionParseUtil.JavaExpressionContext	buildContextForMethodUse(MethodInvocationTree methodInvocation, BaseContext checkerContext) Returns a JavaExpressionParseUtil.JavaExpressionContext for the method called by methodInvocation, as seen at the method use (i.e., at the call site).
static JavaExpressionParseUtil.JavaExpressionContext	buildContextForNewClassUse(ObjectCreationNode n, BaseContext checkerContext) Returns a JavaExpressionParseUtil.JavaExpressionContext for the constructor n (represented as a Node as seen at the constructor use (i.e., at a "new" expression).
JavaExpressionParseUtil.JavaExpressionContext	copyAndSetUseLocalScope(boolean useLocalScope) Returns a copy of the context that differs in that useLocalScope is set to the given value.
JavaExpressionParseUtil.JavaExpressionContext	copyChangeToParsingMemberOfReceiver(JavaExpression receiver) Returns a copy of the context that differs in that it has a different receiver and parsingMember is set to true.
JavaExpressionParseUtil.JavaExpressionContext	copyNotParsingMember() Returns a copy of the context that differs in that parsingMember is set to false.
String	toStringDebug() Format this object verbosely, on multiple lines but without a trailing newline.

Methods inherited from class java.lang.Object

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

Field Detail

receiver

public final JavaExpression receiver

The value of this in this context.

arguments

public final List<JavaExpression> arguments

In a context for a method declaration or lambda, the formals. In a context for a method invocation, the actuals. In other contexts, null.

checkerContext

public final BaseContext checkerContext

The checker context.

parsingMember

public final boolean parsingMember

Whether or not the FlowExpressionParser is parsing the "member" part of a member select. If so, certain constructs like "#2" and local variables cannot occur.

useLocalScope

public final boolean useLocalScope

Whether the TreePath should be used to find identifiers.

Constructor Detail

JavaExpressionContext

public JavaExpressionContext(JavaExpression receiver,
                             List<JavaExpression> arguments,
                             BaseContext checkerContext)

Creates a context for parsing a Java expression.

Parameters:

receiver - used to replace "this" in a Java expression and used to resolve identifiers in any Java expression with an implicit "this"

arguments - used to replace parameter references, e.g. #1, in Java expressions, null if no arguments

checkerContext - used to create JavaExpressions

Method Detail

buildContextForMethodDeclaration

public static JavaExpressionParseUtil.JavaExpressionContext buildContextForMethodDeclaration(MethodTree methodDeclaration,
                                                                                             Tree enclosingTree,
                                                                                             BaseContext checkerContext)

Creates a JavaExpressionParseUtil.JavaExpressionContext for the method declared in methodDeclaration.

Parameters:

methodDeclaration - used to translate parameter numbers in a Java expression to formal parameters of the method

enclosingTree - used to look up fields and as the type of "this" in Java expressions

checkerContext - used to build JavaExpression

Returns:

context created from methodDeclaration

buildContextForMethodDeclaration

public static JavaExpressionParseUtil.JavaExpressionContext buildContextForMethodDeclaration(MethodTree methodDeclaration,
                                                                                             TreePath currentPath,
                                                                                             BaseContext checkerContext)

Creates a JavaExpressionParseUtil.JavaExpressionContext for the method declared in methodDeclaration.

Parameters:

methodDeclaration - used to translate parameter numbers in a Java expression to formal parameters of the method

currentPath - the path to the method. It is used to find the enclosing class, which is used to look up fields and as the type of "this" in Java expressions.

checkerContext - used to build JavaExpression

Returns:

context created from methodDeclaration

buildContextForMethodDeclaration

public static JavaExpressionParseUtil.JavaExpressionContext buildContextForMethodDeclaration(MethodTree methodDeclaration,
                                                                                             TypeMirror enclosingType,
                                                                                             BaseContext checkerContext)

Creates a JavaExpressionParseUtil.JavaExpressionContext for the method declared in methodDeclaration.

Parameters:

methodDeclaration - used to translate parameter numbers in a Java expression to formal parameters of the method

enclosingType - used to look up fields and as type of "this" in Java expressions

checkerContext - used to build JavaExpression

Returns:

context created from methodDeclaration

buildContextForLambda

public static JavaExpressionParseUtil.JavaExpressionContext buildContextForLambda(LambdaExpressionTree lambdaTree,
                                                                                  TreePath path,
                                                                                  BaseContext checkerContext)

Creates a JavaExpressionParseUtil.JavaExpressionContext for the given lambda.

Parameters:

lambdaTree - a lambda

path - the path to the lambda

checkerContext - used to build JavaExpression

Returns:

context created for lambdaTree

buildContextForClassDeclaration

public static JavaExpressionParseUtil.JavaExpressionContext buildContextForClassDeclaration(ClassTree classTree,
                                                                                            BaseContext checkerContext)

Returns a JavaExpressionParseUtil.JavaExpressionContext for the class classTree as seen at the class declaration.

Parameters:

classTree - a class

checkerContext - used to build JavaExpression

Returns:

a JavaExpressionParseUtil.JavaExpressionContext for the class classTree as seen at the class declaration

buildContextForMethodUse

public static JavaExpressionParseUtil.JavaExpressionContext buildContextForMethodUse(MethodInvocationNode methodInvocation,
                                                                                     BaseContext checkerContext)

Returns a JavaExpressionParseUtil.JavaExpressionContext for the method called by methodInvocation, as seen at the method use (i.e., at the call site).

Parameters:

methodInvocation - a method invocation

checkerContext - the javac components to use

Returns:

a JavaExpressionParseUtil.JavaExpressionContext for the method methodInvocation

buildContextForMethodUse

public static JavaExpressionParseUtil.JavaExpressionContext buildContextForMethodUse(MethodInvocationTree methodInvocation,
                                                                                     BaseContext checkerContext)

Returns a JavaExpressionParseUtil.JavaExpressionContext for the method called by methodInvocation, as seen at the method use (i.e., at the call site).

Parameters:

methodInvocation - a method invocation

checkerContext - the javac components to use

Returns:

a JavaExpressionParseUtil.JavaExpressionContext for the method methodInvocation

buildContextForNewClassUse

public static JavaExpressionParseUtil.JavaExpressionContext buildContextForNewClassUse(ObjectCreationNode n,
                                                                                       BaseContext checkerContext)

Returns a JavaExpressionParseUtil.JavaExpressionContext for the constructor n (represented as a Node as seen at the constructor use (i.e., at a "new" expression).

Parameters:

n - an object creation node

checkerContext - the checker context

Returns:

a JavaExpressionParseUtil.JavaExpressionContext for the constructor n (represented as a Node as seen at the constructor use (i.e., at a "new" expression)

copyChangeToParsingMemberOfReceiver

public JavaExpressionParseUtil.JavaExpressionContext copyChangeToParsingMemberOfReceiver(JavaExpression receiver)

Returns a copy of the context that differs in that it has a different receiver and parsingMember is set to true. The outer receiver remains unchanged.

Parameters:

receiver - the receiver for the newly-returned context

Returns:

a copy of the context, with the given receiver

copyNotParsingMember

public JavaExpressionParseUtil.JavaExpressionContext copyNotParsingMember()

Returns a copy of the context that differs in that parsingMember is set to false.

Returns:

a copy of the context, with parsingMember set to false

copyAndSetUseLocalScope

public JavaExpressionParseUtil.JavaExpressionContext copyAndSetUseLocalScope(boolean useLocalScope)

Returns a copy of the context that differs in that useLocalScope is set to the given value.

Parameters:

useLocalScope - whether the local scope should be used to resolve identifiers

Returns:

a copy of the context, with useLocalScope is set to the given value

toStringDebug

public String toStringDebug()

Format this object verbosely, on multiple lines but without a trailing newline.

Returns:

a verbose string representation of this