SourceChecker (checker-framework 3.29.0 API)

java.lang.Object
- javax.annotation.processing.AbstractProcessor
- - org.checkerframework.javacutil.AbstractTypeProcessor
  - - org.checkerframework.framework.source.SourceChecker

All Implemented Interfaces:: Processor, OptionConfiguration

Direct Known Subclasses:: AggregateChecker, AnnotationStatistics, BaseTypeChecker, JavaCodeStatistics

@SupportedOptions(value={"suppressWarnings","skipUses","onlyUses","skipDefs","onlyDefs","assumeSideEffectFree","assumeDeterministic","assumePure","assumeAssertionsAreEnabled","assumeAssertionsAreDisabled","warns","checkPurityAnnotations","invariantArrays","checkCastElementType","useConservativeDefaultsForUncheckedCode","useDefaultsForUncheckedCode","concurrentSemantics","conservativeUninferredTypeArguments","ignoreRawTypeArguments","lint","suggestPureMethods","resolveReflection","infer","inferOutputOriginal","showSuppressWarningsStrings","warnUnneededSuppressions","warnUnneededSuppressionsExceptions","requirePrefixInWarningSuppressions","ignoreInvalidAnnotationLocations","stubs","ajava","stubWarnIfNotFound","stubNoWarnIfNotFound","stubWarnIfNotFoundIgnoresClasses","stubWarnIfOverwritesBytecode","stubWarnIfRedundantWithBytecode","stubWarnNote","mergeStubsWithSource","version","printGitProperties","printAllQualifiers","printVerboseGenerics","noPrintErrorStack","noWarnMemoryConstraints","nomsgtext","detailedmsgtext","ignorejdkastub","permitMissingJdk","nocheckjdk","parseAllJdk","stubDebug","filenames","showchecks","showInferenceSteps","dumpOnErrors","cfgviz","flowdotdir","verbosecfg","atfCacheSize","atfDoNotCache","resourceStats","parseAllJdk","ajavaChecks"})
public abstract class SourceChecker
extends AbstractTypeProcessor
implements OptionConfiguration

An abstract annotation processor designed for implementing a source-file checker as an annotation processor (a compiler plug-in). It provides an interface to javac's annotation processing API, routines for error reporting via the JSR 199 compiler API, and an implementation for using a SourceVisitor to perform the type-checking.

Most type-checker plug-ins should extend BaseTypeChecker, instead of this class. Only checkers that require annotated types but not subtype checking (e.g. for testing purposes) should extend this. Non-type checkers (e.g. for enforcing coding styles) may extend AbstractProcessor (or even this class).

Field Summary

Fields
Modifier and Type	Field and Description
`protected @InternedDistinct CompilationUnitTree`	`currentRoot` The source tree that is being scanned.
`static String`	`DETAILS_SEPARATOR` Separates parts of a "detailed message", to permit easier parsing.
`protected Elements`	`elements` Element utilities.
`protected Set<Element>`	`elementsWithSuppressedWarnings` Elements with a `@SuppressWarnings` that actually suppressed a warning for this checker.
`protected int`	`errsOnLastExit` The number of errors at the last exit of the type processor.
`protected boolean`	`javacErrored` If true, javac failed to compile the code or a previously-run annotation processor issued an error.
`protected @MonotonicNonNull Messager`	`messager` Used to report error messages and warnings via the compiler.
`protected @MonotonicNonNull Properties`	`messagesProperties` Maps error keys to localized/custom error messages.
`protected static String`	`MSGS_FILE` File name of the localized messages.
`protected static String`	`OPTION_SEPARATOR` The string that separates the checker name from the option name in a "-A" command-line argument.
`protected @Nullable SourceChecker`	`parentChecker` The checker that called this one, whether that be a BaseTypeChecker (used as a compound checker) or an AggregateChecker.
`static String`	`SUPPRESS_ALL_MESSAGE_KEY` The message key that will suppress all warnings (it matches any message key).
`static String`	`SUPPRESS_ALL_PREFIX` The SuppressWarnings prefix that will suppress warnings for all checkers.
`protected Trees`	`trees` Tree utilities; used as a helper for the `SourceVisitor`.
`protected Types`	`types` Type utilities.
`static @CompilerMessageKey String`	`UNNEEDED_SUPPRESSION_KEY` The message key emitted when an unused warning suppression is found.
`protected @MonotonicNonNull List<String>`	`upstreamCheckerNames` List of upstream checker names.
`protected boolean`	`useAllcheckersPrefix` If true, use the "allcheckers:" warning string prefix.
`protected SourceVisitor<?,?>`	`visitor` The visitor to use.

Fields inherited from class javax.annotation.processing.AbstractProcessor
processingEnv

Constructor Summary

Constructors
Constructor and Description

SourceChecker()

