Package org.checkerframework.dataflow.expression

Class LocalVariable

java.lang.Object

org.checkerframework.dataflow.expression.JavaExpression

org.checkerframework.dataflow.expression.LocalVariable

public class LocalVariable
extends JavaExpression

A local variable.

This class also represents a formal parameter expressed using its name. Class FormalParameter represents a formal parameter expressed using the "#2" notation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final VariableElement	element	The element for this local variable.

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

type

Constructor Summary

Constructors

Constructor	Description
LocalVariable(VariableElement element)	Creates a new LocalVariable.
LocalVariable(LocalVariableNode localVar)	Creates a new LocalVariable.

Method Summary

Modifier and Type	Method	Description
<R, P> R	accept(JavaExpressionVisitor<R,P> visitor, P p)	Accept method of the visitor pattern.
<T extends JavaExpression> @Nullable T	containedOfClass(Class<T> clazz)	Returns the first subexpression whose class is the given class, or null.
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	getElement()	Returns the element for this variable.
int	hashCode()
boolean	isAssignableByOtherCode()	Returns true if some subexpression of this can be assigned to from outside the current method body.
boolean	isDeterministic(AnnotationProvider provider)	Returns true if the expression is deterministic.
boolean	isModifiableByOtherCode()	Returns true if the value this expression stands for can be changed by a method call; equivalently, if the value this expression evaluates to can be changed by a side effect from outside the containing method.
protected static boolean	sameElement(VariableElement element1, VariableElement element2)	Returns true if the two elements are the same.
boolean	syntacticEquals(JavaExpression je)	Returns true if and only if the two Java expressions are syntactically identical.
String	toString()
String	toStringDebug()	Format this verbosely, for debugging.

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

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

Methods inherited from class java.lang.Object

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

Field Details

element

protected final VariableElement element

The element for this local variable.

Constructor Details

LocalVariable

public LocalVariable(LocalVariableNode localVar)

Creates a new LocalVariable.

Parameters:

localVar - a CFG local variable

LocalVariable

public LocalVariable(VariableElement element)

Creates a new LocalVariable.

Parameters:

element - the element for the local variable

Method Details

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

sameElement

protected static boolean sameElement(VariableElement element1,
 VariableElement element2)

Returns true if the two elements are the same.

Parameters:

element1 - the first element to compare

element2 - the second element to compare

Returns:

true if the two elements are the same

getElement

public VariableElement getElement()

Returns the element for this variable.

Returns:

the element for this variable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringDebug

public String toStringDebug()

Description copied from class: JavaExpression

Format this verbosely, for debugging.

Overrides:

toStringDebug in class JavaExpression

Returns:

a verbose string representation of this

containedOfClass

public <T extends JavaExpression> @Nullable T containedOfClass(Class<T> clazz)

Description copied from class: JavaExpression

Returns the first subexpression whose class is the given class, or null.

This is intended as a diagnostic aid; most clients will use JavaExpression.containsOfClass(java.lang.Class<? extends org.checkerframework.dataflow.expression.JavaExpression>).

Specified by:

containedOfClass in class JavaExpression

Type Parameters:

T - the type corresponding to clazz

Parameters:

clazz - the JavaExpression subclass to search for

Returns:

true if some subexpression whose class is the given class

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

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

isAssignableByOtherCode

public boolean isAssignableByOtherCode()

Description copied from class: JavaExpression

Returns true if some subexpression of this can be assigned to from outside the current method body.

This is false for local variables, the self reference, final field accesses whose receiver is JavaExpression.isUnassignableByOtherCode(), and operations whose operands are all not JavaExpression.isModifiableByOtherCode().

Overrides:

isAssignableByOtherCode in class JavaExpression

Returns:

true if some subexpression of this can be assigned to from outside the current method body

See Also:

• JavaExpression.isModifiableByOtherCode()

isModifiableByOtherCode

public boolean isModifiableByOtherCode()

Description copied from class: JavaExpression

Returns true if the value this expression stands for can be changed by a method call; equivalently, if the value this expression evaluates to can be changed by a side effect from outside the containing method.

Approximately, this returns true if the expression is JavaExpression.isAssignableByOtherCode() or its type is mutable. (String is an immutable type.)

Overrides:

isModifiableByOtherCode in class JavaExpression

Returns:

true if the value of this expression can be changed from outside the current method body

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