JavaExpression (checker-framework 3.20.0 API)

java.lang.Object
- org.checkerframework.dataflow.expression.JavaExpression

Direct Known Subclasses:

ArrayAccess, ArrayCreation, BinaryOperation, ClassName, FieldAccess, FormalParameter, LocalVariable, MethodCall, ThisReference, UnaryOperation, Unknown, ValueLiteral
```
public abstract class JavaExpression
extends Object
```
This class represents a Java expression and its type. It does not represent all possible Java expressions (for example, it does not represent a ternary conditional expression ?:; use Unknown for unrepresentable expressions).
This class's representation is like an AST: subparts are also expressions. For declared names (fields, local variables, and methods), it also contains an Element.
Each subclass represents a different type of expression, such as MethodCall, ArrayAccess, LocalVariable, etc.

See Also:

the syntax of Java expressions supported by the Checker Framework

Field Summary

Fields
Modifier and Type Field and Description

protected TypeMirror type
The type of this expression.

Fields
Modifier and Type	Field and Description
`protected TypeMirror`	`type` The type of this expression.

Constructor Summary

Constructors
Modifier Constructor and Description

protected JavaExpression(TypeMirror type)
Create a JavaExpression.

Constructors
Modifier	Constructor and Description
`protected`	`JavaExpression(TypeMirror type)` Create a JavaExpression.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract <R,P> R`	`accept(JavaExpressionVisitor<R,P> visitor, P p)` Accept method of the visitor pattern.
`JavaExpression`	`atConstructorInvocation(NewClassTree newClassTree)` Viewpoint-adapts `this` to the `newClassTree`.
`JavaExpression`	`atFieldAccess(JavaExpression receiver)` Viewpoint-adapts `this` to a field access with receiver `receiver`.
`JavaExpression`	`atMethodBody(MethodTree methodTree)` Viewpoint-adapts `this` to the `methodTree` by converting any `FormalParameter` into `LocalVariable`s.
`JavaExpression`	`atMethodInvocation(MethodInvocationNode invocationNode)` Viewpoint-adapts `this` to the `invocationNode`.
`JavaExpression`	`atMethodInvocation(MethodInvocationTree methodInvocationTree)` Viewpoint-adapts `this` to the `methodInvocationTree`.
`boolean`	`containsModifiableAliasOf(Store<?> store, JavaExpression other)` Returns true if and only if `other` appears anywhere in this or an expression appears in this such that `other` might alias this expression, and that expression is modifiable.
`abstract boolean`	`containsOfClass(Class<? extends JavaExpression> clazz)`
`abstract boolean`	`containsSyntacticEqualJavaExpression(JavaExpression other)` Returns true if and only if this contains a JavaExpression that is syntactically equal to `other`.
`boolean`	`containsUnknown()`
`static ArrayAccess`	`fromArrayAccess(ArrayAccessNode node)` Returns the internal representation (as `FieldAccess`) of a `FieldAccessNode`.
`static JavaExpression`	`fromNode(Node receiverNode)` We ignore operations such as widening and narrowing when computing the internal representation.
`static JavaExpression`	`fromNodeFieldAccess(FieldAccessNode node)` Returns the Java expression for a `FieldAccessNode`.
`static JavaExpression`	`fromTree(ExpressionTree tree)` Converts a javac `ExpressionTree` to a CF JavaExpression.
`static JavaExpression`	`fromVariableTree(VariableTree tree)` Returns the Java expression corresponding to the given variable tree `tree`.
`static List<FormalParameter>`	`getFormalParameters(ExecutableElement methodEle)` Returns the parameters of `methodEle` as `FormalParameter`s.
`static JavaExpression`	`getImplicitReceiver(Element ele)` Returns the implicit receiver of ele.
`static List<JavaExpression>`	`getParametersAsLocalVariables(ExecutableElement methodEle)` Returns the parameters of `methodEle` as `LocalVariable`s.
`static JavaExpression`	`getPseudoReceiver(TreePath path, TypeMirror enclosingType)` Returns either a new ClassName or ThisReference JavaExpression object for the enclosingType.
`static JavaExpression`	`getReceiver(ExpressionTree accessTree)` Returns the receiver of the given invocation
`TypeMirror`	`getType()`
`abstract boolean`	`isDeterministic(AnnotationProvider provider)` Returns true if the expression is deterministic.
`abstract boolean`	`isUnassignableByOtherCode()` Returns true if and only if the value this expression stands for cannot be changed (with respect to ==) by a method call.
`abstract boolean`	`isUnmodifiableByOtherCode()` Returns true if and only if the value this expression stands for cannot be changed by a method call, including changes to any of its fields.
`static boolean`	`listContainsSyntacticEqualJavaExpression(List<? extends JavaExpression> list, JavaExpression other)` Returns true if the given list contains a JavaExpression that is syntactically equal to `other`.
`static boolean`	`listIsDeterministic(List<? extends JavaExpression> list, AnnotationProvider provider)` Returns true if all the expressions in the list are deterministic.
`abstract boolean`	`syntacticEquals(JavaExpression je)` Returns true if and only if the two Java expressions are syntactically identical.
`String`	`toStringDebug()` Format this verbosely, for debugging.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - type
```
protected final TypeMirror type
```
    The type of this expression.
- Constructor Detail
  - JavaExpression
```
protected JavaExpression(TypeMirror type)
```
    Create a JavaExpression.
    
    Parameters:
    
    type - the type of the expression
- Method Detail
  - getType
```
public TypeMirror getType()
```
  - containsOfClass
```
public abstract boolean containsOfClass(Class<? extends JavaExpression> clazz)
```
  - containsUnknown
```
public boolean containsUnknown()
```
  - isDeterministic
```
public abstract boolean isDeterministic(AnnotationProvider provider)
```
    Returns true if the expression is deterministic.
    
    Parameters:
    
    provider - an annotation provider (a type factory)
    
    Returns:
    
    true if this expression is deterministic
  - listIsDeterministic
```
public static boolean listIsDeterministic(List<? extends JavaExpression> list,
                                          AnnotationProvider provider)
