Package com.intellij.codeInspection.dataFlow

Class CommonDataflow.DataflowResult

java.lang.Object

com.intellij.codeInspection.dataFlow.CommonDataflow.DataflowResult

Enclosing class:

CommonDataflow

public static final class CommonDataflow.DataflowResult
extends java.lang.Object

Represents the result of dataflow applied to some code fragment (usually a method)

Constructor Summary

Constructors

Constructor and Description
DataflowResult(RunnerResult result)

Method Summary

Modifier and Type	Method and Description
boolean	cannotFailByContract(PsiCallExpression call) Returns true if given call cannot fail according to its contracts (e.g.
boolean	expressionWasAnalyzed(PsiExpression expression) Returns true if given expression was visited by dataflow.
DfType	getDfType(PsiExpression expression)
java.util.Set<java.lang.Object>	getExpressionValues(PsiExpression expression) Returns a set of expression values if known.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataflowResult

public DataflowResult(RunnerResult result)

Method Detail

expressionWasAnalyzed

public boolean expressionWasAnalyzed(PsiExpression expression)

Returns true if given expression was visited by dataflow. Note that dataflow usually tracks deparenthesized expressions only, so you should deparenthesize it in advance if necessary.

Parameters:

expression - expression to check, not parenthesized

Returns:

true if given expression was visited by dataflow. If false is returned, it's possible that the expression exists in unreachable branch or this expression is not tracked due to the dataflow implementation details.

cannotFailByContract

public boolean cannotFailByContract(PsiCallExpression call)

Returns true if given call cannot fail according to its contracts (e.g. Optional.get() executed under Optional.isPresent()).

Parameters:

call - call to check

Returns:

true if it cannot fail by contract; false if unknown or can fail

getExpressionValues

public java.util.Set<java.lang.Object> getExpressionValues(PsiExpression expression)

Returns a set of expression values if known. If non-empty set is returned, then given expression is guaranteed to have one of returned values.

Parameters:

expression - an expression to get its value

Returns:

a set of possible values or empty set if not known

getDfType

public DfType getDfType(PsiExpression expression)

Parameters:

expression - an expression to infer the DfType, must be deparenthesized.

Returns:

DfType for that expression. May return DfTypes.TOP if no information from dataflow is known about this expression