Constructors
Constructor and Description
`SourceChecker()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addOptions(Map<String,String> moreOpts)` Add additional active options.
`protected abstract SourceVisitor<?,?>`	`createSourceVisitor()` Provides the `SourceVisitor` that the checker should use to scan input source trees.
`protected Set<String>`	`createSupportedLintOptions()` Compute the set of supported lint options.
`protected Collection<String>`	`expandCFOptions(List<? extends Class<?>> clazzPrefixes, String[] options)` Generate the possible command-line option names by prefixing each class name from `classPrefixes` to `options`, separated by `OPTION_SEPARATOR`.
`protected String`	`fullMessageOf(String messageKey, String defaultValue)` Returns the localized long message corresponding to this key.
`AnnotationProvider`	`getAnnotationProvider()` Returns the AnnotationProvider (the type factory) associated with this.
`boolean`	`getBooleanOption(String name)` Determines the boolean value of the option with the given name.
`boolean`	`getBooleanOption(String name, boolean defaultValue)` Determines the boolean value of the option with the given name.
`Elements`	`getElementUtils()` Returns the element utilities associated with this.
`boolean`	`getLintOption(String name)` Determines the value of the lint option with the given name.
`boolean`	`getLintOption(String name, boolean def)` Determines the value of the lint option with the given name.
`Properties`	`getMessagesProperties()` Provides a mapping of error keys to custom error messages.
`String`	`getOption(String name)` Determines the value of the option with the given name.
`String`	`getOption(String name, String defaultValue)` Determines the value of the lint option with the given name and returns the default value if nothing is specified.
`OptionConfiguration`	`getOptionConfiguration()` Returns the OptionConfiguration associated with this.
`Map<String,String>`	`getOptions()` Return all active options for this checker.
`@Nullable SourceChecker`	`getParentChecker()` Returns the immediate parent checker of the current checker.
`TreePath`	`getPathToCompilationUnit()` Return the path to the current compilation unit.
`ProcessingEnvironment`	`getProcessingEnvironment()` Returns the `ProcessingEnvironment` that was supplied to this checker.
`protected Properties`	`getProperties(Class<?> cls, String filePath, boolean permitNonExisting)` A helper function to parse a Properties file.
`protected NavigableSet<String>`	`getStandardSuppressWarningsPrefixes()` Returns a sorted set of SuppressWarnings prefixes read from the `SuppressWarningsPrefix` meta-annotation on the checker class.
`Set<String>`	`getSupportedAnnotationTypes()` Overrides the default implementation to always return a singleton set containing only "*".
`Set<String>`	`getSupportedLintOptions()` Returns the lint options recognized by this checker.
`Set<String>`	`getSupportedOptions()` Map the Checker Framework version of `SupportedOptions` to the standard annotation provided version `SupportedOptions`.
`SourceVersion`	`getSupportedSourceVersion()`
`SortedSet<String>`	`getSuppressWarningsPrefixes()` Returns a modifiable set of lower-case strings that are prefixes for SuppressWarnings strings.
`Trees`	`getTreeUtils()` Returns the tree utilities associated with this.
`Types`	`getTypeUtils()` Returns the type utilities associated with this.
`List<String>`	`getUpstreamCheckerNames()` Returns a list containing this checker name and all checkers it is a part of (that is, checkers that called it).
`SourceVisitor<?,?>`	`getVisitor()` Returns the SourceVisitor associated with this.
`boolean`	`hasOption(String name)` Check whether the given option is provided.
`void`	`init(ProcessingEnvironment env)`
`void`	`initChecker()` Initialize the checker.
`void`	`message(Diagnostic.Kind kind, String msg)` Print a non-localized message using the javac messager.
`void`	`message(Diagnostic.Kind kind, String msg, Object... args)` Print a non-localized message using the javac messager.
`protected void`	`printOrStoreMessage(Diagnostic.Kind kind, String message, Tree source, CompilationUnitTree root)` Do not call this method.
`protected void`	`printOrStoreMessage(Diagnostic.Kind kind, String message, Tree source, CompilationUnitTree root, StackTraceElement[] trace)` Do not call this method.
`protected void`	`printStats()` Print resource usage statistics.
`protected Object`	`processArg(Object arg)` Process an argument to an error message before it is passed to String.format.
`void`	`report(Object source, DiagMessage d)` Reports a diagnostic message.
`void`	`reportError(Object source, @CompilerMessageKey String messageKey, Object... args)` Reports an error.
`protected void`	`reportJavacError(TreePath p)` Report "type.checking.not.run" error.
`void`	`reportWarning(Object source, @CompilerMessageKey String messageKey, Object... args)` Reports a warning.
`protected void`	`setLintOption(String name, boolean val)` Set the value of the lint option with the given name.
`protected void`	`setParentChecker(SourceChecker parentChecker)` Set the parent checker of the current checker.
`protected void`	`setProcessingEnvironment(ProcessingEnvironment env)` Set the processing environment of the current checker.
`protected void`	`setRoot(CompilationUnitTree newRoot)` Invoked when the current compilation unit root changes.
`protected void`	`setSupportedLintOptions(Set<String> newLints)` Set the supported lint options.
`protected boolean`	`shouldAddShutdownHook()` Return true to indicate that method `shutdownHook()` should be added as a shutdownHook of the JVM.
`boolean`	`shouldSkipDefs(ClassTree node)` Tests whether the class definition should not be checked because it matches the `checker.skipDefs` property.
`boolean`	`shouldSkipDefs(ClassTree cls, MethodTree meth)` Tests whether the method definition should not be checked because it matches the `checker.skipDefs` property.
`boolean`	`shouldSkipUses(@Nullable Element element)` Tests whether the class owner of the passed element is an unannotated class and matches the pattern specified in the `checker.skipUses` property.
`boolean`	`shouldSkipUses(@FullyQualifiedName String typeName)` Tests whether the class owner of the passed type matches the pattern specified in the `checker.skipUses` property.
`boolean`	`shouldSuppressWarnings(@Nullable Element elt, String errKey)` Determines whether all the warnings pertaining to a given element should be suppressed.
`boolean`	`shouldSuppressWarnings(@Nullable TreePath path, String errKey)` Determines whether all the warnings pertaining to a given tree path should be suppressed.
`boolean`	`shouldSuppressWarnings(Tree tree, String errKey)` Determines whether all the warnings pertaining to a given tree should be suppressed.
`protected void`	`shutdownHook()` Method that gets called exactly once at shutdown time of the JVM.
`void`	`typeProcess(TypeElement e, TreePath p)` Type-check the code using this checker's visitor.
`void`	`typeProcessingStart()` A method to be called once before the first call to typeProcess.
`boolean`	`useConservativeDefault(String kindOfCode)` Should conservative defaults be used for the kind of unchecked code indicated by the parameter?
`protected void`	`warnUnneededSuppressions()` Issues a warning about any `@SuppressWarnings` that didn't suppress a warning, but starts with this checker name or "allcheckers".
`protected void`	`warnUnneededSuppressions(Set<Element> elementsSuppress, Set<String> prefixes, Set<String> allErrorKeys)` Issues a warning about any `@SuppressWarnings` string that didn't suppress a warning, but starts with one of the given prefixes (checker names).

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor
getCompilerLog, process, typeProcessingOver

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

