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 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
List<Receiver>	arguments In a context for a method declaration or lambda, the formals.
BaseContext	checkerContext
Receiver	outerReceiver
boolean	parsingMember Whether or not the FlowExpressionParser is parsing the "member" part of a member select.
Receiver	receiver
boolean	useLocalScope Whether the TreePath should be used to find identifiers.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForClassDeclaration(ClassTree classTree, BaseContext checkerContext) Returns a FlowExpressionParseUtil.FlowExpressionContext for the class classTree as seen at the class declaration.
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForLambda(LambdaExpressionTree lambdaTree, TreePath path, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForMethodDeclaration(MethodTree methodDeclaration, Tree enclosingTree, BaseContext checkerContext) Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForMethodDeclaration(MethodTree methodDeclaration, TreePath currentPath, BaseContext checkerContext) Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForMethodDeclaration(MethodTree methodDeclaration, TypeMirror enclosingType, BaseContext checkerContext) Creates a FlowExpressionParseUtil.FlowExpressionContext for the method declared in methodDeclaration.
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).
static FlowExpressionParseUtil.FlowExpressionContext	buildContextForMethodUse(MethodInvocationTree methodInvocation, BaseContext checkerContext) Returns a FlowExpressionParseUtil.FlowExpressionContext for the method methodInvocation (represented as a MethodInvocationTree as seen at the method use (i.e., at a method call site).
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).
FlowExpressionParseUtil.FlowExpressionContext	copyAndSetUseLocalScope(boolean useLocalScope) Returns a copy of the context that differs in that useLocalScope is set to the given value.
FlowExpressionParseUtil.FlowExpressionContext	copyAndUseOuterReceiver() Returns a copy of the context that differs in that it uses the outer receiver as main receiver (and also retains it as the outer receiver), and parsingMember is set to false.
FlowExpressionParseUtil.FlowExpressionContext	copyChangeToParsingMemberOfReceiver(Receiver receiver) Returns a copy of the context that differs in that it has a different receiver and parsingMember is set to true.
String	toStringDebug() Format this object verbosely, with each line indented by 4 spaces but without a trailing newline.
String	toStringDebug(int indent) Format this object verbosely, with each line indented by the given number of spaces 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 Receiver receiver

arguments

public final List<Receiver> arguments

In a context for a method declaration or lambda, the formals. In a context for a method invocation, the actuals. In a context for a class declaration, an empty list.

outerReceiver

public final 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 final boolean useLocalScope

Whether the TreePath should be used to find identifiers. Defaults to true.

Constructor Detail

FlowExpressionContext

public FlowExpressionContext(Receiver receiver,
                             List<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 Receivers

Method Detail

buildContextForMethodDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForMethodDeclaration(MethodTree methodDeclaration,
                                                                                             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 Receiver

Returns:

context created of methodDeclaration

buildContextForMethodDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForMethodDeclaration(MethodTree methodDeclaration,
                                                                                             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 Receiver

Returns:

context created of methodDeclaration

buildContextForLambda

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForLambda(LambdaExpressionTree lambdaTree,
                                                                                  TreePath path,
                                                                                  BaseContext checkerContext)

buildContextForMethodDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForMethodDeclaration(MethodTree methodDeclaration,
                                                                                             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 Receiver

Returns:

context created of methodDeclaration

buildContextForClassDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildContextForClassDeclaration(ClassTree classTree,
                                                                                            BaseContext checkerContext)

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

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).

Returns:

a FlowExpressionParseUtil.FlowExpressionContext for the method methodInvocation

buildContextForMethodUse

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

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

Returns:

a FlowExpressionParseUtil.FlowExpressionContext for the method methodInvocation

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).

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(Receiver 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.

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 retains it as the outer receiver), and parsingMember is set to false.

copyAndSetUseLocalScope

public FlowExpressionParseUtil.FlowExpressionContext copyAndSetUseLocalScope(boolean useLocalScope)

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

toStringDebug

public String toStringDebug()

Format this object verbosely, with each line indented by 4 spaces but without a trailing newline.

Returns:

a verbose string representation of this

toStringDebug

public String toStringDebug(int indent)

Format this object verbosely, with each line indented by the given number of spaces but without a trailing newline.

Parameters:

indent - the number of spaces to indent the string representation of this

Returns:

a verbose string representation of this