Package org.checkerframework.checker.index.lowerbound

Class LowerBoundChecker

java.lang.Object
javax.annotation.processing.AbstractProcessor
org.checkerframework.javacutil.AbstractTypeProcessor
org.checkerframework.framework.source.SourceChecker
org.checkerframework.common.basetype.BaseTypeChecker
org.checkerframework.checker.index.lowerbound.LowerBoundChecker
All Implemented Interfaces:
Processor, OptionConfiguration
@SuppressWarningsPrefix({"index","lowerbound"}) @RelevantJavaTypes({java.lang.Byte.class,java.lang.Short.class,java.lang.Integer.class,java.lang.Long.class,java.lang.Character.class,byte.class,short.class,int.class,long.class,char.class}) public class LowerBoundChecker extends BaseTypeChecker
A type-checker for preventing fixed-length sequences such as arrays or strings from being accessed with values that are too low. Normally bundled as part of the Index Checker.
See the Checker Framework Manual:
Index Checker

  • Constructor Details

    • LowerBoundChecker

      public LowerBoundChecker()
      A type-checker for preventing fixed-length sequences such as arrays or strings from being accessed with values that are too low. Normally bundled as part of the Index Checker.

  • Method Details

    • shouldSkipUses

      public boolean shouldSkipUses(@FullyQualifiedName String typeName)
      Description copied from class: SourceChecker
      Tests whether the class owner of the passed type matches the pattern specified in the checker.skipUses property. In contrast to SourceChecker.shouldSkipUses(Element) this version can also be used from primitive types, which don't have an element.

      Checkers that require their annotations not to be checked on certain JDK classes may override this method to skip them. They shall call super.shouldSkipUses(typeName) to also skip the classes matching the pattern.

      Overrides:
      shouldSkipUses in class SourceChecker
      Parameters:
      typeName - the fully-qualified name of a type
      Returns:
      true iff the enclosing class of element should be skipped

    • getImmediateSubcheckerClasses

      protected LinkedHashSet<Class<? extends BaseTypeChecker>> getImmediateSubcheckerClasses()
      Description copied from class: BaseTypeChecker
      Returns the set of subchecker classes on which this checker depends. Returns an empty set if this checker does not depend on any others.

      Subclasses should override this method to specify subcheckers. If they do so, they should call the super implementation of this method and add dependencies to the returned set so that checkers required for reflection resolution are included if reflection resolution is requested.

      Each subchecker of this checker may also depend on other checkers. If this checker and one of its subcheckers both depend on a third checker, that checker will only be instantiated once.

      Though each checker is run on a whole compilation unit before the next checker is run, error and warning messages are collected and sorted based on the location in the source file before being printed. (See BaseTypeChecker.printOrStoreMessage(Diagnostic.Kind, String, Tree, CompilationUnitTree).)

      WARNING: Circular dependencies are not supported nor do checkers verify that their dependencies are not circular. Make sure no circular dependencies are created when overriding this method. (In other words, if checker A depends on checker B, checker B cannot depend on checker A.)

      This method is protected so it can be overridden, but it should only be called internally by the BaseTypeChecker.

      The BaseTypeChecker will not modify the list returned by this method, but other clients do modify the list.

      Overrides:
      getImmediateSubcheckerClasses in class BaseTypeChecker
      Returns:
      the subchecker classes on which this checker depends; will be modified by callees