Package com.intellij.codeInspection.dataFlow

Class JavaMethodContractUtil

java.lang.Object

com.intellij.codeInspection.dataFlow.JavaMethodContractUtil

public class JavaMethodContractUtil
extends java.lang.Object

Methods to operate on Java contracts

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ORG_JETBRAINS_ANNOTATIONS_CONTRACT JetBrains contract annotation fully-qualified name

Method Summary

Modifier and Type	Method and Description
static PsiAnnotation	findContractAnnotation(PsiMethod method) Returns a contract annotation for given method, checking the hierarchy
static PsiExpression	findReturnedValue(PsiMethodCallExpression call) For given method call find the returned expression if the method is known to return always the same parameter or its qualifier (unless fail).
static java.util.List<? extends MethodContract>	getMethodCallContracts(PsiCallExpression call) Returns a list of contracts defined for given method call (including hardcoded contracts if any)
static java.util.List<? extends MethodContract>	getMethodCallContracts(PsiMethod method, PsiCallExpression call) Returns a list of contracts defined for given method call (including hardcoded contracts if any)
static java.util.List<StandardMethodContract>	getMethodContracts(PsiMethod method) Returns a list of contracts defined for given method call (excluding hardcoded contracts)
static ContractReturnValue	getNonFailingReturnValue(java.util.List<? extends MethodContract> contracts) Returns the common return value of the method assuming that it does not fail
static boolean	hasExplicitContractAnnotation(PsiMethod method) Checks whether method has an explicit contract annotation (either in source code or as external annotation)
static boolean	isPure(PsiMethod method) Checks the method purity based on its contract
static java.util.List<StandardMethodContract>	parseContracts(PsiMethod method, PsiAnnotation contractAnno) Parse contracts for given method.
static PsiAnnotation	updateContract(PsiAnnotation annotation, java.util.List<StandardMethodContract> contracts) Creates a new PsiAnnotation describing the updated contract.

Methods inherited from class java.lang.Object

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

Field Detail

ORG_JETBRAINS_ANNOTATIONS_CONTRACT

public static final java.lang.String ORG_JETBRAINS_ANNOTATIONS_CONTRACT

JetBrains contract annotation fully-qualified name

Method Detail

getMethodCallContracts

public static java.util.List<? extends MethodContract> getMethodCallContracts(PsiCallExpression call)

Returns a list of contracts defined for given method call (including hardcoded contracts if any)

Parameters:

call - a method call site.

Returns:

list of contracts (empty list if no contracts found)

getMethodCallContracts

public static java.util.List<? extends MethodContract> getMethodCallContracts(PsiMethod method,
                                                                              PsiCallExpression call)

Returns a list of contracts defined for given method call (including hardcoded contracts if any)

Parameters:

method - a method to check the contracts for

call - an optional call site. If specified, could be taken into account to derive contracts for some testing methods like assertThat(x, is(null))

Returns:

list of contracts (empty list if no contracts found)

getMethodContracts

public static java.util.List<StandardMethodContract> getMethodContracts(PsiMethod method)

Returns a list of contracts defined for given method call (excluding hardcoded contracts)

Parameters:

method - a method to check the contracts for

Returns:

list of contracts (empty list if no contracts found)

hasExplicitContractAnnotation

public static boolean hasExplicitContractAnnotation(PsiMethod method)

Checks whether method has an explicit contract annotation (either in source code or as external annotation)

Parameters:

method - method to check

Returns:

true if method has explicit (non-inferred) contract annotation.

updateContract

public static PsiAnnotation updateContract(PsiAnnotation annotation,
                                           java.util.List<StandardMethodContract> contracts)

Creates a new PsiAnnotation describing the updated contract. Only contract clauses are updated; purity and mutation signature (if exist) are left as is.

Parameters:

annotation - original annotation to update

contracts - new contracts

Returns:

new PsiAnnotation object which describes updated contracts or null if no annotation is required to represent the target contracts (i.e. contracts is empty, method has no mutation signature and is not marked as pure).

parseContracts

public static java.util.List<StandardMethodContract> parseContracts(PsiMethod method,
                                                                    PsiAnnotation contractAnno)

Parse contracts for given method. Calling this method is rarely necessary in client code; it exists mainly to aid the inference procedure. Use getMethodContracts(PsiMethod) instead.

Parameters:

method - method to parse contracts for

contractAnno - a contract annotation

Returns:

a list of parsed contracts

findContractAnnotation

public static PsiAnnotation findContractAnnotation(PsiMethod method)

Returns a contract annotation for given method, checking the hierarchy

Parameters:

method - a method

Returns:

a found annotation (null if not found)

isPure

public static boolean isPure(PsiMethod method)

Checks the method purity based on its contract

Parameters:

method - method to check

Returns:

true if the method known to be pure (see Contract#pure() for details).

getNonFailingReturnValue

public static ContractReturnValue getNonFailingReturnValue(java.util.List<? extends MethodContract> contracts)

Returns the common return value of the method assuming that it does not fail

Parameters:

contracts - method contracts

Returns:

common return value or null if there's no common return value

findReturnedValue

public static PsiExpression findReturnedValue(PsiMethodCallExpression call)

For given method call find the returned expression if the method is known to return always the same parameter or its qualifier (unless fail).

Parameters:

call - call to analyze

Returns:

the expression which is always returned by this method if it completes successfully, null if method may return something less trivial or its contract is unknown.