org.checkerframework.checker.index.inequality

Class LessThanAnnotatedTypeFactory

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeFactory

org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,org.checkerframework.framework.flow.CFStore,org.checkerframework.framework.flow.CFTransfer,org.checkerframework.framework.flow.CFAnalysis>

org.checkerframework.common.basetype.BaseAnnotatedTypeFactory

org.checkerframework.checker.index.inequality.LessThanAnnotatedTypeFactory

All Implemented Interfaces:

org.checkerframework.javacutil.AnnotationProvider

public class LessThanAnnotatedTypeFactory
extends org.checkerframework.common.basetype.BaseAnnotatedTypeFactory

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

org.checkerframework.framework.type.GenericAnnotatedTypeFactory.ScanState

Nested classes/interfaces inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

org.checkerframework.framework.type.AnnotatedTypeFactory.InheritedFromClassAnnotator

Field Summary

Fields

Modifier and Type	Field and Description
AnnotationMirror	UNKNOWN

Fields inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

analysis, cfgVisualizer, defaults, dependentTypesHelper, emptyStore, FLOW_BY_DEFAULT, flowResult, flowResultAnalysisCaches, initializationStaticStore, initializationStore, methodInvocationStores, poly, regularExitStores, returnStatementStores, scannedClasses, transfer, treeAnnotator, typeAnnotator

Fields inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

checker, elements, fromExpressionTreeCache, fromMemberTreeCache, fromTypeTreeCache, ignoreUninferredTypeArguments, loader, processingEnv, qualHierarchy, reflectionResolver, root, shouldCache, trees, typeArgumentInference, typeFormatter, typeHierarchy, types, typeVarSubstitutor, uid, visitorState

Constructor Summary

Constructors

Constructor and Description
LessThanAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
protected org.checkerframework.framework.util.dependenttypes.DependentTypesHelper	createDependentTypesHelper()
AnnotationMirror	createLessThanQualifier(List<String> expressions) Creates a less than qualifier given the expressions.
AnnotationMirror	createLessThanQualifier(String expression) Returns @LessThan(expression)
org.checkerframework.framework.type.QualifierHierarchy	createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)
protected Set<Class<? extends Annotation>>	createSupportedTypeQualifiers()
static List<String>	getLessThanExpressions(AnnotationMirror annotation) Returns a modifiable list of expressions in the annotation sorted.
List<String>	getLessThanExpressions(ExpressionTree expression) Returns a sorted, modifiable list of expressions that expression is less than.
org.checkerframework.common.value.ValueAnnotatedTypeFactory	getValueAnnotatedTypeFactory() Returns the Value Checker's annotated type factory.
static boolean	isLessThan(AnnotationMirror left, String right)
boolean	isLessThan(Tree left, String right)
boolean	isLessThanByValue(Tree smaller, String bigger, TreePath path)
static boolean	isLessThanOrEqual(AnnotationMirror left, String right)
boolean	isLessThanOrEqual(Tree left, String right)

Methods inherited from class org.checkerframework.common.basetype.BaseAnnotatedTypeFactory

createFlowAnalysis

Methods inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

addCheckedCodeDefaults, addCheckedStandardDefaults, addComputedTypeAnnotations, addComputedTypeAnnotations, addComputedTypeAnnotations, addDefaultAnnotations, addTypeNameImplicit, addUncheckedCodeDefaults, addUncheckedStandardDefaults, analyze, applyInferredAnnotations, checkAndPerformFlowAnalysis, checkForDefaultQualifierInHierarchy, constructorFromUse, createAndInitQualifierDefaults, createCFGVisualizer, createFlowTransferFunction, createQualifierDefaults, createQualifierPolymorphism, createTreeAnnotator, createTypeAnnotator, fromNewClass, getAnnotatedTypeLhs, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpressionString, getAnnotationFromReceiver, getAnnotationMirrorFromJavaExpressionString, getCFGVisualizer, getDependentTypesHelper, getEmptyStore, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getMethodReturnType, getNodesForTree, getReceiverFromJavaExpressionString, getRegularExitStore, getResultingTypeOfConstructorMemberReference, getReturnStatementStores, getShouldDefaultTypeVarLocals, getSortedQualifierNames, getStoreAfter, getStoreAfter, getStoreAfter, getStoreBefore, getStoreBefore, getStoreBefore, getSupportedMonotonicTypeQualifiers, getTypeFactoryOfSubchecker, handleCFGViz, methodFromUse, performFlowAnalysis, postDirectSuperTypes, postInit, preProcessClassTree, setRoot, typeVariablesFromUse

Methods inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

