org.checkerframework.dataflow.analysis

Class FlowExpressions

java.lang.Object

org.checkerframework.dataflow.analysis.FlowExpressions

public class FlowExpressions
extends Object

Collection of classes and helper functions to represent Java expressions about which the org.checkerframework.dataflow analysis can possibly infer facts. Expressions include:

• Field accesses (e.g., o.f)
• Local variables (e.g., l)
• This reference (e.g., this)
• Pure method calls (e.g., o.m())
• Unknown other expressions to mark that something else was present.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlowExpressions.ArrayAccess An array access.
static class	FlowExpressions.ArrayCreation FlowExpression for array creations.
static class	FlowExpressions.ClassName A ClassName represents the occurrence of a class as part of a static field access or method invocation.
static class	FlowExpressions.FieldAccess
static class	FlowExpressions.LocalVariable
static class	FlowExpressions.MethodCall A call to a @Deterministic method.
static class	FlowExpressions.Receiver The poorly-named Receiver class is actually a Java AST.
static class	FlowExpressions.ThisReference
static class	FlowExpressions.Unknown
static class	FlowExpressions.ValueLiteral FlowExpression.Receiver for literals.

Constructor Summary

Constructors

Constructor and Description
FlowExpressions()

Method Summary

Modifier and Type	Method and Description
static @Nullable List<FlowExpressions.Receiver>	getParametersOfEnclosingMethod(AnnotationProvider annotationProvider, TreePath path) Returns Receiver objects for the formal parameters of the method in which path is enclosed.
static FlowExpressions.Receiver	internalReprOf(AnnotationProvider provider, ExpressionTree receiverTree)
static FlowExpressions.Receiver	internalReprOf(AnnotationProvider provider, ExpressionTree receiverTree, boolean allowNonDeterministic) We ignore operations such as widening and narrowing when computing the internal representation.
static FlowExpressions.Receiver	internalReprOf(AnnotationProvider provider, Node receiverNode) We ignore operations such as widening and narrowing when computing the internal representation.
static FlowExpressions.Receiver	internalReprOf(AnnotationProvider provider, Node receiverNode, boolean allowNonDeterministic) We ignore operations such as widening and narrowing when computing the internal representation.
static FlowExpressions.ArrayAccess	internalReprOfArrayAccess(AnnotationProvider provider, ArrayAccessNode node)
static FlowExpressions.FieldAccess	internalReprOfFieldAccess(AnnotationProvider provider, FieldAccessNode node)
static FlowExpressions.Receiver	internalReprOfImplicitReceiver(Element ele) Returns the implicit receiver of ele.
static FlowExpressions.Receiver	internalReprOfPseudoReceiver(TreePath path, TypeMirror enclosingType) Returns either a new ClassName or ThisReference Receiver object for the enclosingType.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowExpressions

public FlowExpressions()

Method Detail

internalReprOfFieldAccess

public static FlowExpressions.FieldAccess internalReprOfFieldAccess(AnnotationProvider provider,
                                                                    FieldAccessNode node)

Returns:

the internal representation (as FlowExpressions.FieldAccess) of a FieldAccessNode. Can contain FlowExpressions.Unknown as receiver.

internalReprOfArrayAccess

public static FlowExpressions.ArrayAccess internalReprOfArrayAccess(AnnotationProvider provider,
                                                                    ArrayAccessNode node)

Returns:

the internal representation (as FlowExpressions.FieldAccess) of a FieldAccessNode. Can contain FlowExpressions.Unknown as receiver.

internalReprOf

public static FlowExpressions.Receiver internalReprOf(AnnotationProvider provider,
                                                      Node receiverNode)

We ignore operations such as widening and narrowing when computing the internal representation.

Returns:

the internal representation (as FlowExpressions.Receiver) of any Node. Might contain FlowExpressions.Unknown.

internalReprOf

public static FlowExpressions.Receiver internalReprOf(AnnotationProvider provider,
                                                      Node receiverNode,
                                                      boolean allowNonDeterministic)

We ignore operations such as widening and narrowing when computing the internal representation.

Returns:

the internal representation (as FlowExpressions.Receiver) of any Node. Might contain FlowExpressions.Unknown.

internalReprOf

public static FlowExpressions.Receiver internalReprOf(AnnotationProvider provider,
                                                      ExpressionTree receiverTree)

Returns:

the internal representation (as FlowExpressions.Receiver) of any ExpressionTree. Might contain FlowExpressions.Unknown.

internalReprOf

public static FlowExpressions.Receiver internalReprOf(AnnotationProvider provider,
                                                      ExpressionTree receiverTree,
                                                      boolean allowNonDeterministic)

We ignore operations such as widening and narrowing when computing the internal representation.

Returns:

the internal representation (as FlowExpressions.Receiver) of any ExpressionTree. Might contain FlowExpressions.Unknown.

internalReprOfImplicitReceiver

public static FlowExpressions.Receiver internalReprOfImplicitReceiver(Element ele)

Returns the implicit receiver of ele.

Returns either a new ClassName or a new ThisReference depending on whether ele is static or not. The passed element must be a field, method, or class.

Parameters:

ele - field, method, or class

Returns:

either a new ClassName or a new ThisReference depending on whether ele is static or not

internalReprOfPseudoReceiver

public static FlowExpressions.Receiver internalReprOfPseudoReceiver(TreePath path,
                                                                    TypeMirror enclosingType)

Returns either a new ClassName or ThisReference Receiver object for the enclosingType.

The Tree should be an expression or a statement that does not have a receiver or an implicit receiver. For example, a local variable declaration.

Parameters:

path - TreePath to tree

enclosingType - type of the enclosing type

Returns:

a new ClassName or ThisReference that is a Receiver object for the enclosingType

getParametersOfEnclosingMethod

public static @Nullable List<FlowExpressions.Receiver> getParametersOfEnclosingMethod(AnnotationProvider annotationProvider,
                                                                                      TreePath path)

Returns Receiver objects for the formal parameters of the method in which path is enclosed.

Parameters:

annotationProvider - annotationProvider

path - TreePath that is enclosed by the method

Returns:

list of Receiver objects for the formal parameters of the method in which path is enclosed, null otherwise