Package org.checkerframework.checker.nullness

Class NullnessChecker

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.NullnessChecker

All Implemented Interfaces:

Processor, OptionConfiguration

@SupportedLintOptions({"noInitForMonotonicNonNull","redundantNullComparison","soundArrayCreationNullness","forbidnonnullarraycomponents","trustArrayLenZero","permitClearProperty"})
@SupportedOptions({"assumeKeyFor","assumeInitialized","jspecifyNullMarkedAlias","conservativeArgumentNullnessAfterInvocation"})
@StubFiles({"junit-assertions.astub","log4j.astub"})
public class NullnessChecker
extends InitializationChecker

An implementation of the nullness type-system, parameterized by an initialization type-system for safe initialization. It uses freedom-before-commitment, augmented by type frames (which are crucial to obtain acceptable precision), as its initialization type system.

This checker uses the NullnessNoInitSubchecker to check for nullness and extends the InitializationChecker to also check that all non-null fields are properly initialized.

You can use the following SuppressWarnings prefixes with this checker:

• @SuppressWarnings("nullness") suppresses warnings from the Nullness, Initialization, and KeyFor Checkers
• @SuppressWarnings("nullnessinitialization") suppresses warnings from the Nullness and Initialization Checkers only, warnings from the KeyFor Checker are not suppressed
• @SuppressWarnings("nullnesskeyfor") suppresses warnings from the Nullness and KeyFor Checkers only, warnings from the Initialization Checker are not suppressed @SuppressWarnings("nullnessnoinit") has the same effect as @SuppressWarnings("nullnesskeyfor")
• @SuppressWarnings("nullnessonly") suppresses warnings from the Nullness Checker only, warnings from the Initialization and KeyFor Checkers are not suppressed
• @SuppressWarnings("initialization") suppresses warnings from the Initialization Checker only, warnings from the Nullness and KeyFor Checkers are not suppressed
• @SuppressWarnings("keyfor") suppresses warnings from the KeyFor Checker only, warnings from the Nullness and Initialization Checkers are not suppressed

See Also:

• KeyForSubchecker
• InitializationChecker
• NullnessNoInitSubchecker

See the Checker Framework Manual:

Nullness Checker

Nested Class Summary

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

SourceChecker.CheckerMessage

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	LINT_DEFAULT_NOINITFORMONOTONICNONNULL	Default for LINT_NOINITFORMONOTONICNONNULL.
static final boolean	LINT_DEFAULT_PERMITCLEARPROPERTY	Default for LINT_PERMITCLEARPROPERTY.
static final boolean	LINT_DEFAULT_REDUNDANTNULLCOMPARISON	Default for LINT_REDUNDANTNULLCOMPARISON.
static final boolean	LINT_DEFAULT_TRUSTARRAYLENZERO	Default for LINT_TRUSTARRAYLENZERO.
static final String	LINT_NOINITFORMONOTONICNONNULL	Should we be strict about initialization of MonotonicNonNull variables?
static final String	LINT_PERMITCLEARPROPERTY	If true, client code may clear system properties.
static final String	LINT_REDUNDANTNULLCOMPARISON	Warn about redundant comparisons of an expression with null, if the expression is known to be non-null.
static final String	LINT_TRUSTARRAYLENZERO	Should the Nullness Checker unsoundly trust @ArrayLen(0) annotations to improve handling of Collection.toArray() by CollectionToArrayHeuristics?

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

baseTypeCheckerClassArray, ultimateParentChecker

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

activeOptions, currentRoot, DETAILS_SEPARATOR, elements, elementsWithSuppressedWarnings, immediateSubcheckers, javacErrored, messager, messagesProperties, messageStore, MSGS_FILE, OPTION_SEPARATOR, parentChecker, subcheckers, supportedOptions, SUPPRESS_ALL_MESSAGE_KEY, SUPPRESS_ALL_PREFIX, suppressWarningsPrefixesOfSubcheckers, treePathCacher, trees, types, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
NullnessChecker()	Default constructor for NullnessChecker.

Method Summary

