Package org.checkerframework.checker.optional

Class OptionalChecker

java.lang.Object
javax.annotation.processing.AbstractProcessor
org.checkerframework.javacutil.AbstractTypeProcessor
org.checkerframework.framework.source.SourceChecker
org.checkerframework.common.basetype.BaseTypeChecker
org.checkerframework.checker.optional.OptionalChecker
All Implemented Interfaces:
Processor, OptionConfiguration
@RelevantJavaTypes(java.util.Optional.class) @StubFiles("javaparser.astub") @SupportedOptions("optionalMapAssumeNonNull") public class OptionalChecker extends BaseTypeChecker
A type-checker that prevents misuse of the Optional class.
See the Checker Framework Manual:
Optional Checker

  • Constructor Details

    • OptionalChecker

      public OptionalChecker()
      Create an OptionalChecker.

  • Method Details

    • 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