ContractReturnValue (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.codeInspection.dataFlow.ContractReturnValue

Direct Known Subclasses:

ContractReturnValue.BooleanReturnValue, ContractReturnValue.ParameterReturnValue
```
public abstract class ContractReturnValue
extends java.lang.Object
```
Representation of MethodContract return value. It may represent the concrete value (e.g. "false") or pose some constraints to the method return value (e.g. "!null").

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ContractReturnValue.BooleanReturnValue` Boolean return value (either "true" or "false").
`static class`	`ContractReturnValue.ParameterReturnValue`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static ContractReturnValue`	`fail()`
`abstract 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.
`java.lang.String`	`getMethodCompatibilityProblem(PsiMethod method)` Checks whether this return value makes sense for the specified method signature.
`int`	`hashCode()`
`ContractReturnValue`	`intersect(ContractReturnValue other)`
`boolean`	`isBoolean()`
`boolean`	`isFail()`
`boolean`	`isMethodCompatible(PsiMethod method)` Checks whether this return value makes sense for the specified method signature.
`boolean`	`isNotNull()`
`boolean`	`isNull()`
`boolean`	`isSuperValueOf(ContractReturnValue value)`
`abstract boolean`	`isValueCompatible(DfaMemoryState state, DfaValue value)` Returns true if the supplied `DfaValue` could be compatible with this return value.
`int`	`ordinal()` Returns a unique non-negative number which identifies this return value.
`static ContractReturnValue`	`returnAny()`
`static ContractReturnValue.BooleanReturnValue`	`returnBoolean(boolean value)`
`static ContractReturnValue.BooleanReturnValue`	`returnFalse()`
`static ContractReturnValue`	`returnNew()`
`static ContractReturnValue`	`returnNotNull()`
`static ContractReturnValue`	`returnNull()`
`static ContractReturnValue`	`returnParameter(int n)`
`static ContractReturnValue`	`returnThis()`
`static ContractReturnValue.BooleanReturnValue`	`returnTrue()`
`java.lang.String`	`toString()`
`static ContractReturnValue`	`valueOf(int ordinal)` Returns a `ContractReturnValue` which corresponds to given ordinal index.
`static ContractReturnValue`	`valueOf(java.lang.String value)` Returns a `ContractReturnValue` which corresponds to given string representation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hashcode which is stable across VM restart
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string which is used to represent this return value inside Contract annotation.
  - getMethodCompatibilityProblem
```
public final java.lang.String getMethodCompatibilityProblem(PsiMethod method)
```
    Checks whether this return value makes sense for the specified method signature. The method body is not checked. E.g. "true" contract value makes sense for method returning boolean, but does not make sense for method returning int. This method can be used to check the contract correctness.
    
    Parameters:
    
    method -
    
    Returns:
    
    null if this contract return value makes sense for the supplied return type. Otherwise the human-readable error message is returned.
  - isMethodCompatible
```
public final boolean isMethodCompatible(PsiMethod method)
```
    Checks whether this return value makes sense for the specified method signature. The method body is not checked. E.g. "true" contract value makes sense for method returning boolean, but does not make sense for method returning int. This method can be used to check the contract correctness.
    
    Parameters:
    
    method -
    
    Returns:
    
    true if this contract return value makes sense for the supplied return type.
  - intersect
```
public ContractReturnValue intersect(ContractReturnValue other)
```
  - isSuperValueOf
```
public boolean isSuperValueOf(ContractReturnValue value)
```
  - getDfaValue
```
public abstract 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.
    
    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 abstract boolean isValueCompatible(DfaMemoryState state,
                                          DfaValue value)
```
    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.
    
    Parameters:
    
    state - memory state to use
    
    value - value to check
    
    Returns:
    
    whether the supplied value could be compatible with this return value.
  - ordinal
```
public int ordinal()
```
    Returns a unique non-negative number which identifies this return value. Can be used for serialization. For two return values a and b the following holds: a.ordinal() == b.ordinal() <=> a.equals(b).
    
    Returns:
    
    a unique non-negative number which identifies this return value.
  - isNotNull
```
public boolean isNotNull()
```
    Returns:
    
    true if this return value represents a non-null object value (possibly with some other restrictions)
  - isNull
```
public boolean isNull()
```
    Returns:
    
    true if this return value represents a null
  - isFail
```
public boolean isFail()
```
    Returns:
    
    true if this return value represents a failure (that is, method must throw to fulfill this contract)
  - isBoolean
```
public boolean isBoolean()
```
    Returns:
    
    true if this return value represents a boolean value (either "true" or "false")
  - valueOf
```
public static ContractReturnValue valueOf(int ordinal)
```
    Returns a ContractReturnValue which corresponds to given ordinal index. For any return value x the following holds: ContractReturnValue.valueOf(x.ordinal()).equals(x).
    
    Parameters:
    
    ordinal - ordinal to create a ContractReturnValue object from
    
    Returns:
    
    a ContractReturnValue object. Returns an object which represents any possible value if the supplied ordinal does not correspond to any valid ContractReturnValue.
  - valueOf
```
public static ContractReturnValue valueOf(java.lang.String value)
```
    Returns a ContractReturnValue which corresponds to given string representation. For any return value x the following holds: ContractReturnValue.valueOf(x.toString()).equals(x) and for string str the following holds: ContractReturnValue.valueOf(str) == null || ContractReturnValue.valueOf(str).toString().equals(str).
    
    Parameters:
    
    value - string representation of return value
    
    Returns:
    
    ContractReturnValue object which corresponds to given string representation; null if given value is not supported.
  - returnAny
```
public static ContractReturnValue returnAny()
```
    Returns:
    
    any possible return value ("top" element)
  - fail
```
public static ContractReturnValue fail()
```
    Returns:
    
    return value indicating that the method throws an exception ("bottom" element)
  - returnBoolean
```
public static ContractReturnValue.BooleanReturnValue returnBoolean(boolean value)
```
    Parameters:
    
    value - a boolean value to return
    
    Returns:
    
    the corresponding boolean return value
  - returnTrue
```
public static ContractReturnValue.BooleanReturnValue returnTrue()
```
    Returns:
    
    boolean "true" return value
  - returnFalse
```
public static ContractReturnValue.BooleanReturnValue returnFalse()
```
    Returns:
    
    boolean "false" return value
  - returnNull
```
public static ContractReturnValue returnNull()
```
    Returns:
    
    "null" return value
  - returnNotNull
```
public static ContractReturnValue returnNotNull()
```
    Returns:
    
    non-null return value
  - returnNew
```
public static ContractReturnValue returnNew()
```
    Returns:
    
    non-null new object return value
  - returnThis
```
public static ContractReturnValue returnThis()
```
    Returns:
    
    non-null "this" return value (qualifier)
  - returnParameter
```
public static ContractReturnValue returnParameter(int n)
```
    Returns:
    
    non-null parameter return value (parameter number is zero-based)

Class ContractReturnValue

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

hashCode

toString

getMethodCompatibilityProblem

isMethodCompatible

intersect

isSuperValueOf

getDfaValue

isValueCompatible

ordinal

isNotNull

isNull

isFail

isBoolean

valueOf

valueOf

returnAny

fail

returnBoolean

returnTrue

returnFalse

returnNull

returnNotNull

returnNew

returnThis

returnParameter