org.checkerframework.qualframework.base

Class CheckerAdapter<Q>

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.qualframework.base.CheckerAdapter<Q>

All Implemented Interfaces:

Processor, BaseTypeContext, BaseContext, CFContext, OptionConfiguration, ErrorHandler

Direct Known Subclasses:

RegexChecker, RegexCheckerAdapter, TaintingChecker, TaintingCheckerAdapter

public class CheckerAdapter<Q>
extends BaseTypeChecker

Adapter class for Checker, extending org.checkerframework.common.basetype.BaseTypeChecker.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CheckerAdapter.QualAnnotationFormatterAdapter Adapter to convert an AnnotatedTypeFormatter to a QualifiedTypeFormatter.

Nested classes/interfaces inherited from class org.checkerframework.framework.source.SourceChecker

SourceChecker.CheckerError

Field Summary

Fields inherited from class org.checkerframework.framework.source.SourceChecker

currentRoot, DETAILS_SEPARATOR, errsOnLastExit, messager, messages, MSGS_FILE, parentChecker, SUPPRESS_ALL_KEY, trees, upstreamCheckerNames, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
CheckerAdapter(Checker<Q> underlying) Constructs a CheckerAdapter from an underlying qualifier-based Checker.

Method Summary

Modifier and Type	Method and Description
protected BaseTypeVisitor<?>	createSourceVisitor() Returns the appropriate visitor that type-checks the compilation unit according to the type system rules.
org.checkerframework.qualframework.base.QualifiedTypeFactoryAdapter<Q>	getTypeFactory() Gets the QualifiedTypeFactoryAdapter for the underlying checker's QualifiedTypeFactory.
TypeMirrorConverter<Q>	getTypeMirrorConverter() Gets the TypeMirrorConverter used by this CheckerAdapter and its component adapters.
Checker<Q>	getUnderlying()
void	setupDefaults(QualifierDefaults defaults)

Methods inherited from class org.checkerframework.common.basetype.BaseTypeChecker

getAnnotationProvider, getChecker, getContext, getImmediateSubcheckerClasses, getOptions, getSubchecker, getSupportedLintOptions, getSupportedOptions, getTypeFactoryOfSubchecker, getVisitor, initChecker, invokeConstructorFor, processArg, shouldAddShutdownHook, shouldResolveReflection, shutdownHook, typeProcess, typeProcessingOver

Methods inherited from class org.checkerframework.framework.source.SourceChecker

addOptions, createSupportedLintOptions, errorAbort, errorAbort, expandCFOptions, formatStackTrace, fullMessageOf, getElementUtils, getLintOption, getLintOption, getMessages, getOption, getOption, getOptionConfiguration, getProcessingEnvironment, getProperties, getStandardSuppressWarningsKeys, getSupportedAnnotationTypes, getSupportedSourceVersion, getSuppressWarningsKeys, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, init, message, message, printStats, report, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, treeToFilePositionString, typeProcessingStart, userErrorAbort, useUncheckedCodeDefault

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor

process

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

Methods inherited from interface org.checkerframework.framework.util.BaseContext

getElementUtils, getOptionConfiguration, getProcessingEnvironment, getTreeUtils, getTypeUtils

Constructor Detail

CheckerAdapter

public CheckerAdapter(Checker<Q> underlying)

Constructs a CheckerAdapter from an underlying qualifier-based Checker.

Method Detail

getTypeMirrorConverter

public TypeMirrorConverter<Q> getTypeMirrorConverter()

Gets the TypeMirrorConverter used by this CheckerAdapter and its component adapters.

getTypeFactory

public org.checkerframework.qualframework.base.QualifiedTypeFactoryAdapter<Q> getTypeFactory()

Gets the QualifiedTypeFactoryAdapter for the underlying checker's QualifiedTypeFactory. This is used by the SourceVisitor defined below to obtain the QualifiedTypeFactoryAdapter using lazy initialization.

Specified by:

getTypeFactory in interface BaseTypeContext

Overrides:

getTypeFactory in class BaseTypeChecker

createSourceVisitor

protected BaseTypeVisitor<?> createSourceVisitor()

Description copied from class: BaseTypeChecker

Returns the appropriate visitor that type-checks the compilation unit according to the type system rules.

This implementation uses the checker naming convention to create the appropriate visitor. If no visitor is found, it returns an instance of BaseTypeVisitor. It reflectively invokes the constructor that accepts this checker and the compilation unit tree (in that order) as arguments.

Subclasses have to override this method to create the appropriate visitor if they do not follow the checker naming convention.

Overrides:

createSourceVisitor in class BaseTypeChecker

Returns:

the type-checking visitor

getUnderlying

public Checker<Q> getUnderlying()

setupDefaults

public void setupDefaults(QualifierDefaults defaults)