ValueAnnotatedTypeFactory (checker-framework 2.8.1 API)

java.lang.Object
- org.checkerframework.framework.type.AnnotatedTypeFactory
- - org.checkerframework.framework.type.GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis>
  - - org.checkerframework.common.basetype.BaseAnnotatedTypeFactory
    - - org.checkerframework.common.value.ValueAnnotatedTypeFactory

All Implemented Interfaces:

AnnotationProvider
```
public class ValueAnnotatedTypeFactory
extends BaseAnnotatedTypeFactory
```
AnnotatedTypeFactory for the Value type system.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ValueAnnotatedTypeFactory.ValueTreeAnnotator` The TreeAnnotator for this AnnotatedTypeFactory.
`protected class`	`ValueAnnotatedTypeFactory.ValueTypeAnnotator` Performs pre-processing on annotations written by users, replacing illegal annotations by legal ones.

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

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected AnnotationMirror`	`BOTTOMVAL` The bottom type for this hierarchy.
`protected static Set<String>`	`COVERED_CLASS_STRINGS` The domain of the Constant Value Checker: the types for which it estimates possible values.
`protected static int`	`MAX_VALUES` The maximum number of values allowed in an annotation's array.
`AnnotationMirror`	`POLY` The canonical @`PolyValue` annotation.
`protected AnnotationMirror`	`UNKNOWNVAL` The top type for this hierarchy.

Fields inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory
analysis, cfgVisualizer, defaults, dependentTypesHelper, emptyStore, flowByDefault, 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, objectGetClass, processingEnv, qualHierarchy, reflectionResolver, root, shouldCache, trees, typeArgumentInference, typeFormatter, typeHierarchy, types, typeVarSubstitutor, uid, visitorState

Constructor Summary

Constructors
Constructor and Description

ValueAnnotatedTypeFactory(BaseTypeChecker checker)

