Package org.checkerframework.checker.index.upperbound

Class UpperBoundChecker

  • All Implemented Interfaces:
    javax.annotation.processing.Processor, OptionConfiguration
    Direct Known Subclasses:
    IndexChecker
    @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})
@SuppressWarningsPrefix({"index","upperbound"})
public class UpperBoundChecker
extends BaseTypeChecker
    A type-checker for preventing arrays from being accessed with values that are too high.
    See the Checker Framework Manual:
    Index Checker

    • Field Detail

      • substringIndexForValueElement

        public @MonotonicNonNull javax.lang.model.element.ExecutableElement substringIndexForValueElement
        The SubstringIndexFor.value argument/element.

      • substringIndexForOffsetElement

        public @MonotonicNonNull javax.lang.model.element.ExecutableElement substringIndexForOffsetElement
        The SubstringIndexFor.offset argument/element.

      • ltLengthOfValueElement

        public @MonotonicNonNull javax.lang.model.element.ExecutableElement ltLengthOfValueElement
        The LTLengthOf.value argument/element.

      • ltLengthOfOffsetElement

        public @MonotonicNonNull javax.lang.model.element.ExecutableElement ltLengthOfOffsetElement
        The LTLengthOf.offset argument/element.

      • ltEqLengthOfValueElement

        public @MonotonicNonNull javax.lang.model.element.ExecutableElement ltEqLengthOfValueElement
        The LTEqLengthOf.value argument/element.

      • ltOMLengthOfValueElement

        public @MonotonicNonNull javax.lang.model.element.ExecutableElement ltOMLengthOfValueElement
        The LTOMLengthOf.value argument/element.

      • upperBoundLiteralValueElement

        public @MonotonicNonNull javax.lang.model.element.ExecutableElement upperBoundLiteralValueElement
        The UpperBoundLiteral.value element/field.

    • Constructor Detail

      • UpperBoundChecker

        public UpperBoundChecker()
        Create a new UpperBoundChecker.

    • Method Detail

      • initChecker

        public void initChecker()
        Description copied from class: SourceChecker
        Initialize the checker.
        Overrides:
        initChecker in class BaseTypeChecker
        See Also:
        AbstractProcessor.init(ProcessingEnvironment)

      • shouldSkipUses

        public boolean shouldSkipUses​(@FullyQualifiedName java.lang.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 java.util.Set<java.lang.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 set returned by this method, but clients that override the method do modify the set.

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