org.checkerframework.framework.util

Class JavaExpressionParseUtil

java.lang.Object

org.checkerframework.framework.util.JavaExpressionParseUtil

public class JavaExpressionParseUtil
extends Object

A collection of helper methods to parse a string that represents a restricted Java expression.

See the Checker Framework Manual:

Writing Java expressions as annotation arguments, Annotations whose argument is a Java expression (dependent type annotations)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaExpressionParseUtil.JavaExpressionContext Context used to parse a Java expression.
static class	JavaExpressionParseUtil.JavaExpressionParseException An exception that indicates a parse error.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	ANCHORED_PARAMETER_PATTERN Anchored pattern for a formal parameter use.
protected static String	PARAMETER_REGEX Regular expression for a formal parameter use.
protected static Pattern	UNANCHORED_PARAMETER_PATTERN Unanchored; can be used to find all formal parameter uses.

Constructor Summary

Constructors

Constructor and Description
JavaExpressionParseUtil()

Method Summary

Modifier and Type	Method and Description
static JavaExpression	fromVariableTree(AnnotatedTypeFactory provider, VariableTree tree)
static List<Integer>	parameterIndices(String s) Returns a list of 1-based indices of all formal parameters that occur in s.
static JavaExpression	parse(String expression, JavaExpressionParseUtil.JavaExpressionContext context, TreePath localScope, boolean useLocalScope) Parse a string and return its representation as a JavaExpression, or throw an JavaExpressionParseUtil.JavaExpressionParseException.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_REGEX

protected static final String PARAMETER_REGEX

Regular expression for a formal parameter use.

See Also:

Constant Field Values

ANCHORED_PARAMETER_PATTERN

protected static final Pattern ANCHORED_PARAMETER_PATTERN

Anchored pattern for a formal parameter use.

UNANCHORED_PARAMETER_PATTERN

protected static final Pattern UNANCHORED_PARAMETER_PATTERN

Unanchored; can be used to find all formal parameter uses.

Constructor Detail

JavaExpressionParseUtil

public JavaExpressionParseUtil()

Method Detail

parse

public static JavaExpression parse(String expression,
                                   JavaExpressionParseUtil.JavaExpressionContext context,
                                   TreePath localScope,
                                   boolean useLocalScope)
                            throws JavaExpressionParseUtil.JavaExpressionParseException

Parse a string and return its representation as a JavaExpression, or throw an JavaExpressionParseUtil.JavaExpressionParseException.

Parameters:

expression - a Java expression to parse

context - information about any receiver and arguments

localScope - path to local scope to use

useLocalScope - whether localScope should be used to resolve identifiers

Throws:

JavaExpressionParseUtil.JavaExpressionParseException

parameterIndices

public static List<Integer> parameterIndices(String s)

Returns a list of 1-based indices of all formal parameters that occur in s. Each formal parameter occurs in s as a string like "#1" or "#4". This routine does not do proper parsing; for instance, if "#2" appears within a string in s, then 2 would be in the result list.

Parameters:

s - a Java expression

Returns:

a list of 1-based indices of all formal parameters that occur in s

fromVariableTree

public static JavaExpression fromVariableTree(AnnotatedTypeFactory provider,
                                              VariableTree tree)
                                       throws JavaExpressionParseUtil.JavaExpressionParseException

Throws:

JavaExpressionParseUtil.JavaExpressionParseException