org.checkerframework.dataflow.analysis

Class FlowExpressions.ValueLiteral

java.lang.Object

org.checkerframework.dataflow.analysis.FlowExpressions.Receiver

org.checkerframework.dataflow.analysis.FlowExpressions.ValueLiteral

Enclosing class:

FlowExpressions

public static class FlowExpressions.ValueLiteral
extends FlowExpressions.Receiver

FlowExpression.Receiver for literals.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable Object	value The value of the literal.

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

type

Constructor Summary

Constructors

Constructor and Description
ValueLiteral(TypeMirror type, Object value) Creates a ValueLiteral where the value is value that has the given type.
ValueLiteral(TypeMirror type, ValueLiteralNode node) Creates a ValueLiteral from the node with the given type.

Method Summary

Modifier and Type	Method and Description
boolean	containsModifiableAliasOf(Store<?> store, FlowExpressions.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.
boolean	containsOfClass(Class<? extends FlowExpressions.Receiver> clazz)
boolean	equals(@Nullable Object obj)
@Nullable Object	getValue() Returns the value of this literal.
int	hashCode()
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(FlowExpressions.Receiver other) Returns true if and only if the two receivers are syntactically identical.
String	toString()

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

containsSyntacticEqualReceiver, containsUnknown, getType, toStringDebug

Methods inherited from class java.lang.Object

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

Field Detail

value

protected final @Nullable Object value

The value of the literal.

Constructor Detail

ValueLiteral

public ValueLiteral(TypeMirror type,
                    ValueLiteralNode node)

Creates a ValueLiteral from the node with the given type.

Parameters:

type - type of the literal

node - the literal represents by this FlowExpressions.ValueLiteral

ValueLiteral

public ValueLiteral(TypeMirror type,
                    Object value)

Creates a ValueLiteral where the value is value that has the given type.

Parameters:

type - type of the literal

value - the literal value

Method Detail

containsOfClass

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

Specified by:

containsOfClass in class FlowExpressions.Receiver

isUnassignableByOtherCode

public boolean isUnassignableByOtherCode()

Description copied from class: FlowExpressions.Receiver

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 FlowExpressions.Receiver.isUnassignableByOtherCode(), and binary operations whose left and right operands are both FlowExpressions.Receiver.isUnmodifiableByOtherCode().

Specified by:

isUnassignableByOtherCode in class FlowExpressions.Receiver

See Also:

FlowExpressions.Receiver.isUnmodifiableByOtherCode()

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, including changes to any of its fields.

Approximately, this returns true if the expression is FlowExpressions.Receiver.isUnassignableByOtherCode() and its type is immutable.

Specified by:

isUnmodifiableByOtherCode in class FlowExpressions.Receiver

See Also:

FlowExpressions.Receiver.isUnassignableByOtherCode()

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

syntacticEquals

public boolean syntacticEquals(FlowExpressions.Receiver other)

Description copied from class: FlowExpressions.Receiver

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

Overrides:

syntacticEquals in class FlowExpressions.Receiver

Parameters:

other - the other object to compare to this one

Returns:

true if and only if the two receivers are syntactically identical

containsModifiableAliasOf

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

Description copied from class: FlowExpressions.Receiver

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

Overrides:

containsModifiableAliasOf in class FlowExpressions.Receiver

getValue

public @Nullable Object getValue()

Returns the value of this literal.

Returns:

the value of this literal