org.checkerframework.checker.initialization

Class InitializationChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.checker.initialization.InitializationChecker

All Implemented Interfaces:

Processor, BaseTypeContext, BaseContext, CFContext, OptionConfiguration, ErrorHandler

Direct Known Subclasses:

AbstractNullnessChecker

public abstract class InitializationChecker
extends BaseTypeChecker

Tracks whether a value is initialized (all its fields are set), and checks that values are initialized before being used. Supports two different type systems for initialization: freedom-before-commitment (which is generally preferred) and rawness.

Author:

Stefan Heule

See the Checker Framework Manual:

Initialization Checker

Nested Class Summary

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

SourceChecker.CheckerError

Field Summary

Fields

Modifier and Type	Field and Description
boolean	useFbc Should the initialization type system be FBC? If not, the rawness type system is used for initialization.

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
InitializationChecker(boolean useFbc)

Method Summary

Modifier and Type	Method and Description
static List<VariableTree>	getAllFields(ClassTree clazz) Returns a list of all fields of the given class
Collection<String>	getSuppressWarningsKeys()

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

createSourceVisitor, getAnnotationProvider, getChecker, getContext, getImmediateSubcheckerClasses, getOptions, getSubchecker, getSupportedLintOptions, getSupportedOptions, getTypeFactory, getTypeFactoryOfSubchecker, getVisitor, initChecker, invokeConstructorFor, printMessage, 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, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, init, 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

Field Detail

useFbc

public final boolean useFbc

Should the initialization type system be FBC? If not, the rawness type system is used for initialization.

Constructor Detail

InitializationChecker

public InitializationChecker(boolean useFbc)

Method Detail

getSuppressWarningsKeys

public Collection<String> getSuppressWarningsKeys()

Overrides:

getSuppressWarningsKeys in class SourceChecker

Returns:

string keys that a checker honors for suppressing warnings and errors that it issues. Each such key suppresses all warnings issued by the checker.

See Also:

SuppressWarningsKeys

getAllFields

public static List<VariableTree> getAllFields(ClassTree clazz)

Returns a list of all fields of the given class