public abstract class AccumulationChecker extends BaseTypeChecker
This class provides a basic accumulation analysis that can be extended to implement an accumulation type system. This accumulation analysis represents all facts as Strings.
This class supports modular alias analyses. To choose the alias analyses that your
accumulation checker uses, override the createAliasAnalyses() method. By default, the
only alias analysis used is Returns Receiver.
The primary extension point is the constructor of AccumulationAnnotatedTypeFactory,
which every subclass should override to provide custom annotations.
| Modifier and Type | Class and Description |
|---|---|
static class |
AccumulationChecker.AliasAnalysis
The alias analyses that an accumulation checker can support.
|
currentRoot, DETAILS_SEPARATOR, elementsWithSuppressedWarnings, errsOnLastExit, javacErrored, messager, messagesProperties, MSGS_FILE, OPTION_SEPARATOR, parentChecker, SUPPRESS_ALL_MESSAGE_KEY, SUPPRESS_ALL_PREFIX, trees, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitorprocessingEnv| Modifier | Constructor and Description |
|---|---|
protected |
AccumulationChecker()
Constructs a new AccumulationChecker.
|
| Modifier and Type | Method and Description |
|---|---|
protected EnumSet<AccumulationChecker.AliasAnalysis> |
createAliasAnalyses()
Get the alias analyses that this checker should employ.
|
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.
|
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, typeProcessingOver, warnUnneededSuppressionsaddOptions, 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, warnUnneededSuppressionsgetCompilerLog, processgetCompletions, isInitializedprotected AccumulationChecker()
protected LinkedHashSet<Class<? extends BaseTypeChecker>> getImmediateSubcheckerClasses()
BaseTypeCheckerSubclasses 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 BaseTypeCheckerprotected EnumSet<AccumulationChecker.AliasAnalysis> createAliasAnalyses(@UnderInitialization AccumulationChecker this)
public boolean isEnabled(AccumulationChecker.AliasAnalysis aliasAnalysis)
aliasAnalysis - the analysis to check