Constructors
Constructor and Description
`ValueAnnotatedTypeFactory(BaseTypeChecker checker)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnnotationMirror`	`canonicalAnnotation(AnnotationMirror anno)` Returns the canonical annotation for the passed annotation.
`AnnotationMirror`	`convertArrayLenToArrayLenRange(AnnotationMirror arrayLenAnno)` Converts an `@ArrayLen` annotation to an `@ArrayLenRange` annotation.
`AnnotationMirror`	`convertIntRangeToIntVal(AnnotationMirror intRangeAnno)` Convert an `@IntRange` annotation to an `@IntVal` annotation, or to UNKNOWNVAL if the input is too wide to be represented as an `@IntVal`.
`AnnotationMirror`	`convertIntValToIntRange(AnnotationMirror intValAnno)` Converts an `@IntVal` annotation to an `@IntRange` annotation.
`AnnotationMirror`	`createArrayLenAnnotation(List<Integer> values)` Returns a `ArrayLen` annotation using the values.
`AnnotationMirror`	`createArrayLenRangeAnnotation(int from, int to)` Create an `@ArrayLenRange` annotation from the two (inclusive) bounds.
`AnnotationMirror`	`createArrayLenRangeAnnotation(Range range)` Create an `@ArrayLenRange` annotation from the range.
`AnnotationMirror`	`createBooleanAnnotation(List<Boolean> values)` Returns a `BoolVal` annotation using the values.
`AnnotationMirror`	`createCharAnnotation(List<Character> values)` Returns a `IntVal` annotation using the values.
`AnnotationMirror`	`createDoubleValAnnotation(List<Double> values)` Returns a `DoubleVal` annotation using the values.
`CFTransfer`	`createFlowTransferFunction(CFAbstractAnalysis<CFValue,CFStore,CFTransfer> analysis)` Returns the appropriate transfer function that is used for the org.checkerframework.dataflow analysis.
`AnnotationMirror`	`createIntRangeAnnotation(Range range)` Create an `@IntRange` or `@IntVal` annotation from the range.
`AnnotationMirror`	`createIntValAnnotation(List<Long> values)` Returns a `IntVal` or `IntRange` annotation using the values.
`AnnotationMirror`	`createNumberAnnotationMirror(List<Number> values)`
`QualifierHierarchy`	`createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory)` Factory method to easily change what QualifierHierarchy is created.
`AnnotationMirror`	`createStringAnnotation(List<String> values)` Returns a `StringVal` annotation using the values.
`protected Set<Class<? extends Annotation>>`	`createSupportedTypeQualifiers()` Returns a mutable set of annotation classes that are supported by a checker.
`protected TreeAnnotator`	`createTreeAnnotator()` Returns a `TreeAnnotator` that adds annotations to a type based on the contents of a tree.
`protected TypeAnnotator`	`createTypeAnnotator()` Returns a `ImplicitsTypeAnnotator` that adds annotations to a type based on the content of the type itself.
`protected TypeHierarchy`	`createTypeHierarchy()` Creates the type subtyping checker using the current type qualifier hierarchy.
`static List<Integer>`	`getArrayLength(AnnotationMirror arrayAnno)` Returns the set of possible array lengths as a sorted list with no duplicate values.
`static List<Boolean>`	`getBooleanValues(AnnotationMirror boolAnno)` Returns the set of possible values as a sorted list with no duplicate values.
`static List<Character>`	`getCharValues(AnnotationMirror intAnno)` Returns the set of possible values as a sorted list with no duplicate values.
`static List<Double>`	`getDoubleValues(AnnotationMirror doubleAnno)` Returns the set of possible values as a sorted list with no duplicate values.
`protected Set<Class<? extends Annotation>>`	`getFieldInvariantDeclarationAnnotations()` Returns the set of classes of field invariant annotations.
`FieldInvariants`	`getFieldInvariants(TypeElement element)` Returns the field invariants for the given class, as expressed by the user in `@FieldInvariant` method annotations.
`long`	`getFromValueFromIntRange(AnnotatedTypeMirror atm)` Finds the appropriate value for the `from` value of an annotated type mirror containing an `IntRange` annotation.
`static List<Long>`	`getIntValues(AnnotationMirror intAnno)` Returns the set of possible values as a sorted list with no duplicate values.
`Integer`	`getMaxLenValue(AnnotationMirror annotation)` Used to find the maximum length of an array.
`Long`	`getMinimumIntegralValue(AnnotatedTypeMirror atm)` Returns the smallest possible value that an integral annotation might take on.
`int`	`getMinLenFromString(String sequenceExpression, Tree tree, TreePath currentPath)` Returns the minimum length of an array expression or 0 if the min length is unknown.
`int`	`getMinLenValue(AnnotatedTypeMirror atm)`
`int`	`getMinLenValue(AnnotationMirror annotation)` Used to find the minimum length of an array, which is useful for array bounds checking.
`static Range`	`getRange(AnnotationMirror rangeAnno)` Returns a `Range` bounded by the values specified in the given `@Range` annotation.
`static List<String>`	`getStringValues(AnnotationMirror stringAnno)` Returns the set of possible values as a sorted list with no duplicate values.
`long`	`getToValueFromIntRange(AnnotatedTypeMirror atm)` Finds the appropriate value for the `to` value of an annotated type mirror containing an `IntRange` annotation.
`boolean`	`isIntRange(AnnotationMirror anm)`
`boolean`	`isIntRange(Set<AnnotationMirror> anmSet)`
`AnnotatedTypeFactory.ParameterizedExecutableType`	`methodFromUse(ExpressionTree tree, ExecutableElement methodElt, AnnotatedTypeMirror receiverType)` Creates array length annotations for the result of the Enum.values() method, which is the number of possible values of the enum.

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, createDependentTypesHelper, createQualifierDefaults, createQualifierPolymorphism, fromNewClass, getAnnotatedTypeLhs, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpressionString, getAnnotationFromReceiver, getAnnotationMirrorFromJavaExpressionString, getCFGVisualizer, getDependentTypesHelper, getEmptyStore, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getMethodReturnType, getNodesForTree, getQualifierPolymorphism, 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, annotateInheritedFromClass, annotateInheritedFromClass, checkInvalidOptionsInferSignatures, createAnnotatedTypeFormatter, createAnnotationClassLoader, createAnnotationFormatter, createQualifierHierarchy, createQualifierHierarchy, createQualifierHierarchyFactory, createTypeArgumentInference, 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, getEnclosingElementForArtificialTree, getEnclosingType, getFieldInvariantAnnotationTree, 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, parseStubFiles, postAsMemberOf, postProcessClassTree, postTypeVarSubstitution, setEnclosingElementForArtificialTree, toAnnotatedType, toString, type, widenToUpperBound

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_VALUES
```
protected static final int MAX_VALUES
```
    The maximum number of values allowed in an annotation's array.
    
    See Also:
    
    Constant Field Values
  - COVERED_CLASS_STRINGS
