org.checkerframework.checker.index.upperbound

Class UBQualifier

java.lang.Object

org.checkerframework.checker.index.upperbound.UBQualifier

Direct Known Subclasses:

UBQualifier.UpperBoundUnknownQualifier

public abstract class UBQualifier
extends Object

Abstraction for Upper Bound annotations.

UpperBoundUnknown is modeled as UBQualifier.UpperBoundUnknownQualifier and UpperBoundBottom is modeled as UpperBoundBottomQualifier.

LTLengthOf is modeled by LessThanLengthOf. LTEqLengthOf is equivalent to @LessThanLengthOf with an offset of -1. LTOMLengthOf is equivalent to @LessThanLengthOf with an offset of 1.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UBQualifier.UpperBoundUnknownQualifier

Constructor Summary

Constructors

Constructor and Description
UBQualifier()

Method Summary

Modifier and Type	Method and Description
static UBQualifier	createUBQualifier(AnnotatedTypeMirror type, AnnotationMirror top)
static UBQualifier	createUBQualifier(AnnotationMirror am)
static UBQualifier	createUBQualifier(List<String> arrays, List<String> offsets) Creates an UBQualifier from the given arrays and offsets.
static UBQualifier	createUBQualifier(String array, String offset)
abstract UBQualifier	glb(UBQualifier other)
boolean	hasArrayWithOffsetNeg1(String array) Returns whether or not this qualifier has array with offset of -1.
boolean	isBottom()
boolean	isLessThanLengthOf(String array) Is the value with this qualifier less than the length of array?
boolean	isLessThanLengthOfAny(List<String> arrays) Is the value with this qualifier less than the length of any of the arrays?
boolean	isLessThanLengthQualifier()
boolean	isLessThanOrEqualTo(String array) Is the value with this qualifier less than or equal to the length of array?
boolean	isPoly()
abstract boolean	isSubtype(UBQualifier superType)
boolean	isUnknown()
abstract UBQualifier	lub(UBQualifier other)
UBQualifier	minusOffset(int value)
UBQualifier	minusOffset(Node node, UpperBoundAnnotatedTypeFactory factory)
UBQualifier	plusOffset(int value)
UBQualifier	plusOffset(Node node, UpperBoundAnnotatedTypeFactory factory) Add the node as an offset to a copy of this qualifier.
UBQualifier	widenUpperBound(UBQualifier obj)

Methods inherited from class java.lang.Object

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

Constructor Detail

UBQualifier

public UBQualifier()

Method Detail

createUBQualifier

public static UBQualifier createUBQualifier(AnnotationMirror am)

createUBQualifier

public static UBQualifier createUBQualifier(String array,
                                            String offset)

createUBQualifier

public static UBQualifier createUBQualifier(AnnotatedTypeMirror type,
                                            AnnotationMirror top)

createUBQualifier

public static UBQualifier createUBQualifier(List<String> arrays,
                                            List<String> offsets)

Creates an UBQualifier from the given arrays and offsets. The list of arrays may not be empty. If the offsets list is empty, then an offset of 0 is used for each array. If the offsets list is not empty, then it must be the same size as array.

Parameters:

arrays - Non-empty list of arrays

offsets - list of offset, if empty, an offset of 0 is used

Returns:

an UBQualifier for the arrays with the given offsets.

plusOffset

public UBQualifier plusOffset(Node node,
                              UpperBoundAnnotatedTypeFactory factory)

Add the node as an offset to a copy of this qualifier. If this qualifier is UNKNOWN or BOTTOM, then UNKNOWN is returned. Otherwise, see LessThanLengthOf#plusOffset(int) for an explanation of how node is added as an offset.

Parameters:

node - Node

factory - AnnotatedTypeFactory

Returns:

a copy of this qualifier with node added as an offset

plusOffset

public UBQualifier plusOffset(int value)

minusOffset

public UBQualifier minusOffset(Node node,
                               UpperBoundAnnotatedTypeFactory factory)

minusOffset

public UBQualifier minusOffset(int value)

isLessThanLengthQualifier

public boolean isLessThanLengthQualifier()

isUnknown

public boolean isUnknown()

isBottom

public boolean isBottom()

isPoly

public boolean isPoly()

isSubtype

public abstract boolean isSubtype(UBQualifier superType)

lub

public abstract UBQualifier lub(UBQualifier other)

widenUpperBound

public UBQualifier widenUpperBound(UBQualifier obj)

glb

public abstract UBQualifier glb(UBQualifier other)

isLessThanLengthOf

public boolean isLessThanLengthOf(String array)

Is the value with this qualifier less than the length of array?

Parameters:

array - String array

Returns:

whether or not the value with this qualifier is less than the length of array

isLessThanLengthOfAny

public boolean isLessThanLengthOfAny(List<String> arrays)

Is the value with this qualifier less than the length of any of the arrays?

Parameters:

arrays - list of arrays

Returns:

whether or not the value with this qualifier is less than the length of any of the arrays

hasArrayWithOffsetNeg1

public boolean hasArrayWithOffsetNeg1(String array)

Returns whether or not this qualifier has array with offset of -1.

Parameters:

array - array expression

Returns:

whether or not this qualifier has array with offset of -1.

isLessThanOrEqualTo

public boolean isLessThanOrEqualTo(String array)

Is the value with this qualifier less than or equal to the length of array?

Parameters:

array - String array

Returns:

whether or not the value with this qualifier is less than or equal to the length of array.