Package org.checkerframework.dataflow.util

Class PurityChecker.PurityResult

java.lang.Object

org.checkerframework.dataflow.util.PurityChecker.PurityResult

Enclosing class:

PurityChecker

public static class PurityChecker.PurityResult
extends Object

Result of the PurityChecker. Can be queried regarding whether a given tree was side-effect-free, deterministic, or both; also gives reasons if the answer is "no".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PurityChecker.PurityResult.ImpurityReason	A reason that a method is impure: a tree, and a message key explaining what is wrong with it.

Field Summary

Fields

Modifier and Type	Field	Description
protected EnumSet<PurityKind>	kinds	Contains the varieties of purity that the expression has.
protected final List<PurityChecker.PurityResult.ImpurityReason>	notBothReasons	Reasons that the referenced method is not side-effect-free and deterministic.
protected final List<PurityChecker.PurityResult.ImpurityReason>	notDetReasons	Reasons that the referenced method is not deterministic.
protected final List<PurityChecker.PurityResult.ImpurityReason>	notSEFreeReasons	Reasons that the referenced method is not side-effect-free.

Constructor Summary

Constructors

Constructor	Description
PurityResult()	Creates a new PurityResult.

Method Summary

Modifier and Type	Method	Description
void	addNotBothReason(Tree t, String msgId)	Add a reason why the method is not both side-effect-free and deterministic.
void	addNotDetReason(Tree t, String msgId)	Add a reason why the method is not deterministic.
void	addNotSEFreeReason(Tree t, String msgId)	Add a reason why the method is not side-effect-free.
EnumSet<PurityKind>	getKinds()	Returns the kinds of purity that the method has.
List<PurityChecker.PurityResult.ImpurityReason>	getNotBothReasons()	Returns the reasons why the method is not both side-effect-free and deterministic.
List<PurityChecker.PurityResult.ImpurityReason>	getNotDetReasons()	Returns the reasons why the method is not deterministic.
List<PurityChecker.PurityResult.ImpurityReason>	getNotSEFreeReasons()	Returns the reasons why the method is not side-effect-free.
boolean	isPure(EnumSet<PurityKind> otherKinds)	Is the method pure w.r.t.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

notSEFreeReasons

protected final List<PurityChecker.PurityResult.ImpurityReason> notSEFreeReasons

Reasons that the referenced method is not side-effect-free.

notDetReasons

protected final List<PurityChecker.PurityResult.ImpurityReason> notDetReasons

Reasons that the referenced method is not deterministic.

notBothReasons

protected final List<PurityChecker.PurityResult.ImpurityReason> notBothReasons

Reasons that the referenced method is not side-effect-free and deterministic.

kinds

protected EnumSet<PurityKind> kinds

Contains the varieties of purity that the expression has. Starts out with the purities that a method body can be analyzed for (PurityKind.SIDE_EFFECT_FREE and PurityKind.DETERMINISTIC), and elements are removed from it as violations are found.

Constructor Details

PurityResult

public PurityResult()

Creates a new PurityResult.

Method Details

getKinds

public EnumSet<PurityKind> getKinds()

Returns the kinds of purity that the method has.

Returns:

the kinds of purity that the method has

isPure

public boolean isPure(EnumSet<PurityKind> otherKinds)

Is the method pure w.r.t. a given set of kinds?

Parameters:

otherKinds - the varieties of purity to check

Returns:

true if the method is pure with respect to all the given kinds

getNotSEFreeReasons

public List<PurityChecker.PurityResult.ImpurityReason> getNotSEFreeReasons()

Returns the reasons why the method is not side-effect-free.

Returns:

the reasons why the method is not side-effect-free

addNotSEFreeReason

public void addNotSEFreeReason(Tree t,
 String msgId)

Add a reason why the method is not side-effect-free.

Parameters:

t - a tree

msgId - why the tree is not side-effect-free

getNotDetReasons

public List<PurityChecker.PurityResult.ImpurityReason> getNotDetReasons()

Returns the reasons why the method is not deterministic.

Returns:

the reasons why the method is not deterministic

addNotDetReason

public void addNotDetReason(Tree t,
 String msgId)

Add a reason why the method is not deterministic.

Parameters:

t - a tree

msgId - why the tree is not deterministic

getNotBothReasons

public List<PurityChecker.PurityResult.ImpurityReason> getNotBothReasons()

Returns the reasons why the method is not both side-effect-free and deterministic.

Returns:

the reasons why the method is not both side-effect-free and deterministic

addNotBothReason

public void addNotBothReason(Tree t,
 String msgId)

Add a reason why the method is not both side-effect-free and deterministic.

Parameters:

t - tree

msgId - why the tree is not deterministic and side-effect-free

toString

public String toString()

Overrides:

toString in class Object