org.checkerframework.dataflow.expression

Class Receiver

java.lang.Object

org.checkerframework.dataflow.expression.Receiver

Direct Known Subclasses:

ArrayAccess, ArrayCreation, BinaryOperation, ClassName, FieldAccess, LocalVariable, MethodCall, ThisReference, Unknown, ValueLiteral

public abstract class Receiver
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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Receiver(TypeMirror type) Create a Receiver (a Java AST node representing an expression).

Method Summary

Modifier and Type	Method and Description
boolean	containsModifiableAliasOf(Store<?> store, Receiver other) Returns true if and only if other appears anywhere in this receiver or an expression appears in this receiver such that other might alias this expression, and that expression is modifiable.
abstract boolean	containsOfClass(Class<? extends Receiver> clazz)
boolean	containsSyntacticEqualReceiver(Receiver other) Returns true if and only if this receiver contains a receiver that is syntactically equal to other.
boolean	containsUnknown()
TypeMirror	getType()
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.
boolean	syntacticEquals(Receiver other) Returns true if and only if the two receivers are syntactically identical.
String	toStringDebug() Print 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

Receiver

protected Receiver(TypeMirror type)

Create a Receiver (a Java AST node representing an expression).

Parameters:

type - the type of the expression

Method Detail

getType

public TypeMirror getType()

containsOfClass

public abstract boolean containsOfClass(Class<? extends Receiver> clazz)

containsUnknown

public boolean containsUnknown()

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 binary operations whose left and right operands are both 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 boolean syntacticEquals(Receiver other)

Returns true if and only if the two receivers are syntactically identical.

Parameters:

other - the other object to compare to this one

Returns:

true if and only if the two receivers are syntactically identical

containsSyntacticEqualReceiver

public boolean containsSyntacticEqualReceiver(Receiver other)

Returns true if and only if this receiver contains a receiver that is syntactically equal to other.

Returns:

true if and only if this receiver contains a receiver that is syntactically equal to other

containsModifiableAliasOf

public boolean containsModifiableAliasOf(Store<?> store,
                                         Receiver other)

Returns true if and only if other appears anywhere in this receiver or an expression appears in this receiver 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()

Print this verbosely, for debugging.

Returns:

a verbose string representation of this