checkers.igj

Class IGJChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

checkers.source.AbstractTypeProcessor

checkers.source.SourceChecker

checkers.basetype.BaseTypeChecker

checkers.igj.IGJChecker

All Implemented Interfaces:

Processor

public class IGJChecker
extends BaseTypeChecker

A type-checker plug-in for the IGJ immutability type system that finds (and verifies the absence of) undesired side-effect errors. The IGJ language is a Java language extension that expresses immutability constraints, using six annotations: ReadOnly, Mutable, Immutable, I -- a polymorphic qualifier, Assignable, and AssignsFields. The language is specified by the FSE 2007 paper.

See the Checker Framework manual:

IGJ 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	ASSIGNS_FIELDS Supported annotations for IGJ.
protected @Nullable AnnotationMirror	BOTTOM_QUAL Supported annotations for IGJ.
protected @Nullable AnnotationMirror	I Supported annotations for IGJ.
protected @Nullable AnnotationMirror	IMMUTABLE Supported annotations for IGJ.
protected @Nullable AnnotationMirror	MUTABLE Supported annotations for IGJ.
protected @Nullable AnnotationMirror	READONLY Supported annotations for IGJ.

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

Method Summary

Methods

Modifier and Type	Method and Description
QualifierHierarchy	createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory) Factory method to easily change what QualifierHierarchy is created.
protected TypeHierarchy	createTypeHierarchy() Creates the type subtyping checker using the current type qualifier hierarchy.
void	initChecker() Initialize the checker.

Methods inherited from class checkers.basetype.BaseTypeChecker

createFactory, 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

Supported annotations for IGJ. Used for subtyping rules.

MUTABLE

protected @Nullable AnnotationMirror MUTABLE

Supported annotations for IGJ. Used for subtyping rules.

IMMUTABLE

protected @Nullable AnnotationMirror IMMUTABLE

Supported annotations for IGJ. Used for subtyping rules.

I

protected @Nullable AnnotationMirror I

Supported annotations for IGJ. Used for subtyping rules.

ASSIGNS_FIELDS

protected @Nullable AnnotationMirror ASSIGNS_FIELDS

Supported annotations for IGJ. Used for subtyping rules.

BOTTOM_QUAL

protected @Nullable AnnotationMirror BOTTOM_QUAL

Supported annotations for IGJ. Used for subtyping rules.

Constructor Detail

IGJChecker

public IGJChecker()

Method Detail

initChecker

public void initChecker()

Description copied from class: SourceChecker

Initialize the checker.

Overrides:

initChecker in class BaseTypeChecker

See Also:

AbstractProcessor.init(ProcessingEnvironment)

createQualifierHierarchy

public QualifierHierarchy createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory)

Description copied from class: BaseTypeChecker

Factory method to easily change what QualifierHierarchy is created. Needs to be public only because the GraphFactory must be able to call this method. No external use of this method is necessary.

Overrides:

createQualifierHierarchy in class BaseTypeChecker

createTypeHierarchy

protected TypeHierarchy createTypeHierarchy()

Description copied from class: BaseTypeChecker

Creates the type subtyping checker using the current type qualifier hierarchy. Subclasses may override this method to specify new type checking rules beyond the typical java subtyping rules.

Overrides:

createTypeHierarchy in class BaseTypeChecker

Returns:

the type relations class to check type subtyping