- Field Detail
  - SUPPRESS_ALL_MESSAGE_KEY
```
public static final String SUPPRESS_ALL_MESSAGE_KEY
```
    The message key that will suppress all warnings (it matches any message key).
    
    See Also:
    
    Constant Field Values
  - SUPPRESS_ALL_PREFIX
```
public static final String SUPPRESS_ALL_PREFIX
```
    The SuppressWarnings prefix that will suppress warnings for all checkers.
    
    See Also:
    
    Constant Field Values
  - UNNEEDED_SUPPRESSION_KEY
```
public static final @CompilerMessageKey String UNNEEDED_SUPPRESSION_KEY
```
    The message key emitted when an unused warning suppression is found.
    
    See Also:
    
    Constant Field Values
  - MSGS_FILE
```
protected static final String MSGS_FILE
```
    File name of the localized messages.
    
    See Also:
    
    Constant Field Values
  - messagesProperties
```
protected @MonotonicNonNull Properties messagesProperties
```
    Maps error keys to localized/custom error messages. Do not use directly; call fullMessageOf(java.lang.String, java.lang.String) or processArg(java.lang.Object).
  - messager
```
protected @MonotonicNonNull Messager messager
```
    Used to report error messages and warnings via the compiler.
  - elements
```
protected Elements elements
```
    Element utilities.
  - trees
```
protected Trees trees
```
    Tree utilities; used as a helper for the SourceVisitor.
  - types
```
protected Types types
```
    Type utilities.
  - currentRoot
```
protected @InternedDistinct CompilationUnitTree currentRoot
```
    The source tree that is being scanned.
  - visitor
```
protected SourceVisitor<?,?> visitor
```
    The visitor to use.
  - useAllcheckersPrefix
```
protected boolean useAllcheckersPrefix
```
    If true, use the "allcheckers:" warning string prefix.
    Checkers that never issue any error messages should set this to false. That prevents -AwarnUnneededSuppressions from issuing warnings about @SuppressWarnings("allcheckers:...").
  - OPTION_SEPARATOR
```
protected static final String OPTION_SEPARATOR
```
    The string that separates the checker name from the option name in a "-A" command-line argument. This string may only consist of valid Java identifier part characters, because it will be used within the key of an option.
    
    See Also:
    
    Constant Field Values
  - parentChecker
```
protected @Nullable SourceChecker parentChecker
```
    The checker that called this one, whether that be a BaseTypeChecker (used as a compound checker) or an AggregateChecker. Null if this is the checker that calls all others. Note that in the case of a compound checker, the compound checker is the parent, not the checker that was run prior to this one by the compound checker.
  - upstreamCheckerNames
```
protected @MonotonicNonNull List<String> upstreamCheckerNames
```
    List of upstream checker names. Includes the current checker.
  - javacErrored
```
protected boolean javacErrored
```
    If true, javac failed to compile the code or a previously-run annotation processor issued an error.
  - errsOnLastExit
```
protected int errsOnLastExit
```
    The number of errors at the last exit of the type processor. At entry to the type processor we check whether the current error count is higher and then don't process the file, as it contains some Java errors. Needs to be protected to allow access from AggregateChecker and BaseTypeChecker.
  - DETAILS_SEPARATOR
