|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.annotation.processing.AbstractProcessor
checkers.source.SourceChecker
@DefaultQualifier(value="checkers.nullness.quals.NonNull") public abstract class SourceChecker
An abstract annotation processor designed for implementing a
source-file checker for a JSR-308 conforming 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:
getMessages()
(for type-qualifier specific error messages)
createSourceVisitor(CompilationUnitTree)
(for a custom SourceVisitor
)
createFactory(com.sun.source.tree.CompilationUnitTree)
(for a custom AnnotatedTypeFactory
)
getSuppressWarningsKey()
(for honoring
SuppressWarnings
annotations)
BaseTypeChecker
,
instead of this class. Only checkers which require annotated types but not
subtype checking (e.g. for testing purposes) should extend this.
Non-type checkers (e.g. for enforcing coding styles) should extend
AbstractProcessor
(or even this class) as the Checker Framework is
not designed for such checkers.
Field Summary | |
---|---|
protected CompilationUnitTree |
currentRoot
The source tree that's being scanned. |
protected ProcessingEnvironment |
env
Provides access to compiler helpers/internals. |
protected com.sun.tools.javac.processing.JavacMessager |
messager
Used to report error messages and warnings via the compiler. |
protected Properties |
messages
Maps error keys to localized/custom error messages. |
protected Pattern |
skipPattern
A regular expression for classes that should be skipped. |
protected Trees |
trees
Used as a helper for the SourceVisitor . |
Fields inherited from class javax.annotation.processing.AbstractProcessor |
---|
processingEnv |
Constructor Summary | |
---|---|
SourceChecker()
|
Method Summary | |
---|---|
protected boolean |
attribute(Set<? extends TypeElement> elements)
Attribute the trees associated with the provided elements. |
AnnotatedTypeFactory |
createFactory(CompilationUnitTree root)
|
protected abstract SourceVisitor<?,?> |
createSourceVisitor(CompilationUnitTree root)
Provides the SourceVisitor that the checker should use to scan
input source trees. |
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 |
getMessages()
Provides a mapping of error keys to custom error messages. |
ProcessingEnvironment |
getProcessingEnvironment()
|
Pattern |
getShouldSkip()
Returns a regular expression pattern to specify java classes that are not annotated, and thus whose warnings and should be surpressed. |
Set<String> |
getSupportedAnnotationTypes()
Always returns a singleton set containing only "*". |
Set<String> |
getSupportedLintOptions()
Returns the lint options recognized by this checker. |
Set<String> |
getSupportedOptions()
|
SourceVersion |
getSupportedSourceVersion()
|
protected String |
getSuppressWarningsKey()
|
void |
init(ProcessingEnvironment processingEnv)
|
protected void |
message(Diagnostic.Kind kind,
Object source,
Object msgKey,
Object... args)
Prints a message (error, warning, note, etc.) via JSR-269. |
boolean |
process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv)
Type-check the code with Java specifications and then runs the Checker Rule Checking visitor on the processed source. |
void |
report(Result r,
Object src)
Reports a result. |
boolean |
shouldSkip(String className)
Determines whether checking against members of the class with the given name should be performed. |
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 |
---|
protected ProcessingEnvironment env
protected Properties messages
protected com.sun.tools.javac.processing.JavacMessager messager
protected Trees trees
SourceVisitor
.
protected CompilationUnitTree currentRoot
protected final Pattern skipPattern
Constructor Detail |
---|
public SourceChecker()
Method Detail |
---|
public ProcessingEnvironment getProcessingEnvironment()
ProcessingEnvironment
that was supplied to this
checkerpublic AnnotatedTypeFactory createFactory(CompilationUnitTree root)
root
- the AST root for the factory
AnnotatedTypeFactory
for use by typecheckersprotected abstract SourceVisitor<?,?> createSourceVisitor(CompilationUnitTree root)
SourceVisitor
that the checker should use to scan
input source trees.
root
- the AST root
SourceVisitor
to use to scan source treespublic Properties getMessages()
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.
Properties
that maps error keys to error message textpublic void init(ProcessingEnvironment processingEnv)
init
in interface Processor
init
in class AbstractProcessor
AbstractProcessor.init(ProcessingEnvironment)
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
Processor
is invoked in the annotation processing phase,
before the code is type-checked by the compiler. This method ensures
that only Java valid code is processed by the Rule Checking visitor.
process
in interface Processor
process
in class AbstractProcessor
Processor.process(Set, RoundEnvironment)
protected boolean attribute(Set<? extends TypeElement> elements)
TypeElement
.
The attribution phase involves two tasks, essential for the checkers:
1. type-checking the code, and issuing errors if the code does not
adhere to Java specification. A processor should only run if the
code is a valid code.
2. evaluating the type of each tree and creating the symbol table for
the tree, i.e. resolves the identities (variables, methods, classes)
referred to by tree identifiers.
elements
-
protected void message(Diagnostic.Kind kind, Object source, Object msgKey, Object... args)
kind
- the type of message to printsource
- the object from which to obtain source position informationmsgKey
- the message key to printargs
- arguments for interpolation in the string corresponding to the
given message key
IllegalArgumentException
- if source
is neither a Tree
nor an
Element
Diagnostic
public void report(Result r, Object src)
r
- the result to reportsrc
- the position object associated with the resultpublic boolean shouldSkip(String className)
checkers.skipClasses
property.
className
- the fully qualified name of the class to check
className
should
not be checked againstpublic final boolean getLintOption(String name)
name
- the name of the lint option to check for
IllegalArgumentException
- if the option name is not recognized
via the SupportedLintOptions
annotation or the getSupportedLintOptions()
methodgetLintOption(String,boolean)
public final boolean getLintOption(String name, boolean def)
name
- the name of the lint option to check fordef
- the default option value, returned if the option was not given
def
if it was not given at all
IllegalArgumentException
- if the option name is not recognized
via the SupportedLintOptions
annotation or the getSupportedLintOptions()
methodgetLintOption(String)
public Set<String> getSupportedLintOptions()
getLintOption(java.lang.String)
.
Set
of the lint options recognized by
this checkerpublic Set<String> getSupportedOptions()
getSupportedOptions
in interface Processor
getSupportedOptions
in class AbstractProcessor
public final Set<String> getSupportedAnnotationTypes()
SupportedAnnotationTypes
annotation, so 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,
use the TypeQualifiers
annotation on the declaration of
subclasses of this class or override the
BaseTypeChecker.getSupportedTypeQualifiers()
method.
getSupportedAnnotationTypes
in interface Processor
getSupportedAnnotationTypes
in class AbstractProcessor
Error
- if a subclass is annotated with
SupportedAnnotationTypes
TypeQualifiers
,
getSupportedAnnotationTypes()
@Nullable protected String getSuppressWarningsKey()
SuppressWarningsKey
public Pattern getShouldSkip()
checkers.skipClasses
; otherwise it returns a pattern that can
match no class.
public SourceVersion getSupportedSourceVersion()
getSupportedSourceVersion
in interface Processor
getSupportedSourceVersion
in class AbstractProcessor
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |