Package com.intellij.codeInspection.dataFlow

Class MutationSignature

java.lang.Object

com.intellij.codeInspection.dataFlow.MutationSignature

public class MutationSignature
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_MUTATES
static java.lang.String	INVALID_TOKEN_MESSAGE

Method Summary

Modifier and Type	Method and Description
static java.lang.String	checkSignature(java.lang.String signature, PsiMethod method) Checks the mutation signature
static MutationSignature	fromMethod(PsiMethod method)
java.util.stream.Stream<PsiExpression>	mutatedExpressions(PsiMethodCallExpression call) Returns a stream of expressions which are mutated by given signature assuming that supplied call resolves to the method with this signature.
boolean	mutatesAnything()
boolean	mutatesArg(int n)
boolean	mutatesThis()
static MutationSignature	parse(java.lang.String signature)
boolean	preservesArg(int n)
boolean	preservesThis()

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_MUTATES

public static final java.lang.String ATTR_MUTATES

See Also:

Constant Field Values

INVALID_TOKEN_MESSAGE

public static final java.lang.String INVALID_TOKEN_MESSAGE

See Also:

Constant Field Values

Method Detail

mutatesThis

public boolean mutatesThis()

mutatesArg

public boolean mutatesArg(int n)

preservesThis

public boolean preservesThis()

preservesArg

public boolean preservesArg(int n)

mutatedExpressions

public java.util.stream.Stream<PsiExpression> mutatedExpressions(PsiMethodCallExpression call)

Returns a stream of expressions which are mutated by given signature assuming that supplied call resolves to the method with this signature.

Parameters:

call - a call which resolves to the method with this mutation signature

Returns:

a stream of expressions which are mutated by this call. If qualifier is omitted, but mutated, a non-physical PsiThisExpression might be returned.

mutatesAnything

public boolean mutatesAnything()

Returns:

true if known to mutate any parameter or receiver; false if pure or not known

parse

public static MutationSignature parse(java.lang.String signature)

Parameters:

signature - to parse

Returns:

a parsed mutation signature

Throws:

java.lang.IllegalArgumentException - if signature is invalid

checkSignature

public static java.lang.String checkSignature(java.lang.String signature,
                                              PsiMethod method)

Checks the mutation signature

Parameters:

signature - signature to check

method - a method to apply the signature

Returns:

error message or null if signature is valid

fromMethod

public static MutationSignature fromMethod(PsiMethod method)