checkers.javari

Class JavariChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

checkers.source.AbstractTypeProcessor

checkers.source.SourceChecker

checkers.basetype.BaseTypeChecker

checkers.javari.JavariChecker

All Implemented Interfaces:

Processor

public class JavariChecker
extends BaseTypeChecker

An annotation processor that checks a program's use of the Javari type annotations (@ReadOnly, @Mutable, @Assignable, @PolyRead and @QReadOnly).

See the Checker Framework manual:

Javari Checker

Nested Class Summary

Nested classes/interfaces inherited from class checkers.source.SourceChecker

SourceChecker.CheckerError

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable AnnotationMirror	ASSIGNABLE
protected @Nullable AnnotationMirror	MUTABLE
protected @Nullable AnnotationMirror	POLYREAD
protected @Nullable AnnotationMirror	QREADONLY
protected @Nullable AnnotationMirror	READONLY
protected @Nullable AnnotationMirror	THISMUTABLE

Fields inherited from class checkers.source.SourceChecker

currentPath, currentRoot, messager, messages, trees

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
JavariChecker()

Method Summary

Methods

Modifier and Type	Method and Description
protected TypeHierarchy	createTypeHierarchy() Implements the @QReadOnly behavior on generic types, creating a new TypeHierarchy class that allows a comparison of type arguments to succeed if the left hand side is annotated with @QReadOnly or if the regular comparison succeeds.
void	initChecker() Initializes the checker: calls init method on super class, creates a local AnnotationFactory based on the processing environment, and uses it to create the protected AnnotationMirrors used through this checker.

Methods inherited from class checkers.basetype.BaseTypeChecker

createFactory, createQualifierHierarchy, createQualifierHierarchy, createQualifierHierarchyFactory, createSourceVisitor, createSupportedTypeQualifiers, getQualifierHierarchy, getSupportedLintOptions, getSupportedTypeQualifiers, getTypeHierarchy, invokeConstructorFor

Methods inherited from class checkers.source.SourceChecker

errorAbort, errorAbort, formatStackTrace, fullMessageOf, getLintOption, getLintOption, getMessages, getProcessingEnvironment, getProperties, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, getSuppressWarningsKey, message, report, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, typeProcess, typeProcessingStart

Methods inherited from class checkers.source.AbstractTypeProcessor

init, process, typeProcessingOver

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

READONLY

protected @Nullable AnnotationMirror READONLY

THISMUTABLE

protected @Nullable AnnotationMirror THISMUTABLE

MUTABLE

protected @Nullable AnnotationMirror MUTABLE

POLYREAD

protected @Nullable AnnotationMirror POLYREAD

QREADONLY

protected @Nullable AnnotationMirror QREADONLY

ASSIGNABLE

protected @Nullable AnnotationMirror ASSIGNABLE

Constructor Detail

JavariChecker

public JavariChecker()

Method Detail

initChecker

public void initChecker()

Initializes the checker: calls init method on super class, creates a local AnnotationFactory based on the processing environment, and uses it to create the protected AnnotationMirrors used through this checker.

Overrides:

initChecker in class BaseTypeChecker

Parameters:

processingEnv - the processing environment to use in the local AnnotationFactory

See Also:

AbstractProcessor.init(ProcessingEnvironment)

createTypeHierarchy

protected TypeHierarchy createTypeHierarchy()

Implements the @QReadOnly behavior on generic types, creating a new TypeHierarchy class that allows a comparison of type arguments to succeed if the left hand side is annotated with @QReadOnly or if the regular comparison succeeds.

Overrides:

createTypeHierarchy in class BaseTypeChecker

Returns:

the type relations class to check type subtyping