org.checkerframework.checker.index

Class IndexMethodIdentifier

java.lang.Object

org.checkerframework.checker.index.IndexMethodIdentifier

public class IndexMethodIdentifier
extends Object

Given a Tree or other construct, this class has methods to query whether it is a particular method call.

Constructor Summary

Constructors

Constructor and Description
IndexMethodIdentifier(AnnotatedTypeFactory factory)

Method Summary

Modifier and Type	Method and Description
boolean	isIndexOfString(Tree methodTree) Returns true iff the argument is an invocation of String#indexOf or String#lastIndexOf that takes a string parameter.
boolean	isLengthOfMethodInvocation(ExecutableElement ele) Returns true if tree evaluates to the length of "this".
boolean	isLengthOfMethodInvocation(Node node) Returns true if node is an invocation of a method that returns the length of this
boolean	isLengthOfMethodInvocation(Tree tree) Returns true if tree is an invocation of a method that returns the length of "this"
boolean	isMathMax(Tree methodTree) Returns true iff the argument is an invocation of Math.max.
boolean	isMathMin(Tree methodTree) Returns true iff the argument is an invocation of Math.min.
boolean	isMathRandom(Tree tree, ProcessingEnvironment processingEnv) Returns true iff the argument is an invocation of Math.random().
boolean	isRandomNextDouble(Tree tree, ProcessingEnvironment processingEnv) Returns true iff the argument is an invocation of Random.nextDouble().
boolean	isRandomNextInt(Tree tree, ProcessingEnvironment processingEnv) Returns true iff the argument is an invocation of Random.nextInt().

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexMethodIdentifier

public IndexMethodIdentifier(AnnotatedTypeFactory factory)

Method Detail

isIndexOfString

public boolean isIndexOfString(Tree methodTree)

Returns true iff the argument is an invocation of String#indexOf or String#lastIndexOf that takes a string parameter.

Parameters:

methodTree - the method invocation tree to be tested

Returns:

true iff the argument is an invocation of one of String's indexOf or lastIndexOf methods that takes another string as a parameter.

isMathMin

public boolean isMathMin(Tree methodTree)

Returns true iff the argument is an invocation of Math.min.

Parameters:

methodTree - the method invocation tree to be tested

Returns:

true iff the argument is an invocation of Math.min()

isMathMax

public boolean isMathMax(Tree methodTree)

Returns true iff the argument is an invocation of Math.max.

isMathRandom

public boolean isMathRandom(Tree tree,
                            ProcessingEnvironment processingEnv)

Returns true iff the argument is an invocation of Math.random().

isRandomNextDouble

public boolean isRandomNextDouble(Tree tree,
                                  ProcessingEnvironment processingEnv)

Returns true iff the argument is an invocation of Random.nextDouble().

isRandomNextInt

public boolean isRandomNextInt(Tree tree,
                               ProcessingEnvironment processingEnv)

Returns true iff the argument is an invocation of Random.nextInt().

isLengthOfMethodInvocation

public boolean isLengthOfMethodInvocation(Tree tree)

Returns true if tree is an invocation of a method that returns the length of "this"

Parameters:

tree - a tree

Returns:

true if tree is an invocation of a method that returns the length of this

isLengthOfMethodInvocation

public boolean isLengthOfMethodInvocation(ExecutableElement ele)

Returns true if tree evaluates to the length of "this". This might be a call to String,length, or a method annotated with @LengthOf.

Returns:

true if tree evaluates to the length of "this"

isLengthOfMethodInvocation

public boolean isLengthOfMethodInvocation(Node node)

Returns true if node is an invocation of a method that returns the length of this

Parameters:

node - a node

Returns:

true if node is an invocation of a method that returns the length of this