Package org.checkerframework.checker.modifiability

Class ModifiabilityBaseChecker

java.lang.Object
javax.annotation.processing.AbstractProcessor
org.checkerframework.javacutil.AbstractTypeProcessor
org.checkerframework.framework.source.SourceChecker
org.checkerframework.common.basetype.BaseTypeChecker
org.checkerframework.checker.modifiability.ModifiabilityBaseChecker
All Implemented Interfaces:
Processor, OptionConfiguration
Direct Known Subclasses:
GrowChecker, IteratorChecker, ReplaceChecker, SeqGrowChecker, ShrinkChecker
public abstract class ModifiabilityBaseChecker extends BaseTypeChecker
Base class for the Modifiability sub-checkers.

The sub-checkers' shared type-checking logic is in ModifiabilityBaseAnnotatedTypeFactory and ModifiabilityBaseVisitor. In addition, this class lets the sub-checkers share:

  • The messages.properties file in org.checkerframework.checker.modifiability, which SourceChecker.getMessagesProperties() finds via this class. The Grow, SeqGrow, Shrink, and Replace checkers all report diagnostics whose message keys are defined there; without this common superclass, those keys would need to be duplicated in each sub-checker's package.
  • The stub files in org.checkerframework.checker.modifiability; see getExtraStubFiles().
  • The Iterator Checker as a subchecker; see usesIteratorChecker().

  • Constructor Details

    • ModifiabilityBaseChecker

      protected ModifiabilityBaseChecker()
      Creates a new ModifiabilityBaseChecker.

  • Method Details

    • getExtraStubFiles

      public List<String> getExtraStubFiles()
      Returns a list of stub files to be treated as if they had been written in a @StubFiles annotation.

      This implementation adds the stub files that the sub-checkers share. They are written in terms of the capability qualifiers such as @Modifiable; the Iterator Checker parses them too, but ignores every qualifier that is not in its own hierarchy.

      Overrides:
      getExtraStubFiles in class SourceChecker
      Returns:
      stub files to be treated as if they had been written in a @StubFiles annotation

    • usesIteratorChecker

      protected boolean usesIteratorChecker()
      Returns true if this checker refines the result of iterator() and listIterator(), and therefore needs to read the Iterator Checker's qualifiers. The Iterator Checker itself does not (it would be its own subchecker), and neither does the SeqGrow Checker, because an iterator has no sequenced-grow methods.
      Returns:
      true if this checker needs the Iterator Checker as a subchecker

    • getImmediateSubcheckerClasses

      protected Set<Class<? extends SourceChecker>> getImmediateSubcheckerClasses()
      Description copied from class: SourceChecker
      Returns the set of subchecker classes on which this checker depends. ("Depends" means the checkers that are subcheckers of the current checker rather than a subchecker of some other checker.) Returns an empty set if this checker does not depend on any others.

      If this checker should run multiple independent checkers and not contain a type system, then subclass AggregateChecker.

      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.

      If a checker should be added or not based on a command line option, use SourceChecker.getOptionsNoSubcheckers() or SourceChecker.hasOptionNoSubcheckers(String) to avoid recursively calling this method.

      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 SourceChecker.printOrStoreMessage(Diagnostic.Kind, String, Tree, CompilationUnitTree).)

      WARNING: Circular dependencies are not supported. (In other words, if checker A depends on checker B, checker B cannot depend on checker A.) The Checker Framework does not check for circularity. Make sure no circular dependencies are created when overriding this method.

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

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