org.checkerframework.qualframework.base

Class Checker<Q>

java.lang.Object

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

All Implemented Interfaces:

BaseContext, QualifierContext<Q>

Direct Known Subclasses:

QualifierParameterChecker, RegexQualChecker, TaintingChecker

public abstract class Checker<Q>
extends Object
implements QualifierContext<Q>

Main entry point for a pluggable type system. Each type system must provide an implementation of this abstract class that produces an appropriate QualifiedTypeFactory for the type system.

Constructor Summary

Constructors

Constructor and Description
Checker()

Method Summary

Modifier and Type	Method and Description
QualifiedTypeFormatter<Q>	createQualifiedTypeFormatter() Create a QualifiedTypeFormatter to format QualifiedTypeMirrors into strings.
protected abstract QualifiedTypeFactory<Q>	createTypeFactory() Constructs the QualifiedTypeFactory for use by this Checker.
AnnotationProvider	getAnnotationProvider()
Checker<Q>	getChecker()
CheckerAdapter<Q>	getCheckerAdapter()
QualifierContext<Q>	getContext()
Elements	getElementUtils()
protected Set<?>	getInvisibleQualifiers() Return a list of qualifiers that should not be printed unless printAllQualifiers is enabled.
OptionConfiguration	getOptionConfiguration()
ProcessingEnvironment	getProcessingEnvironment()
QualifiedTypes<Q>	getQualifiedTypeUtils()
Trees	getTreeUtils()
QualifiedTypeFactory<Q>	getTypeFactory() Returns the QualifiedTypeFactory used by this Checker.
Types	getTypeUtils()

Methods inherited from class java.lang.Object

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

Constructor Detail

Checker

public Checker()

Method Detail

getContext

public QualifierContext<Q> getContext()

getProcessingEnvironment

public ProcessingEnvironment getProcessingEnvironment()

Specified by:

getProcessingEnvironment in interface BaseContext

getElementUtils

public Elements getElementUtils()

Specified by:

getElementUtils in interface BaseContext

getTypeUtils

public Types getTypeUtils()

Specified by:

getTypeUtils in interface BaseContext

getChecker

public Checker<Q> getChecker()

Specified by:

getChecker in interface QualifierContext<Q>

getCheckerAdapter

public CheckerAdapter<Q> getCheckerAdapter()

Specified by:

getCheckerAdapter in interface QualifierContext<Q>

getQualifiedTypeUtils

public QualifiedTypes<Q> getQualifiedTypeUtils()

Specified by:

getQualifiedTypeUtils in interface QualifierContext<Q>

getAnnotationProvider

public AnnotationProvider getAnnotationProvider()

Specified by:

getAnnotationProvider in interface BaseContext

getTreeUtils

public Trees getTreeUtils()

Specified by:

getTreeUtils in interface BaseContext

getOptionConfiguration

public OptionConfiguration getOptionConfiguration()

Specified by:

getOptionConfiguration in interface BaseContext

createTypeFactory

protected abstract QualifiedTypeFactory<Q> createTypeFactory()

Constructs the QualifiedTypeFactory for use by this Checker.

getTypeFactory

public QualifiedTypeFactory<Q> getTypeFactory()

Returns the QualifiedTypeFactory used by this Checker.

Specified by:

getTypeFactory in interface QualifierContext<Q>

createQualifiedTypeFormatter

public QualifiedTypeFormatter<Q> createQualifiedTypeFormatter()

Create a QualifiedTypeFormatter to format QualifiedTypeMirrors into strings.

Returns:

the QualifiedTypeFormatter

getInvisibleQualifiers

protected Set<?> getInvisibleQualifiers()

Return a list of qualifiers that should not be printed unless printAllQualifiers is enabled.