Package org.checkerframework.checker.index.growonly

Class GrowOnlyAnnotatedTypeFactory

java.lang.Object
org.checkerframework.framework.type.AnnotatedTypeFactory
org.checkerframework.framework.type.GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis>
org.checkerframework.common.basetype.BaseAnnotatedTypeFactory
org.checkerframework.checker.index.growonly.GrowOnlyAnnotatedTypeFactory
All Implemented Interfaces:
AnnotationProvider
public class GrowOnlyAnnotatedTypeFactory extends BaseAnnotatedTypeFactory
The type factory for the Grow-only Checker.

  • Constructor Details

    • GrowOnlyAnnotatedTypeFactory

      public GrowOnlyAnnotatedTypeFactory(BaseTypeChecker checker)
      Creates a new GrowOnlyAnnotatedTypeFactory.
      Parameters:
      checker - the type-checker associated with this factory

  • Method Details

    • 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 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 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 3 ways to indicate annotations that are supported by a checker:

      1. Only support annotations located in a checker's qual directory:

        This is the default behavior. Simply place those annotations within the qual directory.

      2. Support annotations located in a checker's qual directory and a list of other annotations:

        Place those annotations within the qual directory, and override AnnotatedTypeFactory.createSupportedTypeQualifiers() by calling AnnotatedTypeFactory.getBundledTypeQualifiers(Class...) with a varargs parameter list of the other annotations. Code example: 

         @Override
 protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers() {
   return getBundledTypeQualifiers(
     // These annotations are in the Called Methods Checker, not the Resource Leak Checker.
     CalledMethods.class, CalledMethodsBottom.class, CalledMethodsPredicate.class);
 }
      3. Support only annotations that are explicitly listed. This is common when a single directory holds qualifiers for multiple qualifier hierarchies. 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.getBundledTypeQualifiers(Class...) must return a fresh, mutable set.
      Overrides:
      createSupportedTypeQualifiers in class AnnotatedTypeFactory
      Returns:
      the type qualifiers supported this processor, or an empty set if none