@SupportedOptions(value={"permitStaticOwning","permitInitializationLeak","countMustCall","noCreatesMustCallFor","noLightweightOwnership","noResourceAliases"}) public class ResourceLeakChecker extends CalledMethodsChecker
CalledMethodsChecker
that checks that the must-call obligations of each expression (as computed
via the MustCallChecker
have been fulfilled.AccumulationChecker.AliasAnalysis
Modifier and Type | Field and Description |
---|---|
static String |
COUNT_MUST_CALL
Command-line option for counting how many must-call obligations were checked by the Resource
Leak Checker, and emitting the number after processing all files.
|
COUNT_FRAMEWORK_BUILD_CALLS, DISABLE_BUILDER_FRAMEWORK_SUPPORTS, DISABLE_RETURNS_RECEIVER, USE_VALUE_CHECKER
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 |
---|
ResourceLeakChecker() |
Modifier and Type | Method and Description |
---|---|
protected BaseTypeVisitor<?> |
createSourceVisitor()
Returns the appropriate visitor that type-checks the compilation unit according to the type
system rules.
|
protected LinkedHashSet<Class<? extends BaseTypeChecker>> |
getImmediateSubcheckerClasses()
Returns the set of subchecker classes on which this checker depends.
|
void |
reportError(Object source,
@CompilerMessageKey String messageKey,
Object... args)
Reports an error.
|
void |
typeProcessingOver()
A method to be called once all the classes are processed.
|
isEnabled
createAliasAnalyses
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, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions
getCompilerLog, process
getCompletions, isInitialized
public static final String COUNT_MUST_CALL
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 CalledMethodsChecker
protected BaseTypeVisitor<?> createSourceVisitor()
BaseTypeChecker
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.
createSourceVisitor
in class BaseTypeChecker
public void reportError(Object source, @CompilerMessageKey String messageKey, Object... args)
SourceChecker
reportError
in class SourceChecker
source
- the source position information; may be an Element, a Tree, or nullmessageKey
- the message keyargs
- arguments for interpolation in the string corresponding to the given message keypublic 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 CalledMethodsChecker