adaptGetClassReturnTypeToReceiver, addAliasedAnnotation, addAliasedAnnotation, addAliasedAnnotation, addAliasedAnnotation, addAliasedDeclAnnotation, addAnnotationFromFieldInvariant, addInheritedAnnotation, aliasedAnnotation, annotateInheritedFromClass, annotateInheritedFromClass, checkInvalidOptionsInferSignatures, createAnnotatedTypeFormatter, createAnnotationClassLoader, createAnnotationFormatter, createQualifierHierarchy, createQualifierHierarchy, createQualifierHierarchyFactory, createTypeArgumentInference, createTypeHierarchy, createTypeVariableSubstitutor, declarationFromElement, fromElement, fromElement, fromElement, getAnnotatedNullType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFormatter, getAnnotatedTypeFromTypeTree, getAnnotationFormatter, getAnnotationMirror, getAnnotationWithMetaAnnotation, getBoxedType, getBundledTypeQualifiersWithoutPolyAll, getBundledTypeQualifiersWithPolyAll, getCacheSize, getContext, getCurrentClassTree, getCurrentClassType, getCurrentMethodReceiver, getDeclAnnotation, getDeclAnnotationNoAliases, getDeclAnnotations, getDeclAnnotationWithMetaAnnotation, getElementUtils, getEnclosingMethod, getEnclosingType, getFieldInvariantAnnotationTree, getFieldInvariantDeclarationAnnotations, getFieldInvariants, getFnInterfaceFromTree, getFnInterfaceFromTree, getImplicitReceiverType, getNarrowedPrimitive, getPath, getProcessingEnv, getQualifierHierarchy, getReceiverType, getSelfType, getStringType, getSupportedTypeQualifiers, getTreeUtils, getTypeArgumentInference, getTypeHierarchy, getTypeVarSubstitutor, getUnboxedType, getUninferredWildcardType, getVisitorState, getWholeProgramInference, initializeReflectionResolution, isAnyEnclosingThisDeref, isFromByteCode, isFromStubFile, isMostEnclosingThisDeref, isSupportedQualifier, isWithinConstructor, methodFromUse, parseStubFiles, postAsMemberOf, postProcessClassTree, postTypeVarSubstitution, setPathHack, toAnnotatedType, toString, type, widenToUpperBound

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public final AnnotationMirror UNKNOWN

Constructor Detail

LessThanAnnotatedTypeFactory

public LessThanAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker)

Method Detail

getValueAnnotatedTypeFactory

public org.checkerframework.common.value.ValueAnnotatedTypeFactory getValueAnnotatedTypeFactory()

Returns the Value Checker's annotated type factory.

createSupportedTypeQualifiers

protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers()

Overrides:

createSupportedTypeQualifiers in class org.checkerframework.framework.type.AnnotatedTypeFactory

createDependentTypesHelper

protected org.checkerframework.framework.util.dependenttypes.DependentTypesHelper createDependentTypesHelper()

Overrides:

createDependentTypesHelper in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,org.checkerframework.framework.flow.CFStore,org.checkerframework.framework.flow.CFTransfer,org.checkerframework.framework.flow.CFAnalysis>

createQualifierHierarchy

public org.checkerframework.framework.type.QualifierHierarchy createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)

Overrides:

createQualifierHierarchy in class org.checkerframework.framework.type.AnnotatedTypeFactory

isLessThan

public boolean isLessThan(Tree left,
                          String right)

Returns:

Is left less than right?

isLessThan

public static boolean isLessThan(AnnotationMirror left,
                                 String right)

Returns:

Is left less than right?

isLessThanByValue

public boolean isLessThanByValue(Tree smaller,
                                 String bigger,
                                 TreePath path)

Returns:

smaller < bigger, using information from the Value Checker

isLessThanOrEqual

public boolean isLessThanOrEqual(Tree left,
                                 String right)

Returns:

Is left less than or equal to right?

isLessThanOrEqual

public static boolean isLessThanOrEqual(AnnotationMirror left,
                                        String right)

Returns:

Is left less than or equal to right?

getLessThanExpressions

public List<String> getLessThanExpressions(ExpressionTree expression)

Returns a sorted, modifiable list of expressions that expression is less than. If the expression is annotated with LessThanBottom, null is returned.

createLessThanQualifier

public AnnotationMirror createLessThanQualifier(List<String> expressions)

Creates a less than qualifier given the expressions.

If expressions is null, LessThanBottom is returned. If expressions is empty, LessThanUnknown is returned. Otherwise, LessThanUnknown(expressions) is returned.

createLessThanQualifier

public AnnotationMirror createLessThanQualifier(String expression)

Returns @LessThan(expression)

getLessThanExpressions

public static List<String> getLessThanExpressions(AnnotationMirror annotation)

Returns a modifiable list of expressions in the annotation sorted. If the annotation is LessThanBottom, return null. If the annotation is LessThanUnknown return the empty list.