org.checkerframework.dataflow.analysis

Class FlowExpressions.PureMethodCall

java.lang.Object

org.checkerframework.dataflow.analysis.FlowExpressions.Receiver

org.checkerframework.dataflow.analysis.FlowExpressions.PureMethodCall

Enclosing class:

FlowExpressions

public static class FlowExpressions.PureMethodCall
extends FlowExpressions.Receiver

A method call, typically a deterministic one. However, this is not enforced and non-pure methods are also possible. It is the clients responsibility to ensure that using non-deterministic methods is done in a sound way. The CF allows non-deterministic methods to be used in postconditions such as EnsuresNonNull.

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	method
protected List<FlowExpressions.Receiver>	parameters
protected FlowExpressions.Receiver	receiver

Fields inherited from class org.checkerframework.dataflow.analysis.FlowExpressions.Receiver

type

Constructor Summary

Constructors

Constructor and Description
PureMethodCall(TypeMirror type, Element method, FlowExpressions.Receiver receiver, List<FlowExpressions.Receiver> parameters)

Method Summary

Modifier and Type	Method and Description
boolean	containsModifiableAliasOf(Store<?> store, FlowExpressions.Receiver other) Returns true if and only if other appear anywhere in this receiver or an expression appears in this receiver such that other might alias this expression, and that expression is modifiable.
boolean	containsOfClass(Class<? extends FlowExpressions.Receiver> clazz)
boolean	containsSyntacticEqualParameter(FlowExpressions.LocalVariable var)
boolean	containsSyntacticEqualReceiver(FlowExpressions.Receiver other)
boolean	equals(Object obj)
int	hashCode()
boolean	isUnmodifiableByOtherCode() Returns true if and only if the value this expression stands for cannot be changed by a method call.
boolean	syntacticEquals(FlowExpressions.Receiver other)
String	toString()

Methods inherited from class org.checkerframework.dataflow.analysis.FlowExpressions.Receiver

containsUnknown, getType

Methods inherited from class java.lang.Object

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

Field Detail

receiver

protected final FlowExpressions.Receiver receiver

parameters

protected final List<FlowExpressions.Receiver> parameters

method

protected final Element method

Constructor Detail

PureMethodCall

public PureMethodCall(TypeMirror type,
                      Element method,
                      FlowExpressions.Receiver receiver,
                      List<FlowExpressions.Receiver> parameters)

Method Detail

containsOfClass

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

Specified by:

containsOfClass in class FlowExpressions.Receiver

isUnmodifiableByOtherCode

public boolean isUnmodifiableByOtherCode()

Description copied from class: FlowExpressions.Receiver

Returns true if and only if the value this expression stands for cannot be changed by a method call. This is the case for local variables, the self reference as well as final field accesses for whose receiver FlowExpressions.Receiver.isUnmodifiableByOtherCode() is true.

Specified by:

isUnmodifiableByOtherCode in class FlowExpressions.Receiver

containsSyntacticEqualReceiver

public boolean containsSyntacticEqualReceiver(FlowExpressions.Receiver other)

Overrides:

containsSyntacticEqualReceiver in class FlowExpressions.Receiver

Returns:

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

syntacticEquals

public boolean syntacticEquals(FlowExpressions.Receiver other)

Overrides:

syntacticEquals in class FlowExpressions.Receiver

Returns:

True if and only if the two receiver are syntactically identical.

containsSyntacticEqualParameter

public boolean containsSyntacticEqualParameter(FlowExpressions.LocalVariable var)

containsModifiableAliasOf

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

Description copied from class: FlowExpressions.Receiver

Returns true if and only if other appear 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'.

Overrides:

containsModifiableAliasOf in class FlowExpressions.Receiver

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object