Package org.checkerframework.checker.calledmethods

Class CalledMethodsChecker

  • All Implemented Interfaces:
    javax.annotation.processing.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 Detail

      • COUNT_FRAMEWORK_BUILD_CALLS

        public static final java.lang.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:
        Constant Field Values

      • DISABLE_BUILDER_FRAMEWORK_SUPPORTS

        public static final java.lang.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:
        Constant Field Values

      • USE_VALUE_CHECKER

        public static final java.lang.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:
        Constant Field Values

      • DISABLE_RETURNS_RECEIVER

        public static final java.lang.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:
        Constant Field Values

    • Constructor Detail

      • CalledMethodsChecker

        public CalledMethodsChecker()

    • Method Detail

      • getImmediateSubcheckerClasses

        protected java.util.Set<java.lang.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 AccumulationChecker
        Returns:
        the subchecker classes on which this checker depends; will be modified by callees in overriding methods

      • 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