Package org.checkerframework.framework.source

Contains the essential functionality for interfacing a compile-time (source) type-checker plug-in to the Java compiler.

See: Description

Class Summary

Class	Description
AggregateChecker	An aggregate checker that packages multiple checkers together.
Result	Represents the outcome of a type-checking operation (success, warning, or failure, plus a list of explanatory messages).
Result.DiagMessage	A class that represents diagnostic messages.
SourceChecker	An abstract annotation processor designed for implementing a source-file checker for a JSR-308 conforming compiler plug-in.
SourceVisitor<R,P>	An AST visitor that provides a variety of compiler utilities and interfaces to facilitate type-checking.

Exception Summary

Exception	Description
SourceChecker.CheckerError	Exception type used only internally to abort processing.

Annotation Types Summary

Annotation Type	Description
SupportedLintOptions	An annotation used to indicate what lint options a checker supports.
SupportedOptions	An annotation used to indicate what Checker Framework options a checker supports.
SuppressWarningsKeys	Specifies the argument(s) that this checker recognizes for suppressing warnings via the SuppressWarnings annotation.

Package org.checkerframework.framework.source Description

Contains the essential functionality for interfacing a compile-time (source) type-checker plug-in to the Java compiler. This allows a checker to use the compiler's error reporting mechanism and to access abstract syntax trees and compiler utility classes.

Most classes won't want to extend the classes in this package directly; the classes in the org.checkerframework.common.basetype package provide subtype checking functionality.

See Also:

org.checkerframework.common.basetype

See the Checker Framework Manual:

Writing a Checker