org.checkerframework.framework.source

Class SourceChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

All Implemented Interfaces:

javax.annotation.processing.Processor, BaseContext, CFContext, OptionConfiguration

Direct Known Subclasses:

AggregateChecker, AnnotationStatistics, BaseTypeChecker, JavaCodeStatistics

@SupportedOptions(value={"suppressWarnings","skipUses","onlyUses","skipDefs","onlyDefs","ignoreRawTypeArguments","assumeSideEffectFree","assumeAssertionsAreEnabled","assumeAssertionsAreDisabled","warns","checkPurityAnnotations","invariantArrays","checkCastElementType","useDefaultsForUncheckedCode","concurrentSemantics","conservativeUninferredTypeArguments","lint","suggestPureMethods","resolveReflection","infer","showSuppressWarningKeys","warnUnneededSuppressions","requirePrefixInWarningSuppressions","ignoreInvalidAnnotationLocations","stubs","stubWarnIfNotFound","stubWarnIfNotFoundIgnoresClasses","stubWarnIfOverwritesBytecode","stubWarnIfRedundantWithBytecode","printAllQualifiers","printVerboseGenerics","detailedmsgtext","noPrintErrorStack","nomsgtext","ignorejdkastub","nocheckjdk","stubDebug","filenames","showchecks","showInferenceSteps","cfgviz","flowdotdir","verbosecfg","resourceStats","atfCacheSize","atfDoNotCache"})
public abstract class SourceChecker
extends AbstractTypeProcessor
implements CFContext, 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.

Subclasses must implement the following methods: (TODO: update the list)

• getMessages() (for type-qualifier specific error messages)
• createSourceVisitor() (for a custom SourceVisitor)
• getSuppressWarningsKeys() (for honoring @{link SuppressWarnings} annotations)

Most type-checker plug-ins will want to 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 com.sun.source.tree.CompilationUnitTree	currentRoot The source tree that is being scanned.
static java.lang.String	DETAILS_SEPARATOR
protected java.util.Set<javax.lang.model.element.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 javax.annotation.processing.Messager	messager Used to report error messages and warnings via the compiler.
protected java.util.Properties	messages Maps error keys to localized/custom error messages.
protected static java.lang.String	MSGS_FILE File name of the localized messages.
protected SourceChecker	parentChecker The checker that called this one, whether that be a BaseTypeChecker (used as a compound checker) or an AggregateChecker.
static java.lang.String	SUPPRESS_ALL_KEY The @SuppressWarnings key that will suppress warnings for all checkers.
protected com.sun.source.util.Trees	trees Used as a helper for the SourceVisitor.
static @CompilerMessageKey java.lang.String	UNNEEDED_SUPPRESSION_KEY The @SuppressWarnings key emitted when an unused warning suppression is found.
protected java.util.List<java.lang.String>	upstreamCheckerNames List of upstream checker names.
protected SourceVisitor<?,?>	visitor The visitor to use.

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
SourceChecker()

Method Summary