```
protected static final Set<String> COVERED_CLASS_STRINGS
```
    The domain of the Constant Value Checker: the types for which it estimates possible values.
  - UNKNOWNVAL
```
protected final AnnotationMirror UNKNOWNVAL
```
    The top type for this hierarchy.
  - BOTTOMVAL
```
protected final AnnotationMirror BOTTOMVAL
```
    The bottom type for this hierarchy.
  - POLY
```
public final AnnotationMirror POLY
```
    The canonical @PolyValue annotation.
- Constructor Detail
  - ValueAnnotatedTypeFactory
```
public ValueAnnotatedTypeFactory(BaseTypeChecker checker)
```
- Method Detail
  - canonicalAnnotation
```
public AnnotationMirror canonicalAnnotation(AnnotationMirror anno)
```
    Description copied from class: AnnotatedTypeFactory
    
    Returns the canonical annotation for the passed annotation. Returns null if the passed annotation is not an alias of a canonical one in the framework.
    A canonical annotation is the internal annotation that will be used by the Checker Framework in the aliased annotation's place.
    
    Overrides:
    
    canonicalAnnotation in class AnnotatedTypeFactory
    
    Parameters:
    
    anno - the qualifier to check for an alias
    
    Returns:
    
    the canonical annotation, or null if none exists
  - createSupportedTypeQualifiers
```
protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers()
```
    Description copied from class: AnnotatedTypeFactory
    Returns a mutable set of annotation classes that are supported by a checker.
    Subclasses may override this method to return a mutable set of their supported type qualifiers through one of the 5 approaches shown below.
    Subclasses should not call this method; they should call AnnotatedTypeFactory.getSupportedTypeQualifiers() instead.
    By default, a checker supports PolyAll, and all annotations located in a subdirectory called qual that's located in the same directory as the checker. Note that only annotations defined with the @Target({ElementType.TYPE_USE}) meta-annotation (and optionally with the additional value of ElementType.TYPE_PARAMETER, but no other ElementType values) are automatically considered as supported annotations.
    To not support PolyAll, see examples below.
    To support a different set of annotations than those in the qual subdirectory, or that have other ElementType values, see examples below.
    In total, there are 5 ways to indicate annotations that are supported by a checker:
    1. Only support annotations located in a checker's qual directory, and PolyAll:
      This is the default behavior. Simply place those annotations within the qual directory.
    2. Support annotations located in a checker's qual directory, but without PolyAll:
      Place those annotations within the qual directory, and override AnnotatedTypeFactory.createSupportedTypeQualifiers() by calling AnnotatedTypeFactory.getBundledTypeQualifiersWithPolyAll(Class...) with no parameters passed in. Code example:
      @Override protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers() { return getBundledTypeQualifiersWithoutPolyAll(); }
    3. Support annotations located in a checker's qual directory, PolyAll, and a list of other annotations:
      Place those annotations within the qual directory, and override AnnotatedTypeFactory.createSupportedTypeQualifiers() by calling AnnotatedTypeFactory.getBundledTypeQualifiersWithPolyAll(Class...) with a varargs parameter list of the other annotations. Code example:
      @Override protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers() { return getBundledTypeQualifiersWithPolyAll(Regex.class, PartialRegex.class, RegexBottom.class, UnknownRegex.class); }
    4. Support annotations located in a checker's qual directory and a list of other annotations, but without supporting PolyAll:
      Place those annotations within the qual directory, and override AnnotatedTypeFactory.createSupportedTypeQualifiers() by calling AnnotatedTypeFactory.getBundledTypeQualifiersWithoutPolyAll(Class...) with a varargs parameter list of the other annotations. Code example:
      @Override protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers() { return getBundledTypeQualifiersWithoutPolyAll(UnknownFormat.class, FormatBottom.class); }
    5. Supporting only annotations that are explicitly listed: Override AnnotatedTypeFactory.createSupportedTypeQualifiers() and return a mutable set of the supported annotations. Code example:
      @Override protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers() { return new HashSet<Class<? extends Annotation>>( Arrays.asList(A.class, B.class)); }
      The set of qualifiers returned by AnnotatedTypeFactory.createSupportedTypeQualifiers() must be a fresh, mutable set. The methods AnnotatedTypeFactory.getBundledTypeQualifiersWithoutPolyAll(Class...) and AnnotatedTypeFactory.getBundledTypeQualifiersWithPolyAll(Class...) each must return a fresh, mutable set
    Overrides:
    
    createSupportedTypeQualifiers in class AnnotatedTypeFactory
    
    Returns:
    
    the type qualifiers supported this processor, or an empty set if none
  - createFlowTransferFunction
