org.checkerframework.dataflow.util

Class PurityUtils

java.lang.Object

org.checkerframework.dataflow.util.PurityUtils

public class PurityUtils
extends Object

An utility class for working with the SideEffectFree, Deterministic, and Pure annotations.

See Also:

SideEffectFree, Deterministic, Pure

Constructor Summary

Constructors

Constructor and Description
PurityUtils()

Method Summary

Modifier and Type	Method and Description
static List<Pure.Kind>	getPurityKinds(AnnotationProvider provider, Element methodElement)
static List<Pure.Kind>	getPurityKinds(AnnotationProvider provider, MethodTree tree)
static boolean	hasPurityAnnotation(AnnotationProvider provider, Element methodElement) Does the method methodElement have any purity annotation?
static boolean	hasPurityAnnotation(AnnotationProvider provider, MethodTree tree) Does the method tree have any purity annotation?
static boolean	isDeterministic(AnnotationProvider provider, Element methodElement) Is the method methodElement deterministic?
static boolean	isDeterministic(AnnotationProvider provider, MethodTree tree) Is the method tree deterministic?
static boolean	isSideEffectFree(AnnotationProvider provider, Element methodElement) Is the method methodElement side-effect-free?
static boolean	isSideEffectFree(AnnotationProvider provider, MethodTree tree) Is the method tree side-effect-free?

Methods inherited from class java.lang.Object

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

Constructor Detail

PurityUtils

public PurityUtils()

Method Detail

hasPurityAnnotation

public static boolean hasPurityAnnotation(AnnotationProvider provider,
                                          MethodTree tree)

Does the method tree have any purity annotation?

hasPurityAnnotation

public static boolean hasPurityAnnotation(AnnotationProvider provider,
                                          Element methodElement)

Does the method methodElement have any purity annotation?

isDeterministic

public static boolean isDeterministic(AnnotationProvider provider,
                                      MethodTree tree)

Is the method tree deterministic?

isDeterministic

public static boolean isDeterministic(AnnotationProvider provider,
                                      Element methodElement)

Is the method methodElement deterministic?

isSideEffectFree

public static boolean isSideEffectFree(AnnotationProvider provider,
                                       MethodTree tree)

Is the method tree side-effect-free?

isSideEffectFree

public static boolean isSideEffectFree(AnnotationProvider provider,
                                       Element methodElement)

Is the method methodElement side-effect-free?

getPurityKinds

public static List<Pure.Kind> getPurityKinds(AnnotationProvider provider,
                                             MethodTree tree)

Returns:

the types of purity of the method tree.

getPurityKinds

public static List<Pure.Kind> getPurityKinds(AnnotationProvider provider,
                                             Element methodElement)

Returns:

the types of purity of the method methodElement. TODO: should the return type be an EnumSet?