```
    Returns true if all the expressions in the list are deterministic.
    
    Parameters:
    
    list - the list whose elements to test
    
    provider - an annotation provider (a type factory)
    
    Returns:
    
    true if all the expressions in the list are deterministic
  - isUnassignableByOtherCode
```
public abstract boolean isUnassignableByOtherCode()
```
    Returns true if and only if the value this expression stands for cannot be changed (with respect to ==) by a method call. This is the case for local variables, the self reference, final field accesses whose receiver is isUnassignableByOtherCode(), and operations whose operands are all isUnmodifiableByOtherCode().
    
    See Also:
    
    isUnmodifiableByOtherCode()
  - isUnmodifiableByOtherCode
```
public abstract boolean isUnmodifiableByOtherCode()
```
    Returns true if and only if the value this expression stands for cannot be changed by a method call, including changes to any of its fields.
    Approximately, this returns true if the expression is isUnassignableByOtherCode() and its type is immutable.
    
    See Also:
    
    isUnassignableByOtherCode()
  - syntacticEquals
```
@EqualsMethod
public abstract boolean syntacticEquals(JavaExpression je)
```
    Returns true if and only if the two Java expressions are syntactically identical.
    This exists for use by containsSyntacticEqualJavaExpression(org.checkerframework.dataflow.expression.JavaExpression).
    
    Parameters:
    
    je - the other Java expression to compare to this one
    
    Returns:
    
    true if and only if the two Java expressions are syntactically identical
  - containsSyntacticEqualJavaExpression
```
public abstract boolean containsSyntacticEqualJavaExpression(JavaExpression other)
```
    Returns true if and only if this contains a JavaExpression that is syntactically equal to other.
    
    Parameters:
    
    other - the JavaExpression to search for
    
    Returns:
    
    true if and only if this contains a JavaExpression that is syntactically equal to other
  - listContainsSyntacticEqualJavaExpression
```
public static boolean listContainsSyntacticEqualJavaExpression(List<? extends JavaExpression> list,
                                                               JavaExpression other)
```
    Returns true if the given list contains a JavaExpression that is syntactically equal to other.
    
    Parameters:
    
    list - the list in which to search for a match
    
    other - the JavaExpression to search for
    
    Returns:
    
    true if and only if the list contains a JavaExpression that is syntactically equal to other
  - containsModifiableAliasOf
```
public boolean containsModifiableAliasOf(Store<?> store,
                                         JavaExpression other)