```
public CFTransfer createFlowTransferFunction(CFAbstractAnalysis<CFValue,CFStore,CFTransfer> analysis)
```
    Description copied from class: GenericAnnotatedTypeFactory
    
    Returns the appropriate transfer function that is used for the org.checkerframework.dataflow analysis.
    This implementation uses the checker naming convention to create the appropriate transfer function. If no transfer function is found, it returns an instance of CFTransfer.
    Subclasses have to override this method to create the appropriate transfer function if they do not follow the checker naming convention.
    
    Overrides:
    
    createFlowTransferFunction in class GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis>
  - createQualifierHierarchy
```
public QualifierHierarchy createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory)
```
    Description copied from class: AnnotatedTypeFactory
    
    Factory method to easily change what QualifierHierarchy is created. Needs to be public only because the GraphFactory must be able to call this method. No external use of this method is necessary.
    
    Overrides:
    
    createQualifierHierarchy in class AnnotatedTypeFactory
  - createTypeHierarchy
```
protected TypeHierarchy createTypeHierarchy()
```
    Description copied from class: AnnotatedTypeFactory
    
    Creates the type subtyping checker using the current type qualifier hierarchy.
    Subclasses may override this method to specify new type-checking rules beyond the typical java subtyping rules.
    
    Overrides:
    
    createTypeHierarchy in class AnnotatedTypeFactory
    
    Returns:
    
    the type relations class to check type subtyping
  - createTypeAnnotator
```
protected TypeAnnotator createTypeAnnotator()
```
    Description copied from class: GenericAnnotatedTypeFactory
    Returns a ImplicitsTypeAnnotator that adds annotations to a type based on the content of the type itself.
    Subclass may override this method. The default type annotator is a ListTypeAnnotator of the following:
    1. IrrelevantTypeAnnotator: Adds top to types not listed in the RelevantJavaTypes annotation on the checker.
    2. PropagationTypeAnnotator: Propagates annotation onto wildcards.
    3. ImplicitsTypeAnnotator: Adds annotations based on ImplicitFor meta-annotations.
    Overrides:
    
    createTypeAnnotator in class GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis>
    
    Returns:
    
    a type annotator
  - getFieldInvariants
```
public FieldInvariants getFieldInvariants(TypeElement element)
```
    Description copied from class: AnnotatedTypeFactory
    
    Returns the field invariants for the given class, as expressed by the user in @FieldInvariant method annotations.
    Subclasses may implement their own field invariant annotations if @FieldInvariant is not expressive enough. They must override this method to properly create AnnotationMirror and also override AnnotatedTypeFactory.getFieldInvariantDeclarationAnnotations() to return their field invariants.
    
    Overrides:
    
    getFieldInvariants in class AnnotatedTypeFactory
    
    Parameters:
    
    element - class for which to get invariants
    
    Returns:
    
    fields invariants for element
  - getFieldInvariantDeclarationAnnotations
```
protected Set<Class<? extends Annotation>> getFieldInvariantDeclarationAnnotations()
```
    Description copied from class: AnnotatedTypeFactory
    
    Returns the set of classes of field invariant annotations.
    
    Overrides:
    
    getFieldInvariantDeclarationAnnotations in class AnnotatedTypeFactory
  - methodFromUse
