org.checkerframework.dataflow.expression

Class ValueLiteral

java.lang.Object

org.checkerframework.dataflow.expression.JavaExpression

org.checkerframework.dataflow.expression.ValueLiteral

public class ValueLiteral
extends JavaExpression

JavaExpression 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.expression.JavaExpression

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
<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(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)
@Nullable Object	getValue() Returns the value of this literal.
int	hashCode()
boolean	isDeterministic(AnnotationProvider provider) Returns true if the expression is deterministic.
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.
ValueLiteral	negate() Returns the negation of this literal.
boolean	syntacticEquals(JavaExpression je) Returns true if and only if the two Java expressions are syntactically identical.
String	toString()

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, 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 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

negate

public ValueLiteral negate()

Returns the negation of this literal. Throws an exception if negation is not possible.

Returns:

the negation of this literal

getValue

public @Nullable Object getValue()

Returns the value of this literal.

Returns:

the value of this literal

containsOfClass

public boolean containsOfClass(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()

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

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

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