Package org.checkerframework.checker.nullness

Class NullnessNoInitSubchecker

java.lang.Object
javax.annotation.processing.AbstractProcessor
org.checkerframework.javacutil.AbstractTypeProcessor
org.checkerframework.framework.source.SourceChecker
org.checkerframework.common.basetype.BaseTypeChecker
org.checkerframework.checker.nullness.NullnessNoInitSubchecker
All Implemented Interfaces:
Processor, OptionConfiguration
public class NullnessNoInitSubchecker extends BaseTypeChecker
The subchecker of the NullnessChecker which actually checks NonNull and related qualifiers.

The NullnessChecker uses this checker as the target (see InitializationChecker.getTargetCheckerClass()) for its initialization type system.

  • Constructor Details

    • NullnessNoInitSubchecker

      public NullnessNoInitSubchecker()
      Default constructor for NonNullChecker.

  • Method Details

    • getTypeFactory

      public NullnessNoInitAnnotatedTypeFactory getTypeFactory()
      Description copied from class: BaseTypeChecker
      Return the type factory associated with this checker.
      Overrides:
      getTypeFactory in class BaseTypeChecker
      Returns:
      the type factory associated with this checker

    • getImmediateSubcheckerClasses

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

    • getSuppressWarningsPrefixes

      public NavigableSet<String> getSuppressWarningsPrefixes()
      Description copied from class: SourceChecker
      Returns a modifiable set of lower-case strings that are prefixes for SuppressWarnings strings.

      The collection must not be empty and must not contain only SourceChecker.SUPPRESS_ALL_PREFIX.

      Overrides:
      getSuppressWarningsPrefixes in class SourceChecker
      Returns:
      non-empty modifiable set of lower-case prefixes for SuppressWarnings strings

    • getWarningMessagePrefix

      protected String getWarningMessagePrefix()
      Description copied from class: SourceChecker
      Returns the prefix that should be added when issuing an error or warning if the -AshowPrefixInWarningMessages command-line option was passed.

      The default implementation uses the default prefix based on the class name if that default prefix is contained in SourceChecker.getSuppressWarningsPrefixes(). Otherwise, it uses the first element of SourceChecker.getSuppressWarningsPrefixes().

      Overrides:
      getWarningMessagePrefix in class SourceChecker
      Returns:
      the prefix that should be added when issuing an error or warning if the * -AshowPrefixInWarningMessages command-line option was passed

    • createSourceVisitor

      protected BaseTypeVisitor<?> createSourceVisitor()
      Description copied from class: BaseTypeChecker
      Returns the appropriate visitor that type-checks the compilation unit according to the type system rules.

      This implementation uses the checker naming convention to create the appropriate visitor. If no visitor is found, it returns an instance of BaseTypeVisitor. It reflectively invokes the constructor that accepts this checker and the compilation unit tree (in that order) as arguments.

      Subclasses have to override this method to create the appropriate visitor if they do not follow the checker naming convention.

      Overrides:
      createSourceVisitor in class BaseTypeChecker
      Returns:
      the type-checking visitor

    • shouldSkipDefs

      public boolean shouldSkipDefs(ClassTree tree)
      Description copied from class: SourceChecker
      Tests whether the class definition should not be checked because it matches the checker.skipDefs property.
      Overrides:
      shouldSkipDefs in class SourceChecker
      Parameters:
      tree - class to potentially skip
      Returns:
      true if checker should not test tree

    • shouldSkipDefs

      public boolean shouldSkipDefs(ClassTree cls, MethodTree meth)
      Description copied from class: SourceChecker
      Tests whether the method definition should not be checked because it matches the checker.skipDefs property.

      TODO: currently only uses the class definition. Refine pattern. Same for skipUses.

      Overrides:
      shouldSkipDefs in class SourceChecker
      Parameters:
      cls - class to potentially skip
      meth - method to potentially skip
      Returns:
      true if checker should not test meth