Deprecated API

Contents

• Deprecated Classes
• Deprecated Annotation Types
• Deprecated Methods
• Deprecated Constructors

Deprecated Classes

Class and Description
org.checkerframework.framework.util.GraphQualifierHierarchy See notes in MultiGraphQualifierHierarchy about how to convert existing subclasses to the new classes.
org.checkerframework.framework.util.MultiGraphQualifierHierarchy Use ElementQualifierHierarchy, MostlyNoElementQualifierHierarchy, or NoElementQualifierHierarchy instead. This class will be removed in a future release. Here are instructions on how to convert from a subclass of MultiGraphQualifierHierarchy to the new implementations: If the subclass implements isSubtype and calls super when annotations do not have elements, then use the following instructions to convert to MostlyNoElementQualifierHierarchy. Change extends MultiGraphQualifierHierarchy to extends MostlyNoElementQualifierHierarchy. Create a constructor matching super. Implement isSubtypeWithElements, leastUpperBoundWithElements, and greatestLowerBoundWithElements. You may be able to reuse parts of your current implementation of isSubtype, leastUpperBound, and greatestLowerBound. If the subclass implements isSubtype and does not call super in that implementation, then use the following instructions to convert to a subclass of ElementQualifierHierarchy. Change extends MultiGraphQualifierHierarchy to extends ElementQualifierHierarchy. Create a constructor matching super. Implement MultiGraphQualifierHierarchy.leastUpperBound(AnnotationMirror, AnnotationMirror) and MultiGraphQualifierHierarchy.greatestLowerBound(AnnotationMirror, AnnotationMirror) if missing. (In the past, it was very easy to forget to implement these, now they are abstract methods.) If you wish to continue to use a subclass of MultiGraphQualifierHierarchy or GraphQualifierHierarchy, you may do so by adding the following to AnnotatedTypeFactory. (It's better to convert to one of the new classes because MultiGraphQualifierHierarchy and GraphQualifierHierarchy are buggy and no longer supported.) If any qualifier has an annotation element without a default value, you will need to convert to one of the new subclasses. If you do not, then MultiGraphQualifierHierarchy will throw an exception with a message like "AnnotationBuilder.fromName: no value for element value() of checkers.inference.qual.VarAnnot". @Override @SuppressWarnings("deprecation") public QualifierHierarchy createQualifierHierarchy() { return org.checkerframework.framework.util.MultiGraphQualifierHierarchy .createMultiGraphQualifierHierarchy(this); } @Override @SuppressWarnings("deprecation") public QualifierHierarchy createQualifierHierarchyWithMultiGraphFactory( org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory) { return new YourSubclassQualifierHierarchy(factory); }
org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory Use ElementQualifierHierarchy instead.

Deprecated Annotation Types

Annotation Type and Description
org.checkerframework.framework.source.SuppressWarningsKeys Use SuppressWarningsPrefix instead.

Deprecated Methods

Method and Description
org.checkerframework.framework.type.AnnotatedTypeFactory.addAliasedAnnotation(Class<?>, AnnotationMirror) use addAliasedTypeAnnotation
org.checkerframework.framework.type.AnnotatedTypeFactory.addAliasedAnnotation(Class<?>, Class<?>, boolean, String...) use addAliasedTypeAnnotation
org.checkerframework.framework.type.AnnotatedTypeFactory.addAliasedAnnotation(String, AnnotationMirror) use AnnotatedTypeFactory.addAliasedTypeAnnotation(java.lang.Class<?>, javax.lang.model.element.AnnotationMirror)
org.checkerframework.javacutil.AnnotationUtils.areSameByClass(AnnotationMirror, Class<? extends Annotation>) use AnnotatedTypeFactory#areSameByClass or AnnotationUtils.areSameByName(javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationMirror)
org.checkerframework.javacutil.ElementUtils.classElementKinds() use ElementUtils.typeElementKinds()
org.checkerframework.javacutil.SystemUtil.concatenate(T[], T...) use StringsPlume.concatenate
org.checkerframework.javacutil.SystemUtil.concatenate(T, T[], T) use PlumeUtil.concat
org.checkerframework.checker.formatter.util.FormatUtil.conversionCharFromFormat(String) This method is public only for testing. Use private method #conversionCharFromFormat(Matcher).
org.checkerframework.framework.util.MultiGraphQualifierHierarchy.createMultiGraphQualifierHierarchy(AnnotatedTypeFactory) Use ElementQualifierHierarchy instead.
org.checkerframework.framework.type.AnnotatedTypeFactory.createQualifierHierarchyWithMultiGraphFactory(MultiGraphQualifierHierarchy.MultiGraphFactory) Use either ElementQualifierHierarchy, NoElementQualifierHierarchy, or MostlyNoElementQualifierHierarchy instead. This method will be removed in a future release.
org.checkerframework.javacutil.ElementUtils.enclosingClass(Element) use ElementUtils.enclosingTypeElement(javax.lang.model.element.Element)
org.checkerframework.framework.util.AnnotatedTypes.getAnnotatedTypes(AnnotatedTypeFactory, List<AnnotatedTypeMirror>, List<? extends ExpressionTree>) use CollectionsPlume.mapList(atypeFactory::getAnnotatedType, trees) instead.
org.checkerframework.javacutil.SystemUtil.getBooleanSystemProperty(String) use UtilPlume.getBooleanSystemProperty
org.checkerframework.javacutil.SystemUtil.getBooleanSystemProperty(String, boolean) use UtilPlume.getBooleanSystemProperty
org.checkerframework.dataflow.cfg.block.RegularBlock.getContents() use Block.getNodes() instead
org.checkerframework.framework.type.AnnotatedTypeFactory.getCurrentClassTree(Tree) Use TreePathUtil.enclosingClass(getPath(tree)) instead.
org.checkerframework.framework.type.AnnotatedTypeFactory.getCurrentMethodReceiver(Tree) Use AnnotatedTypeFactory.getSelfType(Tree) instead.
org.checkerframework.framework.stub.AnnotationFileElementTypes.getDeclAnnotation(Element) use AnnotationFileElementTypes.getDeclAnnotations(javax.lang.model.element.Element)
org.checkerframework.javacutil.AnnotationUtils.getElementValue(AnnotationMirror, CharSequence, Class<T>, boolean) use AnnotationUtils.getElementValue(AnnotationMirror, ExecutableElement, Class) or AnnotationUtils.getElementValue(AnnotationMirror, ExecutableElement, Class, Object)
org.checkerframework.javacutil.AnnotationUtils.getElementValueArray(AnnotationMirror, CharSequence, Class<T>, boolean) use #getElementValueArray(AnnotationMirror, ExecutableElement, Class) or #getElementValueArray(AnnotationMirror, ExecutableElement, Class, Object)
org.checkerframework.javacutil.AnnotationUtils.getElementValueClassName(AnnotationMirror, CharSequence, boolean) use an ExecutableElement
org.checkerframework.javacutil.AnnotationUtils.getElementValueClassNames(AnnotationMirror, CharSequence, boolean) use AnnotationUtils.getElementValueClassNames(AnnotationMirror,ExecutableElement)
org.checkerframework.javacutil.AnnotationUtils.getElementValueEnum(AnnotationMirror, CharSequence, Class<T>, boolean) use AnnotationUtils.getElementValueEnum(AnnotationMirror, ExecutableElement, Class) or AnnotationUtils.getElementValueEnum(AnnotationMirror, ExecutableElement, Class, Enum)
org.checkerframework.javacutil.AnnotationUtils.getElementValueEnumArray(AnnotationMirror, CharSequence, Class<T>, boolean) use AnnotationUtils.getElementValueEnumArray(AnnotationMirror, ExecutableElement, Class) or AnnotationUtils.getElementValueEnumArray(AnnotationMirror, ExecutableElement, Class, Enum[])
org.checkerframework.javacutil.AnnotationUtils.getElementValuesWithDefaults(AnnotationMirror) use a method that takes an ExecutableElement
org.checkerframework.framework.flow.CFAbstractTransfer.getValueWithSameAnnotations(TypeMirror, V) use CFAbstractTransfer.getWidenedValue(javax.lang.model.type.TypeMirror, V) or CFAbstractTransfer.getNarrowedValue(javax.lang.model.type.TypeMirror, V)
org.checkerframework.framework.type.QualifierHierarchy.greatestLowerBound(AnnotatedTypeMirror, AnnotatedTypeMirror, AnnotationMirror, AnnotationMirror) Without the bounds of the type variable, it is not possible to correctly compute the relationship between "no qualifier" and a qualifier
org.checkerframework.framework.type.QualifierHierarchy.greatestLowerBounds(AnnotatedTypeMirror, AnnotatedTypeMirror, Collection<? extends AnnotationMirror>, Collection<AnnotationMirror>) Without the bounds of the type variable, it is not possible to correctly compute the relationship between "no qualifier" and a qualifier
org.checkerframework.framework.type.QualifierHierarchy.greatestLowerBoundsTypeVariable(Collection<? extends AnnotationMirror>, Collection<? extends AnnotationMirror>) Without the bounds of the type variable, it is not possible to correctly compute the relationship between "no qualifier" and a qualifier
org.checkerframework.framework.type.QualifierHierarchy.greatestLowerBoundTypeVariable(AnnotationMirror, AnnotationMirror) Without the bounds of the type variable, it is not possible to correctly compute the relationship between "no qualifier" and a qualifier
org.checkerframework.javacutil.AnnotationUtils.hasElementValue(AnnotationMirror, CharSequence) use a method that takes an ExecutableElement
org.checkerframework.javacutil.TypesUtils.isCaptured(TypeMirror) use TypesUtils.isCapturedTypeVariable(TypeMirror) instead
org.checkerframework.javacutil.ElementUtils.isClassElement(Element) use ElementUtils.isTypeElement(javax.lang.model.element.Element)
org.checkerframework.framework.type.QualifierHierarchy.isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror, AnnotationMirror, AnnotationMirror) Without the bounds of the type variable, it is not possible to correctly compute the subtype relationship between "no qualifier" and a qualifier. Use TypeHierarchy.isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror).
org.checkerframework.framework.type.QualifierHierarchy.isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror, Collection<? extends AnnotationMirror>, Collection<AnnotationMirror>) Without the bounds of the type variable, it is not possible to correctly compute the subtype relationship between "no qualifier" and a qualifier. Use TypeHierarchy.isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror).
org.checkerframework.framework.type.QualifierHierarchy.isSubtypeTypeVariable(AnnotationMirror, AnnotationMirror) Without the bounds of the type variable, it is not possible to correctly compute the subtype relationship between "no qualifier" and a qualifier. Use TypeHierarchy.isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror).
org.checkerframework.framework.type.QualifierHierarchy.isSubtypeTypeVariable(Collection<? extends AnnotationMirror>, Collection<? extends AnnotationMirror>) Without the bounds of the type variable, it is not possible to correctly compute the subtype relationship between "no qualifier" and a qualifier. Use TypeHierarchy.isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror).
org.checkerframework.framework.type.QualifierHierarchy.leastUpperBound(AnnotatedTypeMirror, AnnotatedTypeMirror, AnnotationMirror, AnnotationMirror) Without the bounds of the type variable, it is not possible to correctly compute the relationship between "no qualifier" and a qualifier. Use AnnotatedTypes.leastUpperBound(AnnotatedTypeFactory, AnnotatedTypeMirror, AnnotatedTypeMirror).
org.checkerframework.framework.type.QualifierHierarchy.leastUpperBounds(AnnotatedTypeMirror, AnnotatedTypeMirror, Collection<? extends AnnotationMirror>, Collection<AnnotationMirror>) Without the bounds of the type variable, it is not possible to correctly compute the relationship between "no qualifier" and a qualifier. Use AnnotatedTypes.leastUpperBound(AnnotatedTypeFactory, AnnotatedTypeMirror, AnnotatedTypeMirror).
org.checkerframework.framework.type.QualifierHierarchy.leastUpperBoundsTypeVariable(Collection<? extends AnnotationMirror>, Collection<? extends AnnotationMirror>) Without the bounds of the type variable, it is not possible to correctly compute the relationship between "no qualifier" and a qualifier. Use AnnotatedTypes.leastUpperBound(AnnotatedTypeFactory, AnnotatedTypeMirror, AnnotatedTypeMirror).
org.checkerframework.framework.type.QualifierHierarchy.leastUpperBoundTypeVariable(AnnotationMirror, AnnotationMirror) Without the bounds of the type variable, it is not possible to correctly compute the relationship between "no qualifier" and a qualifier. Use AnnotatedTypes.leastUpperBound(AnnotatedTypeFactory, AnnotatedTypeMirror, AnnotatedTypeMirror).
org.checkerframework.javacutil.SystemUtil.mapCapacity(Collection<?>) use CollectionsPlume.mapCapacity
org.checkerframework.javacutil.SystemUtil.mapCapacity(int) use CollectionsPlume.mapCapacity
org.checkerframework.javacutil.SystemUtil.mapCapacity(Map<?, ?>) use CollectionsPlume.mapCapacity
org.checkerframework.javacutil.SystemUtil.readFile(File) use Files.readAllLines
org.checkerframework.framework.type.AnnotatedTypeReplacer.replace(AnnotatedTypeMirror, AnnotatedTypeMirror) use AnnotatedTypeFactory.replaceAnnotations(AnnotatedTypeMirror, AnnotatedTypeMirror) instead.
org.checkerframework.framework.type.AnnotatedTypeReplacer.replace(AnnotatedTypeMirror, AnnotatedTypeMirror, AnnotationMirror) use AnnotatedTypeFactory.replaceAnnotations(AnnotatedTypeMirror, AnnotatedTypeMirror, AnnotationMirror) instead.
org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType.setWasRaw() Use AnnotatedTypeMirror.AnnotatedDeclaredType.setIsUnderlyingTypeRaw() instead
org.checkerframework.javacutil.SystemUtil.sleep(long) use SystemPlume.sleep
org.checkerframework.framework.type.typeannotator.DefaultQualifierForUseTypeAnnotator.supportedAnnosFromAnnotationMirror(AnnotationMirror) use DefaultQualifierForUseTypeAnnotator.supportedAnnosFromAnnotationMirror(List)
org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType.wasRaw() Use AnnotatedTypeMirror.AnnotatedDeclaredType.isUnderlyingTypeRaw() instead

Deprecated Constructors

Constructor and Description
org.checkerframework.dataflow.cfg.node.ReturnNode(ReturnTree, Node, Types, LambdaExpressionTree, Symbol.MethodSymbol) Use #ReturnNode(ReturnTree, Node, Types, LambdaExpressionTree, MethodSymbol) instead.
org.checkerframework.dataflow.cfg.node.ReturnNode(ReturnTree, Node, Types, MethodTree) Use #ReturnNode(ReturnTree, Node, Types, LambdaExpressionTree, MethodSymbol) instead.