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(Element element, ValueAnnotatedTypeFactory factory) Returns the exact value of an annotated element according to the Constant Value Checker, or null if the exact value is not known.
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 ExpressionTree	getLengthSequenceTree(Tree lengthTree, IndexMethodIdentifier imf, ProcessingEnvironment processingEnv) Gets a sequence tree for a length access tree, or null if it is not a length access.
static Long	getMaxValue(Tree tree, ValueAnnotatedTypeFactory factory) Finds the maximum value in a Value Checker type.
static int	getMinLen(Tree tree, ValueAnnotatedTypeFactory valueAnnotatedTypeFactory) Queries the Value Checker to determine if there is a known minimum length for the array represented by tree.
static Integer	getMinLenFromTree(Tree tree, ValueAnnotatedTypeFactory valueATF) Looks up the minlen of a member select tree.
static Long	getMinValue(Tree tree, ValueAnnotatedTypeFactory factory) Finds the minimum value in a Value Checker type.
static Range	getPossibleValues(AnnotatedTypeMirror valueType, ValueAnnotatedTypeFactory valueAnnotatedTypeFactory) Returns a range representing the possible integral values represented by the passed AnnotatedTypeMirror.
static List<String>	getValueOfAnnotationWithStringArgument(AnnotationMirror anno) Gets the value field of an annotation with a list of strings in its value field.
static boolean	isSequenceType(TypeMirror type) Determines whether the type is a sequence supported by this checker.

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 Range getPossibleValues(AnnotatedTypeMirror valueType,
                                      ValueAnnotatedTypeFactory valueAnnotatedTypeFactory)

Returns a range representing the possible integral values represented by the passed AnnotatedTypeMirror. If the passed AnnotatedTypeMirror does not contain an IntRange annotation or an IntVal annotation, returns null.

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.

getExactValue

public static Long getExactValue(Element element,
                                 ValueAnnotatedTypeFactory factory)

Returns the exact value of an annotated element according to the Constant Value Checker, or null if the exact value is not known.

Parameters:

element - the element to get the exact value from

factory - ValueAnnotatedTypeFactory used for annotation accessing

Returns:

the exact value of the element if it is constant, or null otherwise

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,
                            ValueAnnotatedTypeFactory valueAnnotatedTypeFactory)

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

isSequenceType

public static boolean isSequenceType(TypeMirror type)

Determines whether the type is a sequence supported by this checker.

getLengthSequenceTree

public static ExpressionTree getLengthSequenceTree(Tree lengthTree,
                                                   IndexMethodIdentifier imf,
                                                   ProcessingEnvironment processingEnv)

Gets a sequence tree for a length access tree, or null if it is not a length access.

getMinLenFromTree

public static Integer getMinLenFromTree(Tree tree,
                                        ValueAnnotatedTypeFactory valueATF)

Looks up the minlen of a member select tree. The tree must be an access to a sequence length.