org.checkerframework.checker.index

Class Subsequence

java.lang.Object

org.checkerframework.checker.index.Subsequence

public class Subsequence
extends Object

Holds information from HasSubsequence annotations.

Field Summary

Fields

Modifier and Type	Field and Description
String	array Name of the Subsequence.
String	from First index of the subsequence in the backing sequence.
String	to Last index of the subsequence in the backing sequence.

Method Summary

Modifier and Type	Method and Description
static FlowExpressionParseUtil.FlowExpressionContext	getContextFromReceiver(Receiver rec, BaseContext checker) If the passed receiver is a FieldAccess, returns the context associated with it.
static Subsequence	getSubsequenceFromReceiver(Receiver rec, AnnotatedTypeFactory factory, TreePath currentPath, FlowExpressionParseUtil.FlowExpressionContext context) Returns a Subsequence representing the HasSubsequence annotation on the declaration of rec or null if there is not such annotation.
static Subsequence	getSubsequenceFromTree(Tree varTree, AnnotatedTypeFactory factory) Returns a Subsequence representing the HasSubsequence annotation on the declaration of varTree or null if there is not such annotation.
static String	negateString(String s, TreePath currentPath, FlowExpressionParseUtil.FlowExpressionContext context) Returns the additive inverse of the given String.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

array

public final String array

Name of the Subsequence.

from

public final String from

First index of the subsequence in the backing sequence.

to

public final String to

Last index of the subsequence in the backing sequence.

Method Detail

getSubsequenceFromTree

public static Subsequence getSubsequenceFromTree(Tree varTree,
                                                 AnnotatedTypeFactory factory)

Returns a Subsequence representing the HasSubsequence annotation on the declaration of varTree or null if there is not such annotation.

Note that this method does not standardize or viewpoint adapt the arguments to the annotation, unlike getSubsequenceFromReceiver.

Parameters:

varTree - some tree

factory - an AnnotatedTypeFactory

Returns:

null or a new Subsequence from the declaration of varTree

getSubsequenceFromReceiver

public static Subsequence getSubsequenceFromReceiver(Receiver rec,
                                                     AnnotatedTypeFactory factory,
                                                     TreePath currentPath,
                                                     FlowExpressionParseUtil.FlowExpressionContext context)

Returns a Subsequence representing the HasSubsequence annotation on the declaration of rec or null if there is not such annotation.

Parameters:

rec - some tree

factory - an AnnotatedTypeFactory

currentPath - the path at which to viewpoint adapt the subsequence

context - the context in which to viewpoint adapt the subsequence

Returns:

null or a new Subsequence from the declaration of varTree

getContextFromReceiver

public static FlowExpressionParseUtil.FlowExpressionContext getContextFromReceiver(Receiver rec,
                                                                                   BaseContext checker)

If the passed receiver is a FieldAccess, returns the context associated with it. Otherwise returns null.

Used to standardize and viewpoint adapt arguments to HasSubsequence annotations.

negateString

public static String negateString(String s,
                                  TreePath currentPath,
                                  FlowExpressionParseUtil.FlowExpressionContext context)

Returns the additive inverse of the given String. That is, if the result of this method is some String s', then s + s' == 0 will evaluate to true. Note that this relies on the fact that the Flow Expression Parser cannot parse multiplication, so it naively just changes '-' to '+' and vice-versa.

The passed String is standardized and viewpoint adapted before this transformation is applied.

toString

public String toString()

Overrides:

toString in class Object