@SuppressWarningsPrefix(value={"calledmethods","builder","object.construction","objectconstruction"}) @SupportedOptions(value={"useValueChecker","countFrameworkBuildCalls","disableBuilderFrameworkSupports","disableReturnsReceiver"}) @StubFiles(value={"DescribeImages.astub","GenerateDataKey.astub"}) public class CalledMethodsChecker extends AccumulationChecker
AccumulationChecker.AliasAnalysis
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 |
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.
|
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.
|
currentRoot, DETAILS_SEPARATOR, elements, elementsWithSuppressedWarnings, errsOnLastExit, javacErrored, messager, messagesProperties, MSGS_FILE, OPTION_SEPARATOR, parentChecker, SUPPRESS_ALL_MESSAGE_KEY, SUPPRESS_ALL_PREFIX, trees, types, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitor
processingEnv
Constructor and Description |
---|
CalledMethodsChecker() |
Modifier and Type | Method and Description |
---|---|
protected LinkedHashSet<Class<? extends BaseTypeChecker>> |
getImmediateSubcheckerClasses()
Returns the set of subchecker classes on which this checker depends.
|
boolean |
isEnabled(AccumulationChecker.AliasAnalysis aliasAnalysis)
Check whether the given alias analysis is enabled by this particular accumulation checker.
|
void |
typeProcessingOver()
A method to be called once all the classes are processed.
|
createAliasAnalyses
createSourceVisitor, createSourceVisitorPublic, getAnnotationProvider, getExtraStubFiles, getOptions, getOptionsNoSubcheckers, getRelatedClassName, getSubchecker, getSubcheckers, getSupportedLintOptions, getSupportedOptions, getSuppressWarningsPrefixesOfSubcheckers, getTreePathCacher, getTypeFactory, getTypeFactoryOfSubchecker, getUltimateParentChecker, getVisitor, hasOptionNoSubcheckers, initChecker, invokeConstructorFor, printOrStoreMessage, processArg, reportJavacError, setRoot, shouldAddShutdownHook, shouldResolveReflection, shutdownHook, typeProcess, warnUnneededSuppressions
addOptions, createSupportedLintOptions, expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getLintOption, getLintOption, getMessagesProperties, getOption, getOption, getOptionConfiguration, getParentChecker, getPathToCompilationUnit, getProcessingEnvironment, getProperties, getStandardSuppressWarningsPrefixes, getSupportedAnnotationTypes, getSupportedSourceVersion, getSuppressWarningsPrefixes, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, init, message, message, printOrStoreMessage, printStats, report, reportError, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions
getCompilerLog, process
getCompletions, isInitialized
public static final String COUNT_FRAMEWORK_BUILD_CALLS
public static final String DISABLE_BUILDER_FRAMEWORK_SUPPORTS
public static final String USE_VALUE_CHECKER
public static final String DISABLE_RETURNS_RECEIVER
protected LinkedHashSet<Class<? extends BaseTypeChecker>> getImmediateSubcheckerClasses()
BaseTypeChecker
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, but other clients do modify the list.
getImmediateSubcheckerClasses
in class AccumulationChecker
public boolean isEnabled(AccumulationChecker.AliasAnalysis aliasAnalysis)
isEnabled
in class AccumulationChecker
aliasAnalysis
- the analysis to checkpublic void typeProcessingOver()
AbstractTypeProcessor
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.
typeProcessingOver
in class BaseTypeChecker