Package org.checkerframework.dataflow.expression

Class FieldAccess

java.lang.Object

org.checkerframework.dataflow.expression.JavaExpression

org.checkerframework.dataflow.expression.FieldAccess

public class FieldAccess
extends JavaExpression

A FieldAccess represents a field access. It does not represent a class literal such as SomeClass.class or int[].class.

Field Summary

Fields

Modifier and Type	Field	Description
protected javax.lang.model.element.VariableElement	field	The field being accessed.
protected JavaExpression	receiver	The receiver of the field access.

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

type

Constructor Summary

Constructors

Constructor	Description
FieldAccess(JavaExpression receiver, javax.lang.model.element.VariableElement fieldElement)	Create a FieldAccess.
FieldAccess(JavaExpression receiver, javax.lang.model.type.TypeMirror type, javax.lang.model.element.VariableElement fieldElement)	Create a FieldAccess.
FieldAccess(JavaExpression receiver, FieldAccessNode node)	Create a FieldAccess.

Method Summary

Modifier and Type	Method	Description
<R,P> R	accept(JavaExpressionVisitor<R,P> visitor, P p)	Accept method of the visitor pattern.
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(java.lang.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 java.lang.Object obj)
javax.lang.model.element.VariableElement	getField()	Returns the field.
JavaExpression	getReceiver()	Returns the receiver.
int	hashCode()
boolean	isDeterministic(AnnotationProvider provider)	Returns true if the expression is deterministic.
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.
java.lang.String	toString()
java.lang.String	toStringDebug()	Format this verbosely, for debugging.

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

atConstructorInvocation, atFieldAccess, atMethodBody, atMethodInvocation, atMethodInvocation, containsUnknown, fromArrayAccess, fromNode, fromNodeFieldAccess, fromTree, fromVariableTree, getFormalParameters, getImplicitReceiver, getParametersAsLocalVariables, getPseudoReceiver, getReceiver, getType, listContainsSyntacticEqualJavaExpression, listIsDeterministic, syntacticEqualsList

Methods inherited from class java.lang.Object

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

Field Detail

receiver

protected final JavaExpression receiver

The receiver of the field access.

field

protected final javax.lang.model.element.VariableElement field

The field being accessed.

Constructor Detail

FieldAccess

public FieldAccess(JavaExpression receiver,
                   FieldAccessNode node)

Create a FieldAccess.

Parameters:

receiver - receiver of the field access

node - the FieldAccessNode

FieldAccess

public FieldAccess(JavaExpression receiver,
                   javax.lang.model.element.VariableElement fieldElement)

Create a FieldAccess.

Parameters:

receiver - receiver of the field access

fieldElement - element of the field

FieldAccess

public FieldAccess(JavaExpression receiver,
                   javax.lang.model.type.TypeMirror type,
                   javax.lang.model.element.VariableElement fieldElement)

Create a FieldAccess.

Parameters:

receiver - receiver of the field access

type - type of the field

fieldElement - element of the field

Method Detail

getReceiver

public JavaExpression getReceiver()

Returns the receiver.

Returns:

the receiver

getField

public javax.lang.model.element.VariableElement getField()

Returns the field.

Returns:

the field

isFinal

public boolean isFinal()

isStatic

public boolean isStatic()

equals

public boolean equals(@Nullable java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

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 JavaExpression.containsSyntacticEqualJavaExpression(org.checkerframework.dataflow.expression.JavaExpression).

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

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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringDebug

public java.lang.String toStringDebug()

Description copied from class: JavaExpression

Format this verbosely, for debugging.

Overrides:

toStringDebug in class JavaExpression

Returns:

a verbose string representation of this

containsOfClass

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

Specified by:

containsOfClass in class JavaExpression

isDeterministic

public boolean isDeterministic(AnnotationProvider provider)

Description copied from class: JavaExpression

Returns true if the expression is deterministic.

Specified by:

isDeterministic in class JavaExpression

Parameters:

provider - an annotation provider (a type factory)

Returns:

true if this expression is deterministic

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

accept

public <R,P> R accept(JavaExpressionVisitor<R,P> visitor,
                            P p)

Description copied from class: JavaExpression

Accept method of the visitor pattern.

Specified by:

accept in class JavaExpression

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