Package com.intellij.codeInspection.dataFlow

Class ContractReturnValue.BooleanReturnValue

java.lang.Object

com.intellij.codeInspection.dataFlow.ContractReturnValue

com.intellij.codeInspection.dataFlow.ContractReturnValue.BooleanReturnValue

Enclosing class:

ContractReturnValue

public static final class ContractReturnValue.BooleanReturnValue
extends ContractReturnValue

Boolean return value (either "true" or "false").

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.codeInspection.dataFlow.ContractReturnValue

ContractReturnValue.BooleanReturnValue, ContractReturnValue.ParameterReturnValue

Method Summary

Modifier and Type	Method and Description
DfaValue	getDfaValue(DfaValueFactory factory, DfaValue defaultValue, com.intellij.codeInspection.dataFlow.DfaCallState callState) Converts this return value to the most suitable DfaValue which represents the same constraints.
boolean	getValue()
boolean	isValueCompatible(DfaMemoryState state, DfaValue value) Returns true if the supplied DfaValue could be compatible with this return value.
ContractReturnValue.BooleanReturnValue	negate()

Methods inherited from class com.intellij.codeInspection.dataFlow.ContractReturnValue

fail, getMethodCompatibilityProblem, hashCode, intersect, isBoolean, isFail, isMethodCompatible, isNotNull, isNull, isSuperValueOf, ordinal, returnAny, returnBoolean, returnFalse, returnNew, returnNotNull, returnNull, returnParameter, returnThis, returnTrue, toString, valueOf, valueOf

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public boolean getValue()

negate

public ContractReturnValue.BooleanReturnValue negate()

Returns:

the return value opposite to this return value

getDfaValue

public DfaValue getDfaValue(DfaValueFactory factory,
                            DfaValue defaultValue,
                            com.intellij.codeInspection.dataFlow.DfaCallState callState)

Description copied from class: ContractReturnValue

Converts this return value to the most suitable DfaValue which represents the same constraints.

Specified by:

getDfaValue in class ContractReturnValue

Parameters:

factory - a DfaValueFactory which can be used to create new values if necessary

defaultValue - a default method return type value in the absence of the contracts (may contain method type information)

callState - call state

Returns:

a value which represents the constraints of this contract return value.

isValueCompatible

public boolean isValueCompatible(DfaMemoryState state,
                                 DfaValue value)

Description copied from class: ContractReturnValue

Returns true if the supplied DfaValue could be compatible with this return value. If false is returned, then returning given DfaValue would violate the contract with this return value. This method can be used to check the contract correctness.

Specified by:

isValueCompatible in class ContractReturnValue

Parameters:

state - memory state to use

value - value to check

Returns:

whether the supplied value could be compatible with this return value.