```
public static final String DETAILS_SEPARATOR
```
    Separates parts of a "detailed message", to permit easier parsing.
    
    See Also:
    
    Constant Field Values
  - elementsWithSuppressedWarnings
```
protected final Set<Element> elementsWithSuppressedWarnings
```
    Elements with a @SuppressWarnings that actually suppressed a warning for this checker.
- Constructor Detail
  - SourceChecker
```
public SourceChecker()
```
- Method Detail
  - init
```
public final void init(ProcessingEnvironment env)
```
    Description copied from class: AbstractTypeProcessor
    
    Register a TaskListener that will get called after FLOW.
    
    Specified by:
    
    init in interface Processor
    
    Overrides:
    
    init in class AbstractTypeProcessor
  - getProcessingEnvironment
```
public ProcessingEnvironment getProcessingEnvironment()
```
    Returns the ProcessingEnvironment that was supplied to this checker.
    
    Returns:
    
    the ProcessingEnvironment that was supplied to this checker
  - setProcessingEnvironment
```
protected void setProcessingEnvironment(ProcessingEnvironment env)
```
    Set the processing environment of the current checker.
    
    Parameters:
    
    env - the new processing environment
  - setParentChecker
```
protected void setParentChecker(SourceChecker parentChecker)
```
    Set the parent checker of the current checker.
  - getParentChecker
```
public @Nullable SourceChecker getParentChecker()
```
    Returns the immediate parent checker of the current checker.
    
    Returns:
    
    the immediate parent checker of the current checker, or null if there is none
  - setRoot
```
protected void setRoot(CompilationUnitTree newRoot)
```
    Invoked when the current compilation unit root changes.
    
    Parameters:
    
    newRoot - the new compilation unit root
  - getUpstreamCheckerNames
```
public List<String> getUpstreamCheckerNames()
```
    Returns a list containing this checker name and all checkers it is a part of (that is, checkers that called it).
    
    Returns:
    
    a list containing this checker name and all checkers it is a part of (that is, checkers that called it)
  - getOptionConfiguration
```
public OptionConfiguration getOptionConfiguration()
```
    Returns the OptionConfiguration associated with this.
    
    Returns:
    
    the OptionConfiguration associated with this
  - getElementUtils
```
public Elements getElementUtils()
```
    Returns the element utilities associated with this.
    
    Returns:
    
    the element utilities associated with this
  - getTypeUtils
```
public Types getTypeUtils()
```
    Returns the type utilities associated with this.
    
    Returns:
    
    the type utilities associated with this
  - getTreeUtils
```
public Trees getTreeUtils()
```
    Returns the tree utilities associated with this.
    
    Returns:
    
    the tree utilities associated with this
  - getVisitor
```
public SourceVisitor<?,?> getVisitor()
```
    Returns the SourceVisitor associated with this.
    
    Returns:
    
    the SourceVisitor associated with this
  - createSourceVisitor
```
protected abstract SourceVisitor<?,?> createSourceVisitor()
```
    Provides the SourceVisitor that the checker should use to scan input source trees.
    
    Returns:
    
    a SourceVisitor to use to scan source trees
  - getAnnotationProvider
```
public AnnotationProvider getAnnotationProvider()
```
    Returns the AnnotationProvider (the type factory) associated with this.
    
    Returns:
    
    the AnnotationProvider (the type factory) associated with this
  - getMessagesProperties
```
public Properties getMessagesProperties()
```
    Provides a mapping of error keys to custom error messages.
    As a default, this implementation builds a Properties out of file messages.properties. It accumulates all the properties files in the Java class hierarchy from the checker up to SourceChecker. This permits subclasses to inherit default messages while being able to override them.
    
    Returns:
    
    a Properties that maps error keys to error message text
  - typeProcessingStart
```
public void typeProcessingStart()
```
    A method to be called once before the first call to typeProcess.
    Subclasses may override this method to do any initialization work.
    Type-checkers are not supposed to override this. Instead override initChecker. This allows us to handle BugInCF only here and doesn't require all overriding implementations to be aware of BugInCF.
    
    Overrides:
    
    typeProcessingStart in class AbstractTypeProcessor
    
    See Also:
    
    AbstractProcessor.init(ProcessingEnvironment), initChecker()
  - initChecker
```
public void initChecker()
```
    Initialize the checker.
    
    See Also:
    
    AbstractProcessor.init(ProcessingEnvironment)
  - reportJavacError
```
protected void reportJavacError(TreePath p)
```
    Report "type.checking.not.run" error.
    
    Parameters:
    
    p - error is reported at the leaf of the path
  - typeProcess
```
public void typeProcess(TypeElement e,
                        TreePath p)
```
    Type-check the code using this checker's visitor.
    
    Specified by:
    
    typeProcess in class AbstractTypeProcessor
    
    Parameters:
    
    e - element of the analyzed class
    
    p - the tree path to the element, with the leaf being a ClassTree
    
    See Also:
    
    Processor.process(Set, RoundEnvironment)
  - reportError
