Class ExpressionUtils

java.lang.Object

org.sonar.java.model.ExpressionUtils

public final class ExpressionUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static String	annotationAttributeName(ExpressionTree expression)
static boolean	areVariablesSame(Tree tree1, Tree tree2, boolean defaultValue)
static IdentifierTree	extractIdentifier(AssignmentExpressionTree tree)
static Optional<Symbol>	extractIdentifierSymbol(ExpressionTree tree)
static Optional<Symbol>	getAssignedSymbol(ExpressionTree exp)
static MethodTree	getEnclosingMethod(ExpressionTree expr)	Return the first enclosing method or constructor containing the given expression.
static Tree	getEnclosingTree(Tree expr, Tree.Kind... kinds)
static Tree	getParentOfType(Tree tree, Tree.Kind... kinds)
static boolean	isInvocationOnVariable(MethodInvocationTree mit, Symbol variable, boolean defaultReturn)	Return whether we are sure that the method invocation is on a given variable.
static boolean	isNullLiteral(ExpressionTree tree)
static boolean	isSecuringByte(ExpressionTree expression)
static boolean	isSelectOnThisOrSuper(AssignmentExpressionTree tree)	Checks of is the given tree is a MemberSelectExpressionTree which is selecting with this or super
static boolean	isSelectOnThisOrSuper(MemberSelectExpressionTree tree)	Checks of is the given tree is selecting with this or super
static boolean	isSimpleAssignment(AssignmentExpressionTree tree)	In case of simple assignments, only the expression is evaluated, as we only use the reference to the variable to store the result.
static boolean	isThis(ExpressionTree expression)	Checks if the given expression refers to "this"
static IdentifierTree	methodName(MethodInvocationTree mit)	Retrieve the identifier corresponding to the method name associated to the method invocation
static Object	resolveAsConstant(ExpressionTree tree)
static ExpressionTree	skipParentheses(ExpressionTree tree)
static Tree	skipParenthesesUpwards(Tree tree)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

isSimpleAssignment

public static boolean isSimpleAssignment(AssignmentExpressionTree tree)

In case of simple assignments, only the expression is evaluated, as we only use the reference to the variable to store the result. For SE-Based checks, only a single value should be unstacked if its the case. For other cases, two values should be unstacked. See JLS8-15.26

Parameters:

tree - The assignment tree

Returns:

true if the tree is a simple assignment

See Also:

• extractIdentifier(AssignmentExpressionTree)

isSelectOnThisOrSuper

public static boolean isSelectOnThisOrSuper(AssignmentExpressionTree tree)

Checks of is the given tree is a MemberSelectExpressionTree which is selecting with this or super

Parameters:

tree - The tree to check.

Returns:

true when the tree is a select on this or super

See Also:

• isSelectOnThisOrSuper(MemberSelectExpressionTree)

isSelectOnThisOrSuper

public static boolean isSelectOnThisOrSuper(MemberSelectExpressionTree tree)

Checks of is the given tree is selecting with this or super

Parameters:

tree - The tree to check.

Returns:

true when the tree is a select on this or super

See Also:

• isSelectOnThisOrSuper(AssignmentExpressionTree)

extractIdentifier

public static IdentifierTree extractIdentifier(AssignmentExpressionTree tree)

extractIdentifierSymbol

public static Optional<Symbol> extractIdentifierSymbol(ExpressionTree tree)

isInvocationOnVariable

public static boolean isInvocationOnVariable(MethodInvocationTree mit,
 @Nullable
 Symbol variable,
 boolean defaultReturn)

Return whether we are sure that the method invocation is on a given variable. If unsure (variable is null, or we can not extract an identifier from the method invocation), return a default value

skipParentheses

public static ExpressionTree skipParentheses(ExpressionTree tree)

skipParenthesesUpwards

@Nullable
public static Tree skipParenthesesUpwards(@Nullable
 Tree tree)

isNullLiteral

public static boolean isNullLiteral(ExpressionTree tree)

isSecuringByte

public static boolean isSecuringByte(ExpressionTree expression)

methodName

public static IdentifierTree methodName(MethodInvocationTree mit)

Retrieve the identifier corresponding to the method name associated to the method invocation

getEnclosingMethod

@CheckForNull
public static MethodTree getEnclosingMethod(ExpressionTree expr)

Return the first enclosing method or constructor containing the given expression.

getEnclosingTree

@CheckForNull
public static Tree getEnclosingTree(Tree expr,
 Tree.Kind... kinds)

getParentOfType

@Nullable
public static Tree getParentOfType(Tree tree,
 Tree.Kind... kinds)

getAssignedSymbol

public static Optional<Symbol> getAssignedSymbol(ExpressionTree exp)

isThis

public static boolean isThis(ExpressionTree expression)

Checks if the given expression refers to "this"

Parameters:

expression - the expression to check

Returns:

true if this expression refers to "this"

resolveAsConstant

@CheckForNull
public static Object resolveAsConstant(ExpressionTree tree)

areVariablesSame

public static boolean areVariablesSame(Tree tree1,
 Tree tree2,
 boolean defaultValue)

annotationAttributeName

public static String annotationAttributeName(ExpressionTree expression)