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.checker.calledmethods.CalledMethodsChecker

All Implemented Interfaces:

Processor, BaseTypeContext, BaseContext, CFContext, OptionConfiguration

@SuppressWarningsPrefix(value={"calledmethods","builder","object.construction","objectconstruction"})
 @SupportedOptions(value={"useValueChecker","countFrameworkBuildCalls","disableBuilderFrameworkSupports"})
 @StubFiles(value={"DescribeImages.astub","GenerateDataKey.astub"})
public class CalledMethodsChecker
extends BaseTypeChecker

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 Summary

Fields

Modifier and Type	Field and Description
static 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.
static String	DISABLE_BUILDER_FRAMEWORK_SUPPORTS This option disables the support for (and therefore the automated checking of) code that uses the given builder frameworks.
static String	USE_VALUE_CHECKER If this option is supplied, use the Value Checker to reduce false positives when analyzing calls to the AWS SDK.

Fields inherited from class org.checkerframework.framework.source.SourceChecker

currentRoot, DETAILS_SEPARATOR, elementsWithSuppressedWarnings, errsOnLastExit, messager, messagesProperties, MSGS_FILE, OPTION_SEPARATOR, parentChecker, SUPPRESS_ALL_MESSAGE_KEY, SUPPRESS_ALL_PREFIX, trees, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
CalledMethodsChecker()

Method Summary

Modifier and Type	Method and Description
protected LinkedHashSet<Class<? extends BaseTypeChecker>>	getImmediateSubcheckerClasses() Returns the set of subchecker classes on which this checker depends.
void	typeProcessingOver() A method to be called once all the classes are processed and no error is reported.

Methods inherited from class org.checkerframework.common.basetype.BaseTypeChecker

createSourceVisitor, getAnnotationProvider, getChecker, getContext, getOptions, getRelatedClassName, getSubchecker, getSubcheckers, getSupportedLintOptions, getSupportedOptions, getTreePathCacher, getTypeFactory, getTypeFactoryOfSubchecker, getVisitor, initChecker, invokeConstructorFor, printOrStoreMessage, processArg, setRoot, shouldAddShutdownHook, shouldResolveReflection, shutdownHook, typeProcess, warnUnneededSuppressions

Methods inherited from class org.checkerframework.framework.source.SourceChecker

addOptions, createSupportedLintOptions, expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getLintOption, getLintOption, getMessagesProperties, getOption, getOption, getOptionConfiguration, getParentChecker, getProcessingEnvironment, getProperties, getStandardSuppressWarningsPrefixes, getSupportedAnnotationTypes, getSupportedSourceVersion, getSuppressWarningsPrefixes, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, init, message, printOrStoreMessage, printStats, report, reportError, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor

getCompilerLog, process

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.checkerframework.framework.util.BaseContext

getElementUtils, getOptionConfiguration, getProcessingEnvironment, getTreeUtils, getTypeUtils

Field Detail

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:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

Constructor Detail

CalledMethodsChecker

public CalledMethodsChecker()

Method Detail

getImmediateSubcheckerClasses

protected LinkedHashSet<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 list returned by this method.

Overrides:

getImmediateSubcheckerClasses in class BaseTypeChecker

typeProcessingOver

public void typeProcessingOver()

Description copied from class: AbstractTypeProcessor

A method to be called once all the classes are processed and no error is reported.

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 BaseTypeChecker