```
    Returns true if and only if other appears anywhere in this or an expression appears in this such that other might alias this expression, and that expression is modifiable.
    This is always true, except for cases where the Java type information prevents aliasing and none of the subexpressions can alias 'other'.
  - toStringDebug
```
public String toStringDebug()
```
    Format this verbosely, for debugging.
    
    Returns:
    
    a verbose string representation of this
  - fromNodeFieldAccess
```
public static JavaExpression fromNodeFieldAccess(FieldAccessNode node)
```
    Returns the Java expression for a FieldAccessNode. The result may contain Unknown as receiver.
    
    Parameters:
    
    node - the FieldAccessNode to convert to a JavaExpression
    
    Returns:
    
    the FieldAccess or ClassName that corresponds to node
  - fromArrayAccess
```
public static ArrayAccess fromArrayAccess(ArrayAccessNode node)
```
    Returns the internal representation (as FieldAccess) of a FieldAccessNode. The result may contain Unknown as receiver.
    
    Parameters:
    
    node - the ArrayAccessNode to convert to a JavaExpression
    
    Returns:
    
    the internal representation (as FieldAccess) of a FieldAccessNode. Can contain Unknown as receiver.
  - fromNode
```
public static JavaExpression fromNode(Node receiverNode)
```
    We ignore operations such as widening and narrowing when computing the internal representation.
    
    Parameters:
    
    receiverNode - a node to convert to a JavaExpression
    
    Returns:
    
    the internal representation of the given node. Might contain Unknown.
  - fromTree
```
public static JavaExpression fromTree(ExpressionTree tree)
```
    Converts a javac ExpressionTree to a CF JavaExpression. The result might contain Unknown.
    We ignore operations such as widening and narrowing when computing the JavaExpression.
    
    Parameters:
    
    tree - a javac tree
    
    Returns:
    
    a JavaExpression for the given javac tree
  - fromVariableTree
```
public static JavaExpression fromVariableTree(VariableTree tree)
```
    Returns the Java expression corresponding to the given variable tree tree.
    
    Parameters:
    
    tree - a variable tree
    
    Returns:
    
    a JavaExpression for tree
  - getParametersAsLocalVariables
```
public static List<JavaExpression> getParametersAsLocalVariables(ExecutableElement methodEle)
```
    Returns the parameters of methodEle as LocalVariables.
    
    Parameters:
    
    methodEle - the method element
    
    Returns:
    
    list of parameters as LocalVariables
  - getFormalParameters
```
public static List<FormalParameter> getFormalParameters(ExecutableElement methodEle)
```
    Returns the parameters of methodEle as FormalParameters.
    
    Parameters:
    
    methodEle - the method element
    
    Returns:
    
    list of parameters as FormalParameters
  - getReceiver
```
public static JavaExpression getReceiver(ExpressionTree accessTree)
```
    Returns the receiver of the given invocation
    
    Parameters:
    
    accessTree - method or constructor invocation
    
    Returns:
    
    the receiver of the given invocation
  - getImplicitReceiver
```
public static JavaExpression getImplicitReceiver(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 - a field, method, or class
    
    Returns:
    
    either a new ClassName or a new ThisReference depending on whether ele is static or not
  - getPseudoReceiver
```
public static JavaExpression getPseudoReceiver(TreePath path,
                                               TypeMirror enclosingType)
```
    Returns either a new ClassName or ThisReference JavaExpression 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 JavaExpression object for the enclosingType
  - accept
```
public abstract <R,P> R accept(JavaExpressionVisitor<R,P> visitor,
                               P p)
```
    Accept method of the visitor pattern.
    
    Type Parameters:
    
    R - result type of the operation
    
    P - parameter type
    
    Parameters:
    
    visitor - the visitor to be applied to this JavaExpression
    
    p - the parameter for this operation
    
    Returns:
    
    the result of visiting this
  - atFieldAccess
```
public JavaExpression atFieldAccess(JavaExpression receiver)
```
    Viewpoint-adapts this to a field access with receiver receiver.
    
    Parameters:
    
    receiver - receiver of the field access
    
    Returns:
    
    viewpoint-adapted version of this
  - atMethodBody
```
public final JavaExpression atMethodBody(MethodTree methodTree)
```
    Viewpoint-adapts this to the methodTree by converting any FormalParameter into LocalVariables.
    
    Parameters:
    
    methodTree - method declaration tree
    
    Returns:
    
    viewpoint-adapted version of this
  - atMethodInvocation
```
public final JavaExpression atMethodInvocation(MethodInvocationTree methodInvocationTree)
```
    Viewpoint-adapts this to the methodInvocationTree.
    
    Parameters:
    
    methodInvocationTree - method invocation
    
    Returns:
    
    viewpoint-adapted version of this
  - atMethodInvocation
```
public final JavaExpression atMethodInvocation(MethodInvocationNode invocationNode)
```
    Viewpoint-adapts this to the invocationNode.
    
    Parameters:
    
    invocationNode - method invocation
    
    Returns:
    
    viewpoint-adapted version of this
  - atConstructorInvocation
```
public JavaExpression atConstructorInvocation(NewClassTree newClassTree)
```
    Viewpoint-adapts this to the newClassTree.
    
    Parameters:
    
    newClassTree - constructor invocation
    
    Returns:
    
    viewpoint-adapted version of this

Class JavaExpression

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

Constructor Detail

JavaExpression

Method Detail

getType

containsOfClass

containsUnknown

isDeterministic

listIsDeterministic

isUnassignableByOtherCode

isUnmodifiableByOtherCode

syntacticEquals

containsSyntacticEqualJavaExpression

listContainsSyntacticEqualJavaExpression

containsModifiableAliasOf

toStringDebug

fromNodeFieldAccess

fromArrayAccess

fromNode

fromTree

fromVariableTree

getParametersAsLocalVariables

getFormalParameters

getReceiver

getImplicitReceiver

getPseudoReceiver

accept

atFieldAccess

atMethodBody

atMethodInvocation

atMethodInvocation

atConstructorInvocation