```
public AnnotatedTypeFactory.ParameterizedExecutableType methodFromUse(ExpressionTree tree,
                                                                      ExecutableElement methodElt,
                                                                      AnnotatedTypeMirror receiverType)
```
    Creates array length annotations for the result of the Enum.values() method, which is the number of possible values of the enum.
    
    Overrides:
    
    methodFromUse in class AnnotatedTypeFactory
    
    Parameters:
    
    tree - either a MethodInvocationTree or a MemberReferenceTree
    
    methodElt - the element of the referenced method
    
    receiverType - the type of the receiver
    
    Returns:
    
    the method type being invoked with tree and the (inferred) type arguments
    
    See Also:
    
    AnnotatedTypeFactory.methodFromUse(MethodInvocationTree)
  - getFromValueFromIntRange
```
public long getFromValueFromIntRange(AnnotatedTypeMirror atm)
```
    Finds the appropriate value for the from value of an annotated type mirror containing an IntRange annotation.
    
    Parameters:
    
    atm - an annotated type mirror that contains an IntRange annotation.
    
    Returns:
    
    either the from value from the passed int range annotation, or the minimum value of the domain of the underlying type (i.e. Integer.MIN_VALUE if the underlying type is int)
  - getToValueFromIntRange
```
public long getToValueFromIntRange(AnnotatedTypeMirror atm)
```
    Finds the appropriate value for the to value of an annotated type mirror containing an IntRange annotation.
    
    Parameters:
    
    atm - an annotated type mirror that contains an IntRange annotation.
    
    Returns:
    
    either the to value from the passed int range annotation, or the maximum value of the domain of the underlying type (i.e. Integer.MAX_VALUE if the underlying type is int)
  - createTreeAnnotator
```
protected TreeAnnotator createTreeAnnotator()
```
    Description copied from class: GenericAnnotatedTypeFactory
    Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.
    The default tree annotator is a ListTreeAnnotator of the following:
    1. PropagationTreeAnnotator: Propagates annotations from subtrees
    2. ImplicitsTreeAnnotator: Adds annotations based on ImplicitFor meta-annotations
    3. DependentTypesTreeAnnotator: Adapts dependent annotations based on context
    Subclasses may override this method to specify additional tree annotators, for example:
```
 new ListTreeAnnotator(super.createTreeAnnotator(), new KeyLookupTreeAnnotator(this));
 
```
    Overrides:
    
    createTreeAnnotator in class GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis>
    
    Returns:
    
    a tree annotator
  - createIntValAnnotation
```
public AnnotationMirror createIntValAnnotation(List<Long> values)
```
    Returns a IntVal or IntRange annotation using the values. If values is null, then UnknownVal is returned; if values is empty, then bottom is returned. If the number of values is greater than MAX_VALUES, return an IntRange. In other cases, the values are sorted and duplicates are removed before an IntVal is created.
    
    Parameters:
    
    values - list of longs; duplicates are allowed and the values may be in any order
    
    Returns:
    
    an annotation depends on the values
  - convertIntRangeToIntVal
```
public AnnotationMirror convertIntRangeToIntVal(AnnotationMirror intRangeAnno)
```
    Convert an @IntRange annotation to an @IntVal annotation, or to UNKNOWNVAL if the input is too wide to be represented as an @IntVal.
  - createDoubleValAnnotation
```
public AnnotationMirror createDoubleValAnnotation(List<Double> values)
```
    Returns a DoubleVal annotation using the values. If values is null, then UnknownVal is returned; if values is empty, then bottom is returned. The values are sorted and duplicates are removed before the annotation is created.
    
    Parameters:
    
    values - list of doubles; duplicates are allowed and the values may be in any order
    
    Returns:
    
    a DoubleVal annotation using the values
  - createStringAnnotation
```
public AnnotationMirror createStringAnnotation(List<String> values)
```
    Returns a StringVal annotation using the values. If values is null, then UnknownVal is returned; if values is empty, then bottom is returned. The values are sorted and duplicates are removed before the annotation is created. If values is larger than the max number of values allowed (10 by default), then an ArrayLen or an ArrayLenRange annotation is returned.
    
    Parameters:
    
    values - list of strings; duplicates are allowed and the values may be in any order
    
    Returns:
    
    a StringVal annotation using the values
  - createArrayLenAnnotation