```
public void reportError(Object source,
                        @CompilerMessageKey String messageKey,
                        Object... args)
```
    Reports an error. By default, prints it to the screen via the compiler's internal messager.
    
    Parameters:
    
    source - the source position information; may be an Element, a Tree, or null
    
    messageKey - the message key
    
    args - arguments for interpolation in the string corresponding to the given message key
  - reportWarning
```
public void reportWarning(Object source,
                          @CompilerMessageKey String messageKey,
                          Object... args)
```
    Reports a warning. By default, prints it to the screen via the compiler's internal messager.
    
    Parameters:
    
    source - the source position information; may be an Element, a Tree, or null
    
    messageKey - the message key
    
    args - arguments for interpolation in the string corresponding to the given message key
  - report
```
public void report(Object source,
                   DiagMessage d)
```
    Reports a diagnostic message. By default, prints it to the screen via the compiler's internal messager.
    Most clients should use reportError(java.lang.Object, java.lang.String, java.lang.Object...) or reportWarning(java.lang.Object, java.lang.String, java.lang.Object...).
    
    Parameters:
    
    source - the source position information; may be an Element, a Tree, or null
    
    d - the diagnostic message
  - message
```
@FormatMethod
public void message(Diagnostic.Kind kind,
                                  String msg,
                                  Object... args)
```
    Print a non-localized message using the javac messager. This is preferable to using System.out or System.err, but should only be used for exceptional cases that don't happen in correct usage. Localized messages should be raised using reportError(java.lang.Object, java.lang.String, java.lang.Object...), reportWarning(java.lang.Object, java.lang.String, java.lang.Object...), etc.
    
    Parameters:
    
    kind - the kind of message to print
    
    msg - the message text
    
    args - optional arguments to substitute in the message
    
    See Also:
    
    report(Object, DiagMessage)
  - message
```
public void message(Diagnostic.Kind kind,
                    String msg)
```
    Print a non-localized message using the javac messager. This is preferable to using System.out or System.err, but should only be used for exceptional cases that don't happen in correct usage. Localized messages should be raised using reportError(java.lang.Object, java.lang.String, java.lang.Object...), reportWarning(java.lang.Object, java.lang.String, java.lang.Object...), etc.
    
    Parameters:
    
    kind - the kind of message to print
    
    msg - the message text
    
    See Also:
    
    report(Object, DiagMessage)
  - printOrStoreMessage
```
protected void printOrStoreMessage(Diagnostic.Kind kind,
                                   String message,
                                   Tree source,
                                   CompilationUnitTree root)
```
    Do not call this method. Call reportError(java.lang.Object, java.lang.String, java.lang.Object...) or reportWarning(java.lang.Object, java.lang.String, java.lang.Object...) instead.
    This method exists so that the BaseTypeChecker can override it. For compound checkers, it stores all messages and sorts them by location before outputting them.
    
    Parameters:
    
    kind - the kind of message to print
    
    message - the message text
    
    source - the source code position of the diagnostic message
    
    root - the compilation unit
  - printOrStoreMessage
```
protected void printOrStoreMessage(Diagnostic.Kind kind,
                                   String message,
                                   Tree source,
                                   CompilationUnitTree root,
                                   StackTraceElement[] trace)
```
    Do not call this method. Call reportError(java.lang.Object, java.lang.String, java.lang.Object...) or reportWarning(java.lang.Object, java.lang.String, java.lang.Object...) instead.
    This method exists so that the BaseTypeChecker can override it. For compound checkers, it stores all messages and sorts them by location before outputting them.
    
    Parameters:
    
    kind - the kind of message to print
    
    message - the message text
    
    source - the source code position of the diagnostic message
    
    root - the compilation unit
    
    trace - the stack trace where the checker encountered an error. It is printed when the dumpOnErrors option is enabled.
  - fullMessageOf
```
protected String fullMessageOf(String messageKey,
                               String defaultValue)
```
    Returns the localized long message corresponding to this key. If not found, tries suffixes of this key, stripping off dot-separated prefixes. If still not found, returns defaultValue.
    
    Parameters:
    
    messageKey - a message key
    
    defaultValue - a default value to use if messageKey is not a message key
    
    Returns:
    
    the localized long message corresponding to this key or a suffix, or defaultValue
  - processArg
```
protected Object processArg(Object arg)
```
    Process an argument to an error message before it is passed to String.format.
    This implementation expands the argument if it is exactly a message key.
    By contrast, fullMessageOf(java.lang.String, java.lang.String) processes the message key itself but not the arguments, and tries suffixes.
    
    Parameters:
    
    arg - the argument
    
    Returns:
    
    the result after processing
  - getLintOption
