org.checkerframework.checker.index

Class IndexUtil

java.lang.Object

org.checkerframework.checker.index.IndexUtil

public class IndexUtil
extends Object

A collection of utility functions used by several Index Checker subcheckers.

Constructor Summary

Constructors

Constructor and Description
IndexUtil()

Method Summary

Modifier and Type	Method and Description
static Long	getExactValue(Tree tree, ValueAnnotatedTypeFactory factory) Either returns the exact value of the given tree according to the Constant Value Checker, or null if the exact value is not known.
static Long	getMaxValue(Tree tree, ValueAnnotatedTypeFactory factory) Finds the maximum value in a Value Checker type.
static int	getMinLen(AnnotationMirror anm) Returns the MinLen value of the given annotation mirror, or -1 if the annotation mirror is null.
static int	getMinLen(Tree tree, MinLenAnnotatedTypeFactory minLenAnnotatedTypeFactory) Queries the MinLen Checker to determine if there is a known minimum length for the array represented by tree.
static Long	getMinValue(Tree tree, ValueAnnotatedTypeFactory factory) Finds the minimum value in a Value Checker type.
static List<Long>	getPossibleValues(AnnotatedTypeMirror valueType) Get the list of possible values from an AnnotatedTypeMirror containing an IntVal.
static List<String>	getValueOfAnnotationWithStringArgument(AnnotationMirror anno) Gets the value field of an annotation with a list of strings in its value field.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexUtil

public IndexUtil()

Method Detail

getValueOfAnnotationWithStringArgument

public static List<String> getValueOfAnnotationWithStringArgument(AnnotationMirror anno)

Gets the value field of an annotation with a list of strings in its value field. Null is returned if the annotation has no value field.

For the Index Checker, this will get a list of array names from an Upper Bound or SameLen annotation. making this safe to call on any Upper Bound or SameLen annotation.

getPossibleValues

public static List<Long> getPossibleValues(AnnotatedTypeMirror valueType)

Get the list of possible values from an AnnotatedTypeMirror containing an IntVal. Empty list means no possible values (dead code). Returns null if the AnnotatedTypeMirror doesn't contain an IntVal.

getExactValue

public static Long getExactValue(Tree tree,
                                 ValueAnnotatedTypeFactory factory)

Either returns the exact value of the given tree according to the Constant Value Checker, or null if the exact value is not known. This method should only be used by clients who need exactly one value -- such as the LBC's binary operator rules -- and not by those that need to know whether a valueType belongs to a particular qualifier.

getMinValue

public static Long getMinValue(Tree tree,
                               ValueAnnotatedTypeFactory factory)

Finds the minimum value in a Value Checker type. If there is no information (such as when the list of possible values is empty or null), returns null. Otherwise, returns the smallest value in the list of possible values.

getMaxValue

public static Long getMaxValue(Tree tree,
                               ValueAnnotatedTypeFactory factory)

Finds the maximum value in a Value Checker type. If there is no information (such as when the list of possible values is empty or null), returns null. Otherwise, returns the smallest value in the list of possible values.

getMinLen

public static int getMinLen(Tree tree,
                            MinLenAnnotatedTypeFactory minLenAnnotatedTypeFactory)

Queries the MinLen Checker to determine if there is a known minimum length for the array represented by tree. If not, returns -1.

getMinLen

public static int getMinLen(AnnotationMirror anm)

Returns the MinLen value of the given annotation mirror, or -1 if the annotation mirror is null.