Package org.checkerframework.framework.source

Class AggregateChecker

java.lang.Object
javax.annotation.processing.AbstractProcessor
org.checkerframework.javacutil.AbstractTypeProcessor
org.checkerframework.framework.source.SourceChecker
org.checkerframework.framework.source.AggregateChecker
All Implemented Interfaces:
Processor, OptionConfiguration
Direct Known Subclasses:
I18nChecker
public abstract class AggregateChecker extends SourceChecker
An abstract SourceChecker that runs independent subcheckers and interleaves their messages.

There is no communication, interaction, or cooperation between the component checkers, even to the extent of being able to read one another's qualifiers. An aggregate checker is merely shorthand to invoke a sequence of checkers.

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).)

This class delegates AbstractTypeProcessor responsibilities to each component checker.

Checker writers need to subclass this class and only override getSupportedCheckers() to indicate the classes of the checkers to be bundled.

  • Constructor Details

    • AggregateChecker

      protected AggregateChecker()
      Create a new AggregateChecker.

  • Method Details

    • getSupportedCheckers

      protected abstract Collection<Class<? extends SourceChecker>> getSupportedCheckers()
      Returns the list of independent subcheckers to be run together. An aggregate checker overrides this method to indicate its immediate subcheckers.
      Returns:
      the list of immediate subcheckers checkers to be run

    • getImmediateSubcheckerClasses

      protected final 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

    • createSourceVisitor

      protected SourceVisitor<?,?> createSourceVisitor()
      Description copied from class: SourceChecker
      Provides the SourceVisitor that the checker should use to scan input source trees.
      Specified by:
      createSourceVisitor in class SourceChecker
      Returns:
      a SourceVisitor to use to scan source trees