```
public final boolean getLintOption(String name)
```
    Determines the value of the lint option with the given name. Just as javac uses "-Xlint:xxx" to enable and "-Xlint:-xxx" to disable option xxx, annotation-related lint options are enabled with "-Alint:xxx" and disabled with "-Alint:-xxx".
    
    Parameters:
    
    name - the name of the lint option to check for
    
    Returns:
    
    true if the lint option was given, false if it was not given or was given prepended with a "-"
    
    Throws:
    
    IllegalArgumentException - if the option name is not recognized via the SupportedLintOptions annotation or the getSupportedLintOptions() method
    
    See Also:
    
    getLintOption(String, boolean)
  - getLintOption
```
public final boolean getLintOption(String name,
                                   boolean def)
```
    Determines the value of the lint option with the given name. Just as javac uses "-Xlint:xxx" to enable and "-Xlint:-xxx" to disable option xxx, annotation-related lint options are enabled with "-Alint=xxx" and disabled with "-Alint=-xxx".
    
    Parameters:
    
    name - the name of the lint option to check for
    
    def - the default option value, returned if the option was not given
    
    Returns:
    
    true if the lint option was given, false if it was given prepended with a "-", or def if it was not given at all
    
    Throws:
    
    IllegalArgumentException - if the option name is not recognized via the SupportedLintOptions annotation or the getSupportedLintOptions() method
    
    See Also:
    
    getLintOption(String), getOption(String)
  - setLintOption
```
protected final void setLintOption(String name,
                                   boolean val)
```
    Set the value of the lint option with the given name. Just as javac uses "-Xlint:xxx" to enable and "-Xlint:-xxx" to disable option xxx, annotation-related lint options are enabled with "-Alint=xxx" and disabled with "-Alint=-xxx". This method can be used by subclasses to enforce having certain lint options enabled/disabled.
    
    Parameters:
    
    name - the name of the lint option to set
    
    val - the option value
    
    Throws:
    
    IllegalArgumentException - if the option name is not recognized via the SupportedLintOptions annotation or the getSupportedLintOptions() method
    
    See Also:
    
    getLintOption(String), getLintOption(String,boolean)
  - getSupportedLintOptions
```
public Set<String> getSupportedLintOptions()
```
    Returns the lint options recognized by this checker. Lint options are those which can be checked for via getLintOption(java.lang.String).
    
    Returns:
    
    an unmodifiable Set of the lint options recognized by this checker
  - createSupportedLintOptions
```
protected Set<String> createSupportedLintOptions()
```
    Compute the set of supported lint options.
  - setSupportedLintOptions
```
protected void setSupportedLintOptions(Set<String> newLints)
```
    Set the supported lint options. Use of this method should be limited to the AggregateChecker, who needs to set the lint options to the union of all subcheckers. Also, e.g. the NullnessSubchecker need to use this method, as one is created by the other.
    
    Parameters:
    
    newLints - the new supported lint options, which replace any existing ones
  - addOptions
```
protected void addOptions(Map<String,String> moreOpts)
```
    Add additional active options. Use of this method should be limited to the AggregateChecker, who needs to set the active options to the union of all subcheckers.
    
    Parameters:
    
    moreOpts - the active options to add
  - hasOption
```
public final boolean hasOption(String name)
```
    Check whether the given option is provided.
    Note that getOption(String) can still return null even if hasOption returns true: this happens e.g. for -Amyopt
    
    Specified by:
    
    hasOption in interface OptionConfiguration
    
    Parameters:
    
    name - the name of the option to check
    
    Returns:
    
    true if the option name was provided, false otherwise
  - getOption
```
public final String getOption(String name)
```
    Determines the value of the option with the given name.
    
    Specified by:
    
    getOption in interface OptionConfiguration
    
    Parameters:
    
    name - the name of the option to check
    
    See Also:
    
    getLintOption(String,boolean)
  - getBooleanOption
```
public final boolean getBooleanOption(String name)
```
    Determines the boolean value of the option with the given name. Returns false if the option is not set.
    
    Specified by:
    
    getBooleanOption in interface OptionConfiguration
    
    Parameters:
    
    name - the name of the option to check
    
    See Also:
    
    getLintOption(String,boolean)
  - getBooleanOption
```
public final boolean getBooleanOption(String name,
                                      boolean defaultValue)
```
    Determines the boolean value of the option with the given name. Returns the given default value if the option is not set.
    
    Specified by:
    
    getBooleanOption in interface OptionConfiguration
    
    Parameters:
    
    name - the name of the option to check
    
    defaultValue - the default value to use if the option is not set
    
    See Also:
    
    getLintOption(String,boolean)
  - getOptions
```
public Map<String,String> getOptions()
```
    Return all active options for this checker.
    
    Specified by:
    
    getOptions in interface OptionConfiguration
    
    Returns:
    
    all active options for this checker
  - getOption
```
public final String getOption(String name,
                              String defaultValue)
```
    Determines the value of the lint option with the given name and returns the default value if nothing is specified.
    
    Specified by:
    
    getOption in interface OptionConfiguration
    
    Parameters:
    
    name - the name of the option to check
    
    defaultValue - the default value to use if the option is not set
    
    See Also:
    
    getOption(String), getLintOption(String)
  - getSupportedOptions
```
public Set<String> getSupportedOptions()
```
    Map the Checker Framework version of SupportedOptions to the standard annotation provided version SupportedOptions.
    
    Specified by:
    
    getSupportedOptions in interface Processor
    
    Specified by:
    
    getSupportedOptions in interface OptionConfiguration
    
    Overrides:
    
    getSupportedOptions in class AbstractProcessor
  - expandCFOptions
```
protected Collection<String> expandCFOptions(List<? extends Class<?>> clazzPrefixes,
                                             String[] options)
```
    Generate the possible command-line option names by prefixing each class name from classPrefixes to options, separated by OPTION_SEPARATOR.
    
    Parameters:
    
    clazzPrefixes - the classes to prefix
    
    options - the option names
    
    Returns:
    
    the possible combinations that should be supported
  - getSupportedAnnotationTypes
```
public final Set<String> getSupportedAnnotationTypes()
```
    Overrides the default implementation to always return a singleton set containing only "*".
    javac uses this list to determine which classes process; javac only runs an annotation processor on classes that contain at least one of the mentioned annotations. Thus, the effect of returning "*" is as if the checker were annotated by @SupportedAnnotationTypes("*"): javac runs the checker on every class mentioned on the javac command line. This method also checks that subclasses do not contain a SupportedAnnotationTypes annotation.
    To specify the annotations that a checker recognizes as type qualifiers, see AnnotatedTypeFactory.createSupportedTypeQualifiers().
    
    Specified by:
    
    getSupportedAnnotationTypes in interface Processor
    
    Overrides:
    
    getSupportedAnnotationTypes in class AbstractProcessor
    
    Throws:
    
    Error - if a subclass is annotated with SupportedAnnotationTypes
  - warnUnneededSuppressions
```
protected void warnUnneededSuppressions()
```
    Issues a warning about any @SuppressWarnings that didn't suppress a warning, but starts with this checker name or "allcheckers".
  - warnUnneededSuppressions
```
protected void warnUnneededSuppressions(Set<Element> elementsSuppress,
                                        Set<String> prefixes,
                                        Set<String> allErrorKeys)
```
    Issues a warning about any @SuppressWarnings string that didn't suppress a warning, but starts with one of the given prefixes (checker names). Does nothing if the string doesn't start with a checker name.
    
    Parameters:
    
    elementsSuppress - elements with a @SuppressWarnings that actually suppressed a warning
    
    prefixes - the SuppressWarnings prefixes that suppress all warnings from this checker
    
    allErrorKeys - all error keys that can be issued by this checker
  - shouldSuppressWarnings
```
public boolean shouldSuppressWarnings(Tree tree,
                                      String errKey)
```
    Determines whether all the warnings pertaining to a given tree should be suppressed. Returns true if the tree is within the scope of a @SuppressWarnings annotation, one of whose values suppresses the checker's warnings. Also, returns true if the errKey matches a string in -AsuppressWarnings.
    
    Parameters:
    
    tree - the tree that might be a source of a warning
    
    errKey - the error key the checker is emitting
    
    Returns:
    
    true if no warning should be emitted for the given tree because it is contained by a declaration with an appropriately-valued @SuppressWarnings annotation; false otherwise
  - shouldSuppressWarnings
```
public boolean shouldSuppressWarnings(@Nullable TreePath path,
                                      String errKey)
```
    Determines whether all the warnings pertaining to a given tree path should be suppressed. Returns true if the path is within the scope of a @SuppressWarnings annotation, one of whose values suppresses all the checker's warnings.
    
    Parameters:
    
    path - the TreePath that might be a source of, or related to, a warning
    
    errKey - the error key the checker is emitting
    
    Returns:
    
    true if no warning should be emitted for the given path because it is contained by a declaration with an appropriately-valued @SuppressWarnings annotation; false otherwise
  - useConservativeDefault
```
public boolean useConservativeDefault(String kindOfCode)
```
    Should conservative defaults be used for the kind of unchecked code indicated by the parameter?
    
    Parameters:
    
    kindOfCode - source or bytecode
    
    Returns:
    
    whether conservative defaults should be used
  - shouldSuppressWarnings
```
public boolean shouldSuppressWarnings(@Nullable Element elt,
                                      String errKey)
```
    Determines whether all the warnings pertaining to a given element should be suppressed. Returns true if the element is within the scope of a @SuppressWarnings annotation, one of whose values suppresses all the checker's warnings.
    
    Parameters:
    
    elt - the Element that might be a source of, or related to, a warning
    
    errKey - the error key the checker is emitting
    
    Returns:
    
    true if no warning should be emitted for the given Element because it is contained by a declaration with an appropriately-valued @SuppressWarnings annotation; false otherwise
  - getSuppressWarningsPrefixes
```
public SortedSet<String> getSuppressWarningsPrefixes()
```
    Returns a modifiable set of lower-case strings that are prefixes for SuppressWarnings strings.
    The collection must not be empty and must not contain only SUPPRESS_ALL_PREFIX.
    
    Returns:
    
    non-empty modifiable set of lower-case prefixes for SuppressWarnings strings
  - getStandardSuppressWarningsPrefixes
```
protected final NavigableSet<String> getStandardSuppressWarningsPrefixes()
```
    Returns a sorted set of SuppressWarnings prefixes read from the SuppressWarningsPrefix meta-annotation on the checker class. Or if no SuppressWarningsPrefix is used, the checker name is used. SUPPRESS_ALL_PREFIX is also added, at the end, unless useAllcheckersPrefix is false.
    
    Returns:
    
    a sorted set of SuppressWarnings prefixes
  - shouldSkipUses
```
public final boolean shouldSkipUses(@Nullable Element element)
```
    Tests whether the class owner of the passed element is an unannotated class and matches the pattern specified in the checker.skipUses property.
    
    Parameters:
    
    element - an element
    
    Returns:
    
    true iff the enclosing class of element should be skipped
  - shouldSkipUses
```
public boolean shouldSkipUses(@FullyQualifiedName String typeName)
```
    Tests whether the class owner of the passed type matches the pattern specified in the checker.skipUses property. In contrast to shouldSkipUses(Element) this version can also be used from primitive types, which don't have an element.
    Checkers that require their annotations not to be checked on certain JDK classes may override this method to skip them. They shall call super.shouldSkipUses(typeName) to also skip the classes matching the pattern.
    
    Parameters:
    
    typeName - the fully-qualified name of a type
    
    Returns:
    
    true iff the enclosing class of element should be skipped
  - shouldSkipDefs
```
public final boolean shouldSkipDefs(ClassTree node)
```
    Tests whether the class definition should not be checked because it matches the checker.skipDefs property.
    
    Parameters:
    
    node - class to potentially skip
    
    Returns:
    
    true if checker should not test node
  - shouldSkipDefs
```
public final boolean shouldSkipDefs(ClassTree cls,
                                    MethodTree meth)
```
    Tests whether the method definition should not be checked because it matches the checker.skipDefs property.
    TODO: currently only uses the class definition. Refine pattern. Same for skipUses.
    
    Parameters:
    
    cls - class to potentially skip
    
    meth - method to potentially skip
    
    Returns:
    
    true if checker should not test node
  - shouldAddShutdownHook
```
protected boolean shouldAddShutdownHook()
```
    Return true to indicate that method shutdownHook() should be added as a shutdownHook of the JVM.
    
    Returns:
    
    true to add shutdownHook() as a shutdown hook of the JVM
  - shutdownHook
```
protected void shutdownHook()
```
    Method that gets called exactly once at shutdown time of the JVM. Checkers can override this method to customize the behavior.
  - printStats
```
protected void printStats()
```
    Print resource usage statistics.
  - getProperties
```
protected Properties getProperties(Class<?> cls,
                                   String filePath,
                                   boolean permitNonExisting)
```
    A helper function to parse a Properties file.
    
    Parameters:
    
    cls - the class whose location is the base of the file path
    
    filePath - the name/path of the file to be read
    
    permitNonExisting - if true, return an empty Properties if the file does not exist or cannot be parsed; if false, issue an error
    
    Returns:
    
    the properties
  - getSupportedSourceVersion
```
public final SourceVersion getSupportedSourceVersion()
```
    Specified by:
    
    getSupportedSourceVersion in interface Processor
    
    Overrides:
    
    getSupportedSourceVersion in class AbstractProcessor
  - getPathToCompilationUnit
```
public TreePath getPathToCompilationUnit()
```
    Return the path to the current compilation unit.
    
    Returns:
    
    path to the current compilation unit

Class SourceChecker

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

Constructor Summary

Method Summary

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor

Methods inherited from class javax.annotation.processing.AbstractProcessor

Methods inherited from class java.lang.Object

Field Detail

SUPPRESS_ALL_MESSAGE_KEY

SUPPRESS_ALL_PREFIX

UNNEEDED_SUPPRESSION_KEY

MSGS_FILE

messagesProperties

messager

elements

trees

types

currentRoot

visitor

useAllcheckersPrefix

OPTION_SEPARATOR

parentChecker

upstreamCheckerNames

javacErrored

errsOnLastExit

DETAILS_SEPARATOR

elementsWithSuppressedWarnings

Constructor Detail

SourceChecker

Method Detail

init

getProcessingEnvironment

setProcessingEnvironment

setParentChecker

getParentChecker

setRoot

getUpstreamCheckerNames

getOptionConfiguration

getElementUtils

getTypeUtils

getTreeUtils

getVisitor

createSourceVisitor

getAnnotationProvider

getMessagesProperties

typeProcessingStart

initChecker

reportJavacError

typeProcess

reportError

reportWarning

report

message

message

printOrStoreMessage

printOrStoreMessage

fullMessageOf

processArg

getLintOption

getLintOption

setLintOption

getSupportedLintOptions

createSupportedLintOptions

setSupportedLintOptions

addOptions

hasOption

getOption

getBooleanOption

getBooleanOption

getOptions

getOption

getSupportedOptions

expandCFOptions

getSupportedAnnotationTypes

warnUnneededSuppressions

warnUnneededSuppressions

shouldSuppressWarnings

shouldSuppressWarnings

useConservativeDefault