org.checkerframework.framework.util

Class FlowExpressionParseUtil.FlowExpressionContext

java.lang.Object

org.checkerframework.framework.util.FlowExpressionParseUtil.FlowExpressionContext

Enclosing class:

FlowExpressionParseUtil

public static class FlowExpressionParseUtil.FlowExpressionContext
extends java.lang.Object

Context used to parse a flow expression. When parsing flow 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
java.util.List<FlowExpressions.Receiver>	arguments
BaseContext	checkerContext
FlowExpressions.Receiver	outerReceiver
boolean	parsingMember Whether or not the FlowExpressionParser is parsing the "member" part of a member select.
FlowExpressions.Receiver	receiver
boolean	useLocalScope Whether the TreePath should be used to find identifiers.

Constructor Summary

Constructors

Constructor and Description
FlowExpressionContext(FlowExpressions.Receiver receiver, java.util.List<FlowExpressions.Receiver> arguments, BaseContext checkerContext) Creates context for parsing a flow expression.

Method Summary

Modifier and Type	Method and Description
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForClassDeclaration(com.sun.source.tree.ClassTree classTree, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForLambda(com.sun.source.tree.LambdaExpressionTree lambdaTree, com.sun.source.util.TreePath path, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForMethodDeclaration(com.sun.source.tree.MethodTree methodDeclaration, com.sun.source.tree.Tree enclosingTree, BaseContext checkerContext) Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForMethodDeclaration(com.sun.source.tree.MethodTree methodDeclaration, com.sun.source.util.TreePath currentPath, BaseContext checkerContext) Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForMethodDeclaration(com.sun.source.tree.MethodTree methodDeclaration, javax.lang.model.type.TypeMirror enclosingType, BaseContext checkerContext) Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForMethodUse(MethodInvocationNode methodInvocation, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForNewClassUse(ObjectCreationNode n, BaseContext checkerContext)
FlowExpressionParseUtil.FlowExpressionContext	copyAndUseOuterReceiver() Returns a copy of the context that differs in that it uses the outer receiver as main receiver (and also uses it as the outer receiver).
FlowExpressionParseUtil.FlowExpressionContext	copyChangeToParsingMemberOfReceiver(FlowExpressions.Receiver receiver) Returns a copy of the context that differs in that it has a different receiver.

Methods inherited from class java.lang.Object

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

Field Detail

receiver

public final FlowExpressions.Receiver receiver

arguments

public final java.util.List<FlowExpressions.Receiver> arguments

outerReceiver

public final FlowExpressions.Receiver outerReceiver

checkerContext

public final BaseContext checkerContext

parsingMember

public final boolean parsingMember

Whether or not the FlowExpressionParser is parsing the "member" part of a member select.

useLocalScope

public boolean useLocalScope

Whether the TreePath should be used to find identifiers.

Constructor Detail

FlowExpressionContext

public FlowExpressionContext(FlowExpressions.Receiver receiver,
                             java.util.List<FlowExpressions.Receiver> arguments,
                             BaseContext checkerContext)

Creates context for parsing a flow expression.

Parameters:

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

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

checkerContext - used to create FlowExpressions.Receivers

Method Detail

buildContextForMethodDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForMethodDeclaration(com.sun.source.tree.MethodTree methodDeclaration,
                                                                                             com.sun.source.tree.Tree enclosingTree,
                                                                                             BaseContext checkerContext)

Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.

Parameters:

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

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

checkerContext - use to build FlowExpressions.Receiver

Returns:

context created of methodDeclaration

buildContextForMethodDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForMethodDeclaration(com.sun.source.tree.MethodTree methodDeclaration,
                                                                                             javax.lang.model.type.TypeMirror enclosingType,
                                                                                             BaseContext checkerContext)

Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.

Parameters:

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

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

checkerContext - use to build FlowExpressions.Receiver

Returns:

context created of methodDeclaration

buildContextForLambda

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForLambda(com.sun.source.tree.LambdaExpressionTree lambdaTree,
                                                                                  com.sun.source.util.TreePath path,
                                                                                  BaseContext checkerContext)

buildContextForMethodDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForMethodDeclaration(com.sun.source.tree.MethodTree methodDeclaration,
                                                                                             com.sun.source.util.TreePath currentPath,
                                                                                             BaseContext checkerContext)

Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.

Parameters:

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

currentPath - to find the enclosing class, which is used to look up fields and as type of "this" in flow expressions

checkerContext - use to build FlowExpressions.Receiver

Returns:

context created of methodDeclaration

buildContextForClassDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForClassDeclaration(com.sun.source.tree.ClassTree classTree,
                                                                                            BaseContext checkerContext)

Returns:

a FlowExpressionParseUtil.FlowExpressionContext for the class classTree as seen at the class declaration.

buildContextForMethodUse

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForMethodUse(MethodInvocationNode methodInvocation,
                                                                                     BaseContext checkerContext)

Returns:

a FlowExpressionParseUtil.FlowExpressionContext for the method methodInvocation (represented as a Node as seen at the method use (i.e., at a method call site).

buildContextForNewClassUse

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForNewClassUse(ObjectCreationNode n,
                                                                                       BaseContext checkerContext)

Returns:

a FlowExpressionParseUtil.FlowExpressionContext for the constructor n (represented as a Node as seen at the method use (i.e., at a method call site).

copyChangeToParsingMemberOfReceiver

public FlowExpressionParseUtil.FlowExpressionContext copyChangeToParsingMemberOfReceiver(FlowExpressions.Receiver receiver)

Returns a copy of the context that differs in that it has a different receiver. The outer receiver remains unchanged.

copyAndUseOuterReceiver

public FlowExpressionParseUtil.FlowExpressionContext copyAndUseOuterReceiver()

Returns a copy of the context that differs in that it uses the outer receiver as main receiver (and also uses it as the outer receiver).