org.checkerframework.checker.nullness

Class AbstractNullnessChecker

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

org.checkerframework.checker.nullness.AbstractNullnessChecker

All Implemented Interfaces:

javax.annotation.processing.Processor, org.checkerframework.common.basetype.BaseTypeContext, org.checkerframework.framework.util.BaseContext, org.checkerframework.framework.util.CFContext, org.checkerframework.framework.util.OptionConfiguration, org.checkerframework.javacutil.ErrorHandler

Direct Known Subclasses:

NullnessChecker, NullnessRawnessChecker

@SupportedLintOptions(value={"noInitForMonotonicNonNull","redundantNullComparison","forbidnonnullarraycomponents"})
public abstract class AbstractNullnessChecker
extends InitializationChecker

An implementation of the nullness type-system, parameterized by an initialization type-system for safe initialization. It can use freedom-before-commitment or rawness as its initialization type system.

See the Checker Framework Manual:

Nullness Checker

Nested Class Summary

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

org.checkerframework.framework.source.SourceChecker.CheckerError

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	LINT_DEFAULT_NOINITFORMONOTONICNONNULL Default for LINT_NOINITFORMONOTONICNONNULL.
static boolean	LINT_DEFAULT_REDUNDANTNULLCOMPARISON Default for LINT_REDUNDANTNULLCOMPARISON.
static java.lang.String	LINT_NOINITFORMONOTONICNONNULL Should we be strict about initialization of MonotonicNonNull variables.
static java.lang.String	LINT_REDUNDANTNULLCOMPARISON Warn about redundant comparisons of expressions with null, if the expressions is known to be non-null.

Fields inherited from class org.checkerframework.checker.initialization.InitializationChecker

useFbc

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

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

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
AbstractNullnessChecker(boolean useFbc)

Method Summary

Modifier and Type	Method and Description
protected org.checkerframework.common.basetype.BaseTypeVisitor<?>	createSourceVisitor()
protected java.util.LinkedHashSet<java.lang.Class<? extends org.checkerframework.common.basetype.BaseTypeChecker>>	getImmediateSubcheckerClasses()
java.util.Collection<java.lang.String>	getSuppressWarningsKeys()

Methods inherited from class org.checkerframework.checker.initialization.InitializationChecker

getAllFields

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

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

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

addOptions, createSupportedLintOptions, errorAbort, errorAbort, expandCFOptions, formatStackTrace, fullMessageOf, getBooleanOption, getBooleanOption, 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, warnUnneedSuppressions

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

LINT_NOINITFORMONOTONICNONNULL

public static final java.lang.String LINT_NOINITFORMONOTONICNONNULL

Should we be strict about initialization of MonotonicNonNull variables.

See Also:

Constant Field Values

LINT_DEFAULT_NOINITFORMONOTONICNONNULL

public static final boolean LINT_DEFAULT_NOINITFORMONOTONICNONNULL

Default for LINT_NOINITFORMONOTONICNONNULL.

See Also:

Constant Field Values

LINT_REDUNDANTNULLCOMPARISON

public static final java.lang.String LINT_REDUNDANTNULLCOMPARISON

Warn about redundant comparisons of expressions with null, if the expressions is known to be non-null.

See Also:

Constant Field Values

LINT_DEFAULT_REDUNDANTNULLCOMPARISON

public static final boolean LINT_DEFAULT_REDUNDANTNULLCOMPARISON

Default for LINT_REDUNDANTNULLCOMPARISON.

See Also:

Constant Field Values

Constructor Detail

AbstractNullnessChecker

public AbstractNullnessChecker(boolean useFbc)

Method Detail

getImmediateSubcheckerClasses

protected java.util.LinkedHashSet<java.lang.Class<? extends org.checkerframework.common.basetype.BaseTypeChecker>> getImmediateSubcheckerClasses()

Overrides:

getImmediateSubcheckerClasses in class org.checkerframework.common.basetype.BaseTypeChecker

getSuppressWarningsKeys

public java.util.Collection<java.lang.String> getSuppressWarningsKeys()

Overrides:

getSuppressWarningsKeys in class InitializationChecker

createSourceVisitor

protected org.checkerframework.common.basetype.BaseTypeVisitor<?> createSourceVisitor()

Overrides:

createSourceVisitor in class org.checkerframework.common.basetype.BaseTypeChecker