```
public AnnotationMirror createArrayLenAnnotation(List<Integer> values)
```
    Returns a ArrayLen annotation using the values. If values is null, then UnknownVal is returned; if values is empty, then bottom is returned. The values are sorted and duplicates are removed before the annotation is created. If values is larger than the max number of values allowed (10 by default), then an ArrayLenRange annotation is returned.
    
    Parameters:
    
    values - list of integers; duplicates are allowed and the values may be in any order
    
    Returns:
    
    a ArrayLen annotation using the values
  - createBooleanAnnotation
```
public AnnotationMirror createBooleanAnnotation(List<Boolean> values)
```
    Returns a BoolVal annotation using the values. If values is null, then UnknownVal is returned; if values is empty, then bottom is returned. The values are sorted and duplicates are removed before the annotation is created.
    
    Parameters:
    
    values - list of booleans; duplicates are allowed and the values may be in any order
    
    Returns:
    
    a BoolVal annotation using the values
  - createCharAnnotation
```
public AnnotationMirror createCharAnnotation(List<Character> values)
```
    Returns a IntVal annotation using the values. If values is null, then UnknownVal is returned; if values is empty, then bottom is returned. The values are sorted and duplicates are removed before the annotation is created.
    
    Parameters:
    
    values - list of characters; duplicates are allowed and the values may be in any order
    
    Returns:
    
    a IntVal annotation using the values
  - createNumberAnnotationMirror
```
public AnnotationMirror createNumberAnnotationMirror(List<Number> values)
```
    Parameters:
    
    values - must be a homogeneous list: every element of it has the same class.
  - createIntRangeAnnotation
```
public AnnotationMirror createIntRangeAnnotation(Range range)
```
    Create an @IntRange or @IntVal annotation from the range. May return BOTTOMVAL or UNKNOWNVAL.
  - createArrayLenRangeAnnotation
```
public AnnotationMirror createArrayLenRangeAnnotation(int from,
                                                      int to)
```
    Create an @ArrayLenRange annotation from the two (inclusive) bounds. Does not return BOTTOMVAL or UNKNOWNVAL.
  - createArrayLenRangeAnnotation
```
public AnnotationMirror createArrayLenRangeAnnotation(Range range)
```
    Create an @ArrayLenRange annotation from the range. May return BOTTOMVAL or UNKNOWNVAL.
  - convertArrayLenToArrayLenRange
```
public AnnotationMirror convertArrayLenToArrayLenRange(AnnotationMirror arrayLenAnno)
```
    Converts an @ArrayLen annotation to an @ArrayLenRange annotation.
  - convertIntValToIntRange
```
public AnnotationMirror convertIntValToIntRange(AnnotationMirror intValAnno)
```
    Converts an @IntVal annotation to an @IntRange annotation.
  - getRange
```
public static Range getRange(AnnotationMirror rangeAnno)
```
    Returns a Range bounded by the values specified in the given @Range annotation. Also returns an appropriate range if an @IntVal annotation is passed. Returns null if the annotation is null or if the annotation is not an IntRange, IntRangeFromPositive, IntVal, or ArrayLenRange.
  - getIntValues
```
public static List<Long> getIntValues(AnnotationMirror intAnno)
```
    Returns the set of possible values as a sorted list with no duplicate values. Returns the empty list if no values are possible (for dead code). Returns null if any value is possible -- that is, if no estimate can be made -- and this includes when there is no constant-value annotation so the argument is null.
    The method returns a list of Long but is named getIntValues because it supports the @IntVal annotation.
    
    Parameters:
    
    intAnno - an @IntVal annotation, or null
  - getDoubleValues
```
public static List<Double> getDoubleValues(AnnotationMirror doubleAnno)
```
    Returns the set of possible values as a sorted list with no duplicate values. Returns the empty list if no values are possible (for dead code). Returns null if any value is possible -- that is, if no estimate can be made -- and this includes when there is no constant-value annotation so the argument is null.
    
    Parameters:
    
    doubleAnno - a @DoubleVal annotation, or null
  - getArrayLength
```
public static List<Integer> getArrayLength(AnnotationMirror arrayAnno)
```
    Returns the set of possible array lengths as a sorted list with no duplicate values. Returns the empty list if no values are possible (for dead code). Returns null if any value is possible -- that is, if no estimate can be made -- and this includes when there is no constant-value annotation so the argument is null.
    
    Parameters:
    
    arrayAnno - an @ArrayLen annotation, or null
  - getCharValues
