org.checkerframework.dataflow.expression

Class FieldAccess

java.lang.Object

org.checkerframework.dataflow.expression.JavaExpression

org.checkerframework.dataflow.expression.FieldAccess

public class FieldAccess
extends JavaExpression

Field Summary

Fields

Modifier and Type	Field and Description
protected VariableElement	field
protected JavaExpression	receiver

Fields inherited from class org.checkerframework.dataflow.expression.JavaExpression

type

Constructor Summary

Constructors

Constructor and Description
FieldAccess(JavaExpression receiver, FieldAccessNode node)
FieldAccess(JavaExpression receiver, TypeMirror type, VariableElement fieldElement)

Method Summary

Modifier and Type	Method and Description
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.
boolean	containsOfClass(Class<? extends JavaExpression> clazz)
boolean	containsSyntacticEqualJavaExpression(JavaExpression other) Returns true if and only if this contains a JavaExpression that is syntactically equal to other.
boolean	equals(@Nullable Object obj)
VariableElement	getField()
JavaExpression	getReceiver()
int	hashCode()
boolean	isFinal()
boolean	isStatic()
boolean	isUnassignableByOtherCode() Returns true if and only if the value this expression stands for cannot be changed (with respect to ==) by a method call.
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(JavaExpression je) Returns true if and only if the two Java expressions are syntactically identical.
String	toString()
String	toStringDebug() Print this verbosely, for debugging.

Methods inherited from class org.checkerframework.dataflow.expression.JavaExpression

containsUnknown, fromArrayAccess, fromNode, fromNode, fromNodeFieldAccess, fromTree, fromTree, getImplicitReceiver, getParametersOfEnclosingMethod, getPseudoReceiver, getReceiver, getType, listContainsSyntacticEqualJavaExpression

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

receiver

protected final JavaExpression receiver

field

protected final VariableElement field

Constructor Detail

FieldAccess

public FieldAccess(JavaExpression receiver,
                   FieldAccessNode node)

FieldAccess

public FieldAccess(JavaExpression receiver,
                   TypeMirror type,
                   VariableElement fieldElement)

Method Detail

getReceiver

public JavaExpression getReceiver()

getField

public VariableElement getField()

isFinal

public boolean isFinal()

isStatic

public boolean isStatic()

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

containsModifiableAliasOf

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

Description copied from class: JavaExpression

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

Overrides:

containsModifiableAliasOf in class JavaExpression

containsSyntacticEqualJavaExpression

public boolean containsSyntacticEqualJavaExpression(JavaExpression other)

Description copied from class: JavaExpression

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

Specified by:

containsSyntacticEqualJavaExpression in class JavaExpression

Parameters:

other - the JavaExpression to search for

Returns:

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

syntacticEquals

public boolean syntacticEquals(JavaExpression je)

Description copied from class: JavaExpression

Returns true if and only if the two Java expressions are syntactically identical.

This exists for use by containsSyntacticEqualJavaExpression.

Specified by:

syntacticEquals in class 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

toString

public String toString()

Overrides:

toString in class Object

toStringDebug

public String toStringDebug()

Description copied from class: JavaExpression

Print this verbosely, for debugging.

Overrides:

toStringDebug in class JavaExpression

Returns:

a verbose string representation of this

containsOfClass

public boolean containsOfClass(Class<? extends JavaExpression> clazz)

Specified by:

containsOfClass in class JavaExpression

isUnassignableByOtherCode

public boolean isUnassignableByOtherCode()

Description copied from class: JavaExpression

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 JavaExpression.isUnassignableByOtherCode(), and operations whose operands are all JavaExpression.isUnmodifiableByOtherCode().

Specified by:

isUnassignableByOtherCode in class JavaExpression

See Also:

JavaExpression.isUnmodifiableByOtherCode()

isUnmodifiableByOtherCode

public boolean isUnmodifiableByOtherCode()

Description copied from class: JavaExpression

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 JavaExpression.isUnassignableByOtherCode() and its type is immutable.

Specified by:

isUnmodifiableByOtherCode in class JavaExpression

See Also:

JavaExpression.isUnassignableByOtherCode()