Package com.intellij.codeInspection.dataFlow

Class StandardMethodContract

java.lang.Object

com.intellij.codeInspection.dataFlow.MethodContract

com.intellij.codeInspection.dataFlow.StandardMethodContract

public final class StandardMethodContract
extends MethodContract

A method contract which is described by StandardMethodContract.ValueConstraint constraints on arguments. Such contract can be created from org.jetbrains.annotations.Contract annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardMethodContract.ParseException
static class	StandardMethodContract.ValueConstraint

Constructor Summary

Constructors

Constructor and Description
StandardMethodContract(StandardMethodContract.ValueConstraint [] parameters, ContractReturnValue returnValue)

Method Summary

Modifier and Type	Method and Description
static StandardMethodContract.ValueConstraint []	createConstraintArray(int paramCount)
boolean	equals(java.lang.Object o)
java.util.List<ContractValue>	getConditions()
java.util.List<StandardMethodContract.ValueConstraint>	getConstraints()
StandardMethodContract.ValueConstraint	getParameterConstraint(int parameterIndex)
int	getParameterCount()
int	hashCode()
static java.util.List<StandardMethodContract>	parseContract(java.lang.String text)
static java.util.List<StandardMethodContract>	toNonIntersectingStandardContracts(java.util.List<StandardMethodContract> contracts) Converts list of contracts which are equivalent to the passed list, but independent on the order (e.g.
static StandardMethodContract	trivialContract(int paramCount, ContractReturnValue returnValue)
StandardMethodContract	tryCollapse(StandardMethodContract other) Try merge two contracts into one preserving their full meaning
StandardMethodContract	withReturnValue(ContractReturnValue returnValue)

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

getReturnValue, isTrivial, singleConditionContract, toNonIntersectingContracts, toString, trivialContract

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardMethodContract

public StandardMethodContract(StandardMethodContract.ValueConstraint [] parameters,
                              ContractReturnValue returnValue)

Method Detail

getParameterCount

public int getParameterCount()

getParameterConstraint

public StandardMethodContract.ValueConstraint getParameterConstraint(int parameterIndex)

getConstraints

public java.util.List<StandardMethodContract.ValueConstraint> getConstraints()

withReturnValue

public StandardMethodContract withReturnValue(ContractReturnValue returnValue)

trivialContract

public static StandardMethodContract trivialContract(int paramCount,
                                                     ContractReturnValue returnValue)

tryCollapse

public StandardMethodContract tryCollapse(StandardMethodContract other)

Try merge two contracts into one preserving their full meaning

Parameters:

other - other contract to merge into this

Returns:

merged contract or null if unable to merge

toNonIntersectingStandardContracts

public static java.util.List<StandardMethodContract> toNonIntersectingStandardContracts(java.util.List<StandardMethodContract> contracts)

Converts list of contracts which are equivalent to the passed list, but independent on the order (e.g. "null -> null, _ -> !null" will be converted to "null -> null, !null -> !null"). Also removes unreachable contracts if any.

Parameters:

contracts - list of input contracts to process (assumed that they are applied in the specified order)

Returns:

list of equivalent non-intersecting contracts or null if the result is too big or the input list contains errors (e.g. contracts with different parameter count)

createConstraintArray

public static StandardMethodContract.ValueConstraint [] createConstraintArray(int paramCount)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getConditions

public java.util.List<ContractValue> getConditions()

Specified by:

getConditions in class MethodContract

parseContract

public static java.util.List<StandardMethodContract> parseContract(java.lang.String text)
                                                            throws StandardMethodContract.ParseException

Throws:

StandardMethodContract.ParseException