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 java.lang.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".

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>>	notBothReasons
protected java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>>	notDetReasons
protected java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>>	notSEFreeReasons
protected java.util.EnumSet<Pure.Kind>	types Contains all the varieties of purity that the expression has.

Constructor Summary

Constructors

Constructor and Description
PurityResult()

Method Summary

Modifier and Type	Method and Description
void	addNotBothReason(com.sun.source.tree.Tree t, java.lang.String msgId) Add reason as a reason why the method is not both side-effect free and deterministic.
void	addNotDetReason(com.sun.source.tree.Tree t, java.lang.String msgId) Add reason as a reason why the method is not deterministic.
void	addNotSEFreeReason(com.sun.source.tree.Tree t, java.lang.String msgId) Add reason as a reason why the method is not side-effect free.
java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>>	getNotBothReasons() Get the reasons why the method is not both side-effect-free and deterministic.
java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>>	getNotDetReasons() Get the reasons why the method is not deterministic.
java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>>	getNotSEFreeReasons() Get the reasons why the method is not side-effect-free.
java.util.EnumSet<Pure.Kind>	getTypes()
boolean	isPure(java.util.Collection<Pure.Kind> kinds) Is the method pure w.r.t.

Methods inherited from class java.lang.Object

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

Field Detail

notSEFreeReasons

protected final java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>> notSEFreeReasons

notDetReasons

protected final java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>> notDetReasons

notBothReasons

protected final java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>> notBothReasons

types

protected java.util.EnumSet<Pure.Kind> types

Contains all the varieties of purity that the expression has. Starts out with all varieties, and elements are removed from it as violations are found.

Constructor Detail

PurityResult

public PurityResult()

Method Detail

getTypes

public java.util.EnumSet<Pure.Kind> getTypes()

isPure

public boolean isPure(java.util.Collection<Pure.Kind> kinds)

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

Parameters:

kinds - the varieties of purity to check

Returns:

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

getNotSEFreeReasons

public java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>> getNotSEFreeReasons()

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

addNotSEFreeReason

public void addNotSEFreeReason(com.sun.source.tree.Tree t,
                               java.lang.String msgId)

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

getNotDetReasons

public java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>> getNotDetReasons()

Get the reasons why the method is not deterministic.

addNotDetReason

public void addNotDetReason(com.sun.source.tree.Tree t,
                            java.lang.String msgId)

Add reason as a reason why the method is not deterministic.

getNotBothReasons

public java.util.List<Pair<com.sun.source.tree.Tree,java.lang.String>> getNotBothReasons()

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

addNotBothReason

public void addNotBothReason(com.sun.source.tree.Tree t,
                             java.lang.String msgId)

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