Class JavaExpression
- Direct Known Subclasses:
ArrayAccess
,ArrayCreation
,BinaryOperation
,ClassName
,FieldAccess
,FormalParameter
,LocalVariable
,MethodCall
,ThisReference
,UnaryOperation
,Unknown
,ValueLiteral
?:
; use
Unknown
for unrepresentable expressions).
This class's representation is like an AST: subparts are also expressions. For declared names (fields, local variables, and methods), it also contains an Element.
Each subclass represents a different type of expression, such as MethodCall
, ArrayAccess
, LocalVariable
, etc.
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract <R,
P> R accept
(JavaExpressionVisitor<R, P> visitor, P p) Accept method of the visitor pattern.atConstructorInvocation
(NewClassTree newClassTree) Viewpoint-adaptsthis
to thenewClassTree
.atFieldAccess
(JavaExpression receiver) Viewpoint-adaptsthis
to a field access with receiverreceiver
.final JavaExpression
atMethodBody
(MethodTree methodTree) Viewpoint-adaptsthis
to themethodTree
by converting anyFormalParameter
intoLocalVariable
s.final JavaExpression
atMethodInvocation
(MethodInvocationTree methodInvocationTree) Viewpoint-adaptsthis
to themethodInvocationTree
.final JavaExpression
atMethodInvocation
(MethodInvocationNode invocationNode) Viewpoint-adaptsthis
to theinvocationNode
.boolean
containsModifiableAliasOf
(Store<?> store, JavaExpression other) Returns true if and only ifother
appears anywhere in this or an expression appears in this such thatother
might alias this expression, and that expression is modifiable.abstract boolean
containsOfClass
(Class<? extends JavaExpression> clazz) abstract boolean
Returns true if and only if this contains a JavaExpression that is syntactically equal toother
.boolean
static ArrayAccess
Returns the internal representation (asFieldAccess
) of aFieldAccessNode
.static JavaExpression
We ignore operations such as widening and narrowing when computing the internal representation.static JavaExpression
Returns the Java expression for aFieldAccessNode
.static JavaExpression
fromTree
(ExpressionTree tree) Converts a javacExpressionTree
to a CF JavaExpression.static JavaExpression
fromVariableTree
(VariableTree tree) Returns the Java expression corresponding to the given variable treetree
.static List<FormalParameter>
getFormalParameters
(ExecutableElement methodEle) Returns the parameters ofmethodEle
asFormalParameter
s.static JavaExpression
Returns the implicit receiver of ele.static List<JavaExpression>
getParametersAsLocalVariables
(ExecutableElement methodEle) Returns the parameters ofmethodEle
asLocalVariable
s.static JavaExpression
getPseudoReceiver
(TreePath path, TypeMirror enclosingType) Returns either a new ClassName or ThisReference JavaExpression object for the enclosingType.static JavaExpression
getReceiver
(ExpressionTree accessTree) Returns the receiver of the given invocation.getType()
abstract boolean
isDeterministic
(AnnotationProvider provider) Returns true if the expression is deterministic.abstract boolean
Returns true if and only if the value this expression stands for cannot be changed (with respect to ==) by a method call.abstract boolean
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.static boolean
listContainsSyntacticEqualJavaExpression
(List<? extends @Nullable JavaExpression> list, JavaExpression other) Returns true if the given list contains a JavaExpression that is syntactically equal toother
.static boolean
listIsDeterministic
(List<? extends @Nullable JavaExpression> list, AnnotationProvider provider) Returns true if all the expressions in the list are deterministic.abstract boolean
Returns true if and only if the two Java expressions are syntactically identical.static boolean
syntacticEqualsList
(List<? extends @Nullable JavaExpression> lst1, List<? extends @Nullable JavaExpression> lst2) Returns true if the corresponding list elements satisfysyntacticEquals(org.checkerframework.dataflow.expression.JavaExpression)
.Format this verbosely, for debugging.
-
Field Details
-
type
The type of this expression.
-
-
Constructor Details
-
JavaExpression
Create a JavaExpression.- Parameters:
type
- the type of the expression
-
-
Method Details
-
getType
-
containsOfClass
-
containsUnknown
-
isDeterministic
Returns true if the expression is deterministic.- Parameters:
provider
- an annotation provider (a type factory)- Returns:
- true if this expression is deterministic
-
listIsDeterministic
@Pure public static boolean listIsDeterministic(List<? extends @Nullable JavaExpression> list, AnnotationProvider provider) Returns true if all the expressions in the list are deterministic.- Parameters:
list
- the list whose elements to testprovider
- an annotation provider (a type factory)- Returns:
- true if all the expressions in the list are deterministic
-
isUnassignableByOtherCode
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 isisUnassignableByOtherCode()
, and operations whose operands are allisUnmodifiableByOtherCode()
.- See Also:
-
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.Approximately, this returns true if the expression is
isUnassignableByOtherCode()
and its type is immutable.- See Also:
-
syntacticEquals
Returns true if and only if the two Java expressions are syntactically identical.This exists for use by
containsSyntacticEqualJavaExpression(org.checkerframework.dataflow.expression.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
-
syntacticEqualsList
@Pure public static boolean syntacticEqualsList(List<? extends @Nullable JavaExpression> lst1, List<? extends @Nullable JavaExpression> lst2) Returns true if the corresponding list elements satisfysyntacticEquals(org.checkerframework.dataflow.expression.JavaExpression)
.- Parameters:
lst1
- the first list to comparelst2
- the second list to compare- Returns:
- true if the corresponding list elements satisfy
syntacticEquals(org.checkerframework.dataflow.expression.JavaExpression)
-
containsSyntacticEqualJavaExpression
Returns true if and only if this contains a JavaExpression that is syntactically equal toother
.- Parameters:
other
- the JavaExpression to search for- Returns:
- true if and only if this contains a JavaExpression that is syntactically equal to
other
-
listContainsSyntacticEqualJavaExpression
@Pure public static boolean listContainsSyntacticEqualJavaExpression(List<? extends @Nullable JavaExpression> list, JavaExpression other) Returns true if the given list contains a JavaExpression that is syntactically equal toother
.- Parameters:
list
- the list in which to search for a matchother
- the JavaExpression to search for- Returns:
- true if and only if the list contains a JavaExpression that is syntactically equal to
other
-
containsModifiableAliasOf
Returns true if and only ifother
appears anywhere in this or an expression appears in this such thatother
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'.
-
toStringDebug
Format this verbosely, for debugging.- Returns:
- a verbose string representation of this
-
fromNodeFieldAccess
Returns the Java expression for aFieldAccessNode
. The result may containUnknown
as receiver.- Parameters:
node
- the FieldAccessNode to convert to a JavaExpression- Returns:
- the
FieldAccess
orClassName
that corresponds tonode
-
fromArrayAccess
Returns the internal representation (asFieldAccess
) of aFieldAccessNode
. The result may containUnknown
as receiver.- Parameters:
node
- the ArrayAccessNode to convert to a JavaExpression- Returns:
- the internal representation (as
FieldAccess
) of aFieldAccessNode
. Can containUnknown
as receiver.
-
fromNode
We ignore operations such as widening and narrowing when computing the internal representation.- Parameters:
receiverNode
- a node to convert to a JavaExpression- Returns:
- the internal representation of the given node. Might contain
Unknown
.
-
fromTree
Converts a javacExpressionTree
to a CF JavaExpression. The result might containUnknown
.We ignore operations such as widening and narrowing when computing the JavaExpression.
- Parameters:
tree
- a javac tree- Returns:
- a JavaExpression for the given javac tree
-
fromVariableTree
Returns the Java expression corresponding to the given variable treetree
.- Parameters:
tree
- a variable tree- Returns:
- a JavaExpression for
tree
-
getParametersAsLocalVariables
Returns the parameters ofmethodEle
asLocalVariable
s.- Parameters:
methodEle
- the method element- Returns:
- list of parameters as
LocalVariable
s
-
getFormalParameters
Returns the parameters ofmethodEle
asFormalParameter
s.- Parameters:
methodEle
- the method element- Returns:
- list of parameters as
FormalParameter
s
-
getReceiver
Returns the receiver of the given invocation.- Parameters:
accessTree
- a method or constructor invocation- Returns:
- the receiver of the given invocation
-
getImplicitReceiver
Returns the implicit receiver of ele.Returns either a new ClassName or a new ThisReference depending on whether ele is static or not. The passed element must be a field, method, or class.
When this returns a ThisReference, its type is the class that declares
ele
, which is not necessarily the type ofthis
at the invocation site.- Parameters:
ele
- a field, method, or class- Returns:
- either a new ClassName or a new ThisReference depending on whether ele is static or not
-
getPseudoReceiver
Returns either a new ClassName or ThisReference JavaExpression object for the enclosingType.The Tree should be an expression or a statement that does not have a receiver or an implicit receiver. For example, a local variable declaration.
- Parameters:
path
- a tree pathenclosingType
- type of the enclosing type- Returns:
- a new
ClassName
orThisReference
that is a JavaExpression object for the enclosingType
-
accept
Accept method of the visitor pattern.- Type Parameters:
R
- result type of the operationP
- parameter type- Parameters:
visitor
- the visitor to be applied to this JavaExpressionp
- the parameter for this operation- Returns:
- the result of visiting this
-
atFieldAccess
Viewpoint-adaptsthis
to a field access with receiverreceiver
.- Parameters:
receiver
- receiver of the field access- Returns:
- viewpoint-adapted version of this
-
atMethodBody
Viewpoint-adaptsthis
to themethodTree
by converting anyFormalParameter
intoLocalVariable
s.- Parameters:
methodTree
- method declaration tree- Returns:
- viewpoint-adapted version of this
-
atMethodInvocation
Viewpoint-adaptsthis
to themethodInvocationTree
.- Parameters:
methodInvocationTree
- method invocation- Returns:
- viewpoint-adapted version of this
-
atMethodInvocation
Viewpoint-adaptsthis
to theinvocationNode
.- Parameters:
invocationNode
- method invocation- Returns:
- viewpoint-adapted version of this
-
atConstructorInvocation
Viewpoint-adaptsthis
to thenewClassTree
.- Parameters:
newClassTree
- constructor invocation- Returns:
- viewpoint-adapted version of this
-