```
public static List<Character> getCharValues(AnnotationMirror intAnno)
```
    Returns the set of possible values as a sorted list with no duplicate values. Returns the empty list if no values are possible (for dead code). Returns null if any value is possible -- that is, if no estimate can be made -- and this includes when there is no constant-value annotation so the argument is null.
    
    Parameters:
    
    intAnno - an @IntVal annotation, or null
  - getBooleanValues
```
public static List<Boolean> getBooleanValues(AnnotationMirror boolAnno)
```
    Returns the set of possible values as a sorted list with no duplicate values. Returns the empty list if no values are possible (for dead code). Returns null if any value is possible -- that is, if no estimate can be made -- and this includes when there is no constant-value annotation so the argument is null.
    
    Parameters:
    
    boolAnno - a @BoolVal annotation, or null
  - getStringValues
```
public static List<String> getStringValues(AnnotationMirror stringAnno)
```
    Returns the set of possible values as a sorted list with no duplicate values. Returns the empty list if no values are possible (for dead code). Returns null if any value is possible -- that is, if no estimate can be made -- and this includes when there is no constant-value annotation so the argument is null.
    
    Parameters:
    
    stringAnno - a @StringVal annotation, or null
  - isIntRange
```
public boolean isIntRange(Set<AnnotationMirror> anmSet)
```
  - isIntRange
```
public boolean isIntRange(AnnotationMirror anm)
```
  - getMinLenValue
```
public int getMinLenValue(AnnotatedTypeMirror atm)
```
  - getMaxLenValue
```
public Integer getMaxLenValue(AnnotationMirror annotation)
```
    Used to find the maximum length of an array. Returns null if there is no minimum length known, or if the passed annotation is null.
  - getMinLenValue
```
public int getMinLenValue(AnnotationMirror annotation)
```
    Used to find the minimum length of an array, which is useful for array bounds checking. Returns 0 if there is no minimum length known, or if the passed annotation is null.
    Note that this routine handles actual MinLen annotations, because it is called by canonicalAnnotation(AnnotationMirror), which transforms MinLen annotations into ArrayLenRange annotations.
  - getMinimumIntegralValue
```
public Long getMinimumIntegralValue(AnnotatedTypeMirror atm)
```
    Returns the smallest possible value that an integral annotation might take on. The passed AnnotatedTypeMirror should contain either an @IntRange annotation or an @IntVal annotation. Returns null if it does not.
  - getMinLenFromString
```
public int getMinLenFromString(String sequenceExpression,
                               Tree tree,
                               TreePath currentPath)
```
    Returns the minimum length of an array expression or 0 if the min length is unknown.
    
    Parameters:
    
    sequenceExpression - flow expression
    
    tree - expression tree or variable declaration
    
    currentPath - path to local scope
    
    Returns:
    
    min length of sequenceExpression or 0

Class ValueAnnotatedTypeFactory

Nested Class Summary

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

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

MAX_VALUES

COVERED_CLASS_STRINGS

UNKNOWNVAL

BOTTOMVAL

POLY

Constructor Detail

ValueAnnotatedTypeFactory

Method Detail

canonicalAnnotation

createSupportedTypeQualifiers

createFlowTransferFunction

createQualifierHierarchy

createTypeHierarchy

createTypeAnnotator

getFieldInvariants

getFieldInvariantDeclarationAnnotations

methodFromUse

getFromValueFromIntRange

getToValueFromIntRange

createTreeAnnotator

createIntValAnnotation

convertIntRangeToIntVal

createDoubleValAnnotation

createStringAnnotation

createArrayLenAnnotation

createBooleanAnnotation

createCharAnnotation

createNumberAnnotationMirror

createIntRangeAnnotation

createArrayLenRangeAnnotation

createArrayLenRangeAnnotation

convertArrayLenToArrayLenRange

convertIntValToIntRange

getRange

getIntValues

getDoubleValues

getArrayLength

getCharValues

getBooleanValues

getStringValues

isIntRange

isIntRange

getMinLenValue

getMaxLenValue

getMinLenValue

getMinimumIntegralValue

getMinLenFromString