Package org.checkerframework.common.reflection

Class ClassValChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.common.reflection.ClassValChecker

All Implemented Interfaces:

Processor, OptionConfiguration

public class ClassValChecker
extends BaseTypeChecker

The ClassVal Checker provides a sound estimate of the binary name of Class objects.

See the Checker Framework Manual:

ClassVal Checker

Field Summary

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

currentRoot, DETAILS_SEPARATOR, elements, elementsWithSuppressedWarnings, errsOnLastExit, javacErrored, messager, messagesProperties, MSGS_FILE, OPTION_SEPARATOR, parentChecker, SUPPRESS_ALL_MESSAGE_KEY, SUPPRESS_ALL_PREFIX, treePathCacher, trees, types, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
ClassValChecker()

Method Summary

Modifier and Type	Method	Description
protected BaseTypeVisitor<?>	createSourceVisitor()	Returns the appropriate visitor that type-checks the compilation unit according to the type system rules.
protected Set<Class<? extends BaseTypeChecker>>	getImmediateSubcheckerClasses()	Returns the set of subchecker classes on which this checker depends.
boolean	shouldResolveReflection()	Returns whether or not reflection should be resolved.

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

createSourceVisitorPublic, getAnnotationProvider, getExtraStubFiles, getOptions, getOptionsNoSubcheckers, getRelatedClassName, getSubchecker, getSubcheckers, getSupportedLintOptions, getSupportedOptions, getSuppressWarningsPrefixesOfSubcheckers, getTypeFactory, getTypeFactoryOfSubcheckerOrNull, getUltimateParentChecker, getVisitor, hasOptionNoSubcheckers, initChecker, invokeConstructorFor, printOrStoreMessage, processErrorMessageArg, setRoot, shouldAddShutdownHook, shutdownHook, typeProcess, typeProcessingOver, warnUnneededSuppressions

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

addOptions, createSupportedLintOptions, expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getLintOption, getLintOption, getMessagesProperties, getOption, getOption, getOptionConfiguration, getParentChecker, getPathToCompilationUnit, getProcessingEnvironment, getProperties, getStandardSuppressWarningsPrefixes, getStringsOption, getStringsOption, getSupportedAnnotationTypes, getSupportedSourceVersion, getSuppressWarningsPrefixes, getTreePathCacher, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, getWarningMessagePrefix, hasOption, init, message, message, messageKeyMatches, printOrStoreMessage, printStats, report, reportError, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor

getCompilerLog, 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.OptionConfiguration

getStringsOption, getStringsOption

Constructor Details

ClassValChecker

public ClassValChecker()

Method Details

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

getImmediateSubcheckerClasses

protected Set<Class<? extends BaseTypeChecker>> getImmediateSubcheckerClasses()

Description copied from class: BaseTypeChecker

Returns the set of subchecker classes on which this checker depends. Returns an empty set if this checker does not depend on any others.

Subclasses should override this method to specify subcheckers. If they do so, they should call the super implementation of this method and add dependencies to the returned set so that checkers required for reflection resolution are included if reflection resolution is requested.

Each subchecker of this checker may also depend on other checkers. If this checker and one of its subcheckers both depend on a third checker, that checker will only be instantiated once.

Though each checker is run on a whole compilation unit before the next checker is run, error and warning messages are collected and sorted based on the location in the source file before being printed. (See BaseTypeChecker.printOrStoreMessage(Diagnostic.Kind, String, Tree, CompilationUnitTree).)

WARNING: Circular dependencies are not supported nor do checkers verify that their dependencies are not circular. Make sure no circular dependencies are created when overriding this method. (In other words, if checker A depends on checker B, checker B cannot depend on checker A.)

This method is protected so it can be overridden, but it should only be called internally by the BaseTypeChecker.

The BaseTypeChecker will not modify the set returned by this method, but clients that override the method do modify the set.

Overrides:

getImmediateSubcheckerClasses in class BaseTypeChecker

Returns:

the subchecker classes on which this checker depends; will be modified by callees in overriding methods

shouldResolveReflection

public boolean shouldResolveReflection()

Description copied from class: BaseTypeChecker

Returns whether or not reflection should be resolved.

Overrides:

shouldResolveReflection in class BaseTypeChecker

Returns:

true if reflection should be resolved