Package org.checkerframework.checker.calledmethods

Class CalledMethodsChecker

java.lang.Object
javax.annotation.processing.AbstractProcessor
org.checkerframework.javacutil.AbstractTypeProcessor
org.checkerframework.framework.source.SourceChecker
org.checkerframework.common.basetype.BaseTypeChecker
org.checkerframework.common.accumulation.AccumulationChecker
org.checkerframework.checker.calledmethods.CalledMethodsChecker
All Implemented Interfaces:
Processor, OptionConfiguration
Direct Known Subclasses:
ResourceLeakChecker
@SuppressWarningsPrefix({"calledmethods","builder","object.construction","objectconstruction"}) @SupportedOptions({"useValueChecker","countFrameworkBuildCalls","disableBuilderFrameworkSupports","disableReturnsReceiver"}) @StubFiles({"DescribeImages.astub","GenerateDataKey.astub"}) public class CalledMethodsChecker extends AccumulationChecker
The Called Methods Checker tracks the methods that have definitely been called on an object. One common use case for the Called Methods Checker is to specify safe combinations of options to builder or builder-like interfaces, preventing objects from being instantiated incompletely.

  • Field Details

    • COUNT_FRAMEWORK_BUILD_CALLS

      public static final String COUNT_FRAMEWORK_BUILD_CALLS
      If this option is supplied, count the number of analyzed calls to build() in supported builder frameworks and print it when analysis is complete. Useful for collecting metrics.
      See Also:

    • DISABLE_BUILDER_FRAMEWORK_SUPPORTS

      public static final String DISABLE_BUILDER_FRAMEWORK_SUPPORTS
      This option disables the support for (and therefore the automated checking of) code that uses the given builder frameworks. Useful when a user **only** wants to enforce specifications on custom builder objects (such as the AWS SDK examples).
      See Also:

    • USE_VALUE_CHECKER

      public static final String USE_VALUE_CHECKER
      If this option is supplied, use the Value Checker to reduce false positives when analyzing calls to the AWS SDK.
      See Also:

    • DISABLE_RETURNS_RECEIVER

      public static final String DISABLE_RETURNS_RECEIVER
      Some use cases for the Called Methods Checker do not involve checking fluent APIs, and in those cases disabling the Returns Receiver Checker using this flag will make the Called Methods Checker run much faster.
      See Also:

  • Constructor Details

    • CalledMethodsChecker

      public CalledMethodsChecker()

  • Method Details

    • isReturnsReceiverDisabled

      protected boolean isReturnsReceiverDisabled()
      Was the Returns Receiver Checker disabled on the command line?
      Returns:
      whether the -AdisableReturnsReceiver option was specified on the command line

    • 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 AccumulationChecker
      Returns:
      the subchecker classes on which this checker depends; will be modified by callees

    • isEnabled

      public boolean isEnabled(AccumulationChecker.AliasAnalysis aliasAnalysis)
      Check whether the given alias analysis is enabled by this particular accumulation checker.
      Overrides:
      isEnabled in class AccumulationChecker
      Parameters:
      aliasAnalysis - the analysis to check
      Returns:
      true iff the analysis is enabled

    • typeProcessingOver

      public void typeProcessingOver()
      Description copied from class: AbstractTypeProcessor
      A method to be called once all the classes are processed.

      Subclasses may override this method to do any aggregate analysis (e.g. generate report, persistence) or resource deallocation.

      Method AbstractTypeProcessor.getCompilerLog() can be used to access the number of compiler errors.

      Overrides:
      typeProcessingOver in class SourceChecker