org.checkerframework.dataflow.expression

Class FormalParameter

java.lang.Object

org.checkerframework.dataflow.expression.JavaExpression

org.checkerframework.dataflow.expression.FormalParameter

public class FormalParameter
extends JavaExpression

A formal parameter, represented by its 1-based index.

LocalVariable represents a formal parameter expressed using its name.

Field Summary

Fields

Modifier and Type	Field and Description
protected VariableElement	element The element for this formal parameter.
protected int	index The 1-based index.

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

type

Constructor Summary

Constructors

Constructor and Description
FormalParameter(int index, VariableElement element) Creates a FormalParameter.

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	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)
VariableElement	getElement() Returns the element for this variable.
int	getIndex() Returns the 1-based index of this formal parameter.
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.
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, containsModifiableAliasOf, containsUnknown, fromArrayAccess, fromNode, fromNodeFieldAccess, fromTree, fromVariableTree, getFormalParameters, getImplicitReceiver, getParametersAsLocalVariables, getPseudoReceiver, getReceiver, getType, listContainsSyntacticEqualJavaExpression, listIsDeterministic

Methods inherited from class java.lang.Object

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

Field Detail

index

protected final int index

The 1-based index.

element

protected final VariableElement element

The element for this formal parameter.

Constructor Detail

FormalParameter

public FormalParameter(int index,
                       VariableElement element)

Creates a FormalParameter.

Parameters:

index - the 1-based index

element - the element for the formal parameter

Method Detail

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

getIndex

public int getIndex()

Returns the 1-based index of this formal parameter.

Returns:

the 1-based index of this formal parameter

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

containsOfClass

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

Specified by:

containsOfClass in class JavaExpression

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

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

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

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