Modifier and Type	Method	Description
boolean	checkPrimitives()	Whether to check primitives for initialization.
NavigableSet<String>	getSuppressWarningsPrefixes()	Returns a modifiable set of lower-case strings that are prefixes for SuppressWarnings strings.
Class<? extends BaseTypeChecker>	getTargetCheckerClass()	The checker for the target type system for which to check initialization.

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

createSourceVisitor, getAllFields, getImmediateSubcheckerClasses, getTypeFactory, getUpstreamCheckerNames, messageKeyMatches

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

createSourceVisitorPublic, createSupportedLintOptions, getAnnotationProvider, getTypeFactoryOfSubcheckerOrNull, getUltimateParentChecker, getVisitor, invokeConstructorFor, processErrorMessageArg, shouldAddShutdownHook, shutdownHook

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

expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getExtraStubFiles, getLintOption, getLintOption, getMessagesProperties, getOption, getOption, getOptionConfiguration, getOptions, getOptionsNoSubcheckers, getParentChecker, getPathToCompilationUnit, getProcessingEnvironment, getProperties, getRelatedClassName, getStandardSuppressWarningsPrefixes, getStringsOption, getStringsOption, getSubchecker, getSubCheckerIndex, getSubcheckers, getSupportedAnnotationTypes, getSupportedLintOptions, getSupportedOptions, getSupportedSourceVersion, getSuppressWarningsPrefixesOfSubcheckers, getTreePathCacher, getTreeUtils, getTypeUtils, getWarningMessagePrefix, hasOption, hasOptionNoSubcheckers, init, initChecker, instantiateSubcheckers, message, message, printOrStoreMessage, printOrStoreMessage, printStats, printStoredMessages, report, reportError, reportWarning, setLintOption, setParentChecker, setRoot, shouldResolveReflection, shouldSkipDefs, shouldSkipDefs, shouldSkipDefs, shouldSkipFiles, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, suppressWarningsString, typeProcess, typeProcessingOver, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions, 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

Field Details

LINT_NOINITFORMONOTONICNONNULL

public static final 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 String LINT_REDUNDANTNULLCOMPARISON

Warn about redundant comparisons of an expression with null, if the expression 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

LINT_TRUSTARRAYLENZERO

public static final String LINT_TRUSTARRAYLENZERO

Should the Nullness Checker unsoundly trust @ArrayLen(0) annotations to improve handling of Collection.toArray() by CollectionToArrayHeuristics?

See Also:

• Constant Field Values

LINT_DEFAULT_TRUSTARRAYLENZERO

public static final boolean LINT_DEFAULT_TRUSTARRAYLENZERO

Default for LINT_TRUSTARRAYLENZERO.

See Also:

• Constant Field Values

LINT_PERMITCLEARPROPERTY

public static final String LINT_PERMITCLEARPROPERTY

If true, client code may clear system properties. If false (the default), some calls to System.getProperty are refined to return @NonNull.

See Also:

• Constant Field Values

LINT_DEFAULT_PERMITCLEARPROPERTY

public static final boolean LINT_DEFAULT_PERMITCLEARPROPERTY

Default for LINT_PERMITCLEARPROPERTY.

See Also:

• Constant Field Values

Constructor Details

NullnessChecker

public NullnessChecker()

Default constructor for NullnessChecker.

Method Details

checkPrimitives

public boolean checkPrimitives()

Description copied from class: InitializationChecker

Whether to check primitives for initialization.

Specified by:

checkPrimitives in class InitializationChecker

Returns:

whether to check primitives for initialization

getTargetCheckerClass

public Class<? extends BaseTypeChecker> getTargetCheckerClass()

Description copied from class: InitializationChecker

The checker for the target type system for which to check initialization.

Specified by:

getTargetCheckerClass in class InitializationChecker

Returns:

the checker for the target type system.

getSuppressWarningsPrefixes

public NavigableSet<String> getSuppressWarningsPrefixes()

Description copied from class: SourceChecker

Returns a modifiable set of lower-case strings that are prefixes for SuppressWarnings strings.

The collection must not be empty and must not contain only SourceChecker.SUPPRESS_ALL_PREFIX.

Overrides:

getSuppressWarningsPrefixes in class InitializationChecker

Returns:

non-empty modifiable set of lower-case prefixes for SuppressWarnings strings