@SupportedOptions(value={"reportEvalWarns","ignoreRangeOverflow","nonNullStringsConcatenation"}) public class ValueChecker extends BaseTypeChecker
The Constant Value Checker has no dependencies, but it does trust org.checkerframework.checker.index.qual.Positive
annotations from the Index Checker. This means
that if the Value Checker is run on code containing Positive
annotations, then the Index
Checker also needs to be run to guarantee soundness.
Modifier and Type | Field and Description |
---|---|
static String |
IGNORE_RANGE_OVERFLOW
Command-line option to ignore the possibility of overflow for range annotations.
|
static String |
NON_NULL_STRINGS_CONCATENATION
Command-line option that assumes most expressions in String concatenations can be null.
|
static String |
REPORT_EVAL_WARNS
Command-line option to warn the user if a @StaticallyExecutable method can't load and run at
compile time.
|
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
processingEnv
Constructor and Description |
---|
ValueChecker() |
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.
|
boolean |
shouldResolveReflection()
Returns whether or not reflection should be resolved.
|
void |
typeProcessingOver()
A method to be called once all the classes are processed and no error is reported.
|
getAnnotationProvider, getChecker, getContext, getOptions, getRelatedClassName, getSubchecker, getSupportedLintOptions, getSupportedOptions, getTreePathCacher, getTypeFactory, getTypeFactoryOfSubchecker, getVisitor, initChecker, invokeConstructorFor, printOrStoreMessage, processArg, setRoot, shouldAddShutdownHook, shutdownHook, typeProcess, warnUnneededSuppressions
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, printStats, report, reportError, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions
getCompilerLog, process
getCompletions, isInitialized
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getElementUtils, getOptionConfiguration, getProcessingEnvironment, getTreeUtils, getTypeUtils
public static final String REPORT_EVAL_WARNS
public static final String IGNORE_RANGE_OVERFLOW
public static final String NON_NULL_STRINGS_CONCATENATION
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
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.
getImmediateSubcheckerClasses
in class BaseTypeChecker
public boolean shouldResolveReflection()
BaseTypeChecker
shouldResolveReflection
in class BaseTypeChecker
public 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