Modifier and Type	Method and Description
protected void	addOptions(java.util.Map<java.lang.String,java.lang.String> moreopts) Add additional active options.
protected abstract SourceVisitor<?,?>	createSourceVisitor() Provides the SourceVisitor that the checker should use to scan input source trees.
protected java.util.Set<java.lang.String>	createSupportedLintOptions() Compute the set of supported lint options.
protected java.util.Collection<java.lang.String>	expandCFOptions(java.util.List<? extends java.lang.Class<?>> clazzPrefixes, java.lang.String[] options) Generate the possible command-line option names by prefixing each class name from classPrefixes to options, separated by OPTION_SEPARATOR.
protected java.lang.String	formatStackTrace(java.lang.StackTraceElement[] stackTrace) Format a list of StackTraceElements to be printed out as an error message.
protected java.lang.String	fullMessageOf(java.lang.String messageKey, java.lang.String defValue) Returns the localized long message corresponding for this key, and returns the defValue if no localized message is found.
AnnotationProvider	getAnnotationProvider()
boolean	getBooleanOption(java.lang.String name) Determines the boolean value of the option with the given name.
boolean	getBooleanOption(java.lang.String name, boolean defaultValue) Determines the boolean value of the option with the given name.
SourceChecker	getChecker()
CFContext	getContext()
javax.lang.model.util.Elements	getElementUtils()
boolean	getLintOption(java.lang.String name) Determines the value of the lint option with the given name.
boolean	getLintOption(java.lang.String name, boolean def) Determines the value of the lint option with the given name.
java.util.Properties	getMessages() Provides a mapping of error keys to custom error messages.
java.lang.String	getOption(java.lang.String name) Determines the value of the option with the given name.
java.lang.String	getOption(java.lang.String name, java.lang.String defaultValue) Determines the value of the lint option with the given name and returns the default value if nothing is specified.
OptionConfiguration	getOptionConfiguration()
java.util.Map<java.lang.String,java.lang.String>	getOptions() Return all active options for this checker.
javax.annotation.processing.ProcessingEnvironment	getProcessingEnvironment()
protected java.util.Properties	getProperties(java.lang.Class<?> cls, java.lang.String filePath) A helper function to parse a Properties file.
protected java.util.Collection<java.lang.String>	getStandardSuppressWarningsKeys() Determine the standard set of suppress warning keys usable for any checker.
java.util.Set<java.lang.String>	getSupportedAnnotationTypes() Overrides the default implementation to always return a singleton set containing only "*".
java.util.Set<java.lang.String>	getSupportedLintOptions() Returns the lint options recognized by this checker.
java.util.Set<java.lang.String>	getSupportedOptions() Map the Checker Framework version of SupportedOptions to the standard annotation provided version SupportedOptions.
javax.lang.model.SourceVersion	getSupportedSourceVersion()
java.util.Collection<java.lang.String>	getSuppressWarningsKeys()
com.sun.source.util.Trees	getTreeUtils()
javax.lang.model.util.Types	getTypeUtils()
java.util.List<java.lang.String>	getUpstreamCheckerNames() Return a list containing this checker name and all checkers it is a part of (that is, checkers that called it).
SourceVisitor<?,?>	getVisitor()
boolean	hasOption(java.lang.String name) Check whether the given option is provided.
void	init(javax.annotation.processing.ProcessingEnvironment env)
void	initChecker() Initialize the checker.
void	message(javax.tools.Diagnostic.Kind kind, java.lang.String msg, java.lang.Object... args) Print a non-localized message using the javac messager.
protected void	printMessage(javax.tools.Diagnostic.Kind kind, java.lang.String message, com.sun.source.tree.Tree source, com.sun.source.tree.CompilationUnitTree root) Do not call this method directly.
protected void	printStats() Print resource usage statistics.
protected java.lang.Object	processArg(java.lang.Object arg) Process an argument to an error message before it is passed to String.format.
void	report(Result r, java.lang.Object src) Reports a result.
protected void	setLintOption(java.lang.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(javax.annotation.processing.ProcessingEnvironment env) Set the processing environment of the current checker.
protected void	setRoot(com.sun.source.tree.CompilationUnitTree newRoot) Invoked when the current compilation unit root changes.
protected void	setSupportedLintOptions(java.util.Set<java.lang.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(com.sun.source.tree.ClassTree node) Tests whether the class definition should not be checked because it matches the checker.skipDefs property.
boolean	shouldSkipDefs(com.sun.source.tree.ClassTree cls, com.sun.source.tree.MethodTree meth) Tests whether the method definition should not be checked because it matches the checker.skipDefs property.
boolean	shouldSkipUses(javax.lang.model.element.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(java.lang.String typeName) Tests whether the class owner of the passed type matches the pattern specified in the checker.skipUses property.
boolean	shouldSuppressWarnings(@Nullable javax.lang.model.element.Element elt, java.lang.String errKey) Determines whether all the warnings pertaining to a given tree should be suppressed.
boolean	shouldSuppressWarnings(com.sun.source.tree.Tree tree, java.lang.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.
java.lang.String	treeToFilePositionString(com.sun.source.tree.Tree tree, com.sun.source.tree.CompilationUnitTree currentRoot, javax.annotation.processing.ProcessingEnvironment processingEnv) For the given tree, compute the source positions for that tree.
void	typeProcess(javax.lang.model.element.TypeElement e, com.sun.source.util.TreePath p) Type-check the code with Java specifications and then runs the Checker Rule Checking visitor on the processed source.
void	typeProcessingStart() A method to be called once before the first call to typeProcess.
boolean	useUncheckedCodeDefault(java.lang.String kindOfCode) Should unchecked code defaults be used for the kind of code indicated by the parameter.
protected void	warnUnneededSuppressions() Issues a warning about any @SuppressWarnings that isn't used by this checker, but contains a key that would suppress a warning from this checker.
protected void	warnUnneedSuppressions(java.util.Set<javax.lang.model.element.Element> elementsSuppress, java.util.Set<java.lang.String> checkerKeys, java.util.Set<java.lang.String> errorKeys) Issues a warning about any @SuppressWarnings that isn't used by this checker, but contains a key that would suppress a warning from this checker.

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor

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_KEY

public static final java.lang.String SUPPRESS_ALL_KEY

The @SuppressWarnings key that will suppress warnings for all checkers.

See Also:

Constant Field Values

UNNEEDED_SUPPRESSION_KEY

public static final @CompilerMessageKey java.lang.String UNNEEDED_SUPPRESSION_KEY

The @SuppressWarnings key emitted when an unused warning suppression is found.

See Also:

Constant Field Values

MSGS_FILE

protected static final java.lang.String MSGS_FILE

File name of the localized messages.

See Also:

Constant Field Values

messages

protected java.util.Properties messages

Maps error keys to localized/custom error messages.

messager

protected javax.annotation.processing.Messager messager

Used to report error messages and warnings via the compiler.

trees

protected com.sun.source.util.Trees trees

Used as a helper for the SourceVisitor.

currentRoot

protected com.sun.source.tree.CompilationUnitTree currentRoot

The source tree that is being scanned.

visitor

protected SourceVisitor<?,?> visitor

The visitor to use.

parentChecker

protected 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 java.util.List<java.lang.String> upstreamCheckerNames

List of upstream checker names. Includes the current checker.

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 java.lang.String DETAILS_SEPARATOR

See Also:

Constant Field Values

elementsWithSuppressedWarnings

protected final java.util.Set<javax.lang.model.element.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(javax.annotation.processing.ProcessingEnvironment env)

Description copied from class: AbstractTypeProcessor

Register a TaskListener that will get called after FLOW.

Specified by:

init in interface javax.annotation.processing.Processor

Overrides:

init in class AbstractTypeProcessor

getProcessingEnvironment

public javax.annotation.processing.ProcessingEnvironment getProcessingEnvironment()

Specified by:

getProcessingEnvironment in interface BaseContext

Returns:

the ProcessingEnvironment that was supplied to this checker

setProcessingEnvironment

protected void setProcessingEnvironment(javax.annotation.processing.ProcessingEnvironment env)

Set the processing environment of the current checker.

setParentChecker

protected void setParentChecker(SourceChecker parentChecker)

Set the parent checker of the current checker.

setRoot

protected void setRoot(com.sun.source.tree.CompilationUnitTree newRoot)

Invoked when the current compilation unit root changes.

getUpstreamCheckerNames

public java.util.List<java.lang.String> getUpstreamCheckerNames()

Return a list containing this checker name and all checkers it is a part of (that is, checkers that called it).

getContext

public CFContext getContext()

Returns:

the CFContext used by this checker

getChecker

public SourceChecker getChecker()

Specified by:

getChecker in interface CFContext

getOptionConfiguration

public OptionConfiguration getOptionConfiguration()

Specified by:

getOptionConfiguration in interface BaseContext

getElementUtils

public javax.lang.model.util.Elements getElementUtils()

Specified by:

getElementUtils in interface BaseContext

getTypeUtils

public javax.lang.model.util.Types getTypeUtils()

Specified by:

getTypeUtils in interface BaseContext

getTreeUtils

public com.sun.source.util.Trees getTreeUtils()

Specified by:

getTreeUtils in interface BaseContext

getVisitor

public SourceVisitor<?,?> getVisitor()

Specified by:

getVisitor in interface CFContext

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()

Specified by:

getAnnotationProvider in interface BaseContext

getMessages

public java.util.Properties getMessages()

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 use 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)

shouldAddShutdownHook

protected boolean shouldAddShutdownHook()

Return true to indicate that method shutdownHook() should be added as a shutdownHook 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.

typeProcess

public void typeProcess(javax.lang.model.element.TypeElement e,
                        com.sun.source.util.TreePath p)

Type-check the code with Java specifications and then runs the Checker Rule Checking visitor on the processed source.

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)

warnUnneededSuppressions

protected void warnUnneededSuppressions()

Issues a warning about any @SuppressWarnings that isn't used by this checker, but contains a key that would suppress a warning from this checker.

warnUnneedSuppressions

protected void warnUnneedSuppressions(java.util.Set<javax.lang.model.element.Element> elementsSuppress,
                                      java.util.Set<java.lang.String> checkerKeys,
                                      java.util.Set<java.lang.String> errorKeys)

Issues a warning about any @SuppressWarnings that isn't used by this checker, but contains a key that would suppress a warning from this checker.

Parameters:

elementsSuppress - elements with a @SuppressWarnings that actually suppressed a warning

checkerKeys - suppress warning keys that suppress any warning from this checker

errorKeys - error keys that can be issued by this checker

formatStackTrace

protected java.lang.String formatStackTrace(java.lang.StackTraceElement[] stackTrace)

Format a list of StackTraceElements to be printed out as an error message.

fullMessageOf

protected java.lang.String fullMessageOf(java.lang.String messageKey,
                                         java.lang.String defValue)

Returns the localized long message corresponding for this key, and returns the defValue if no localized message is found.

printMessage

protected void printMessage(javax.tools.Diagnostic.Kind kind,
                            java.lang.String message,
                            com.sun.source.tree.Tree source,
                            com.sun.source.tree.CompilationUnitTree root)

Do not call this method directly. Call report(Result, Object) instead. (This method exists so that the BaseTypeChecker can override it and treat messages from compound checkers differently.)

processArg

protected java.lang.Object processArg(java.lang.Object arg)

Process an argument to an error message before it is passed to String.format.

Parameters:

arg - the argument

Returns:

the result after processing

message

public void message(javax.tools.Diagnostic.Kind kind,
                    java.lang.String msg,
                    java.lang.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 report(Result, Object).

Parameters:

kind - the kind of message to print

msg - the message text

args - optional arguments to substitute in the message

See Also:

report(Result, Object)

treeToFilePositionString

public java.lang.String treeToFilePositionString(com.sun.source.tree.Tree tree,
                                                 com.sun.source.tree.CompilationUnitTree currentRoot,
                                                 javax.annotation.processing.ProcessingEnvironment processingEnv)

For the given tree, compute the source positions for that tree. Return a "tuple" like string (e.g. "( 1, 200 )" ) that contains the start and end position of the tree in the current compilation unit.

Parameters:

tree - tree to locate within the current compilation unit

currentRoot - the current compilation unit

processingEnv - the current processing environment

Returns:

a tuple string representing the range of characters that tree occupies in the source file

shouldSuppressWarnings

public boolean shouldSuppressWarnings(com.sun.source.tree.Tree tree,
                                      java.lang.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. The list of keys that suppress a checker's warnings is provided by the getSuppressWarningsKeys() method.

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

useUncheckedCodeDefault

public boolean useUncheckedCodeDefault(java.lang.String kindOfCode)

Should unchecked code defaults be used for the kind of code indicated by the parameter.

Parameters:

kindOfCode - source or bytecode

Returns:

whether unchecked code defaults should be used

shouldSuppressWarnings

public boolean shouldSuppressWarnings(@Nullable javax.lang.model.element.Element elt,
                                      java.lang.String errKey)

Determines whether all the warnings pertaining to a given tree should be suppressed. Returns true if the element is within the scope of a @SuppressWarnings annotation, one of whose values suppresses the checker's warnings. The list of keys that suppress a checker's warnings is provided by the getSuppressWarningsKeys() method.

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

report

public void report(Result r,
                   java.lang.Object src)

Reports a result. By default, it prints it to the screen via the compiler's internal messenger if the result is non-success; otherwise, the method returns with no side effects.

Parameters:

r - the result to report

src - the position object associated with the result

getLintOption

public final boolean getLintOption(java.lang.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:

java.lang.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(java.lang.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:

java.lang.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(java.lang.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:

java.lang.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 java.util.Set<java.lang.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 java.util.Set<java.lang.String> createSupportedLintOptions()

Compute the set of supported lint options.

setSupportedLintOptions

protected void setSupportedLintOptions(java.util.Set<java.lang.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.

addOptions

protected void addOptions(java.util.Map<java.lang.String,java.lang.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.

hasOption

public final boolean hasOption(java.lang.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 java.lang.String getOption(java.lang.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(java.lang.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(java.lang.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 java.util.Map<java.lang.String,java.lang.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 java.lang.String getOption(java.lang.String name,
                                        java.lang.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 java.util.Set<java.lang.String> getSupportedOptions()

Map the Checker Framework version of SupportedOptions to the standard annotation provided version SupportedOptions.

Specified by:

getSupportedOptions in interface javax.annotation.processing.Processor

Specified by:

getSupportedOptions in interface OptionConfiguration

Overrides:

getSupportedOptions in class javax.annotation.processing.AbstractProcessor

expandCFOptions

protected java.util.Collection<java.lang.String> expandCFOptions(java.util.List<? extends java.lang.Class<?>> clazzPrefixes,
                                                                 java.lang.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 java.util.Set<java.lang.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 javax.annotation.processing.Processor

Overrides:

getSupportedAnnotationTypes in class javax.annotation.processing.AbstractProcessor

Throws:

java.lang.Error - if a subclass is annotated with SupportedAnnotationTypes

getSuppressWarningsKeys

public java.util.Collection<java.lang.String> getSuppressWarningsKeys()

Returns:

collection of lower-case string keys that a checker honors for suppressing warnings and errors that it issues. Each such key suppresses all warnings issued by the checker.

See Also:

SuppressWarningsKeys

getStandardSuppressWarningsKeys

protected final java.util.Collection<java.lang.String> getStandardSuppressWarningsKeys()

Determine the standard set of suppress warning keys usable for any checker.

Returns:

collection of warning keys

See Also:

getSuppressWarningsKeys()

shouldSkipUses

public final boolean shouldSkipUses(javax.lang.model.element.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(java.lang.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(typerName) 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(com.sun.source.tree.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(com.sun.source.tree.ClassTree cls,
                                    com.sun.source.tree.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

getProperties

protected java.util.Properties getProperties(java.lang.Class<?> cls,
                                             java.lang.String filePath)

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

Returns:

the properties

getSupportedSourceVersion

public final javax.lang.model.SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface javax.annotation.processing.Processor

Overrides:

getSupportedSourceVersion in class javax.annotation.processing.AbstractProcessor