Package org.checkerframework.checker.modifiability

Class ModifiabilityChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.framework.source.AggregateChecker

org.checkerframework.checker.modifiability.ModifiabilityChecker

All Implemented Interfaces:

Processor, OptionConfiguration

public class ModifiabilityChecker
extends AggregateChecker

A type-checker that warns, at compile time, if a program might throw UnsupportedOperationException at run time due to calling a mutating method on a collection.

This is an aggregate checker that runs independent sub-checkers, one for each modifiability capability and one for iterator modifiability preservation:

• GrowChecker checks grow operations (e.g., add, addAll)
• SeqGrowChecker checks sequenced grow operations (e.g., addFirst, addLast)
• ShrinkChecker checks shrink operations (e.g., remove, clear)
• ReplaceChecker checks replace operations (e.g., set, replaceAll)
• IteratorChecker checks whether iterators preserve receiver modifiability

See the Checker Framework Manual:

Modifiability Checker

Nested Class Summary

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

SourceChecker.CheckerMessage

Field Summary

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_PREFIX, suppressWarningsPrefixesOfSubcheckers, treePathCacher, trees, types, upstreamCheckerNames, useAllcheckersPrefix, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
ModifiabilityChecker()	Creates a ModifiabilityChecker.

Method Summary

Modifier and Type	Method	Description
protected SourceVisitor<?,?>	createSourceVisitor()	Provides the SourceVisitor that the checker should use to scan input source trees.
protected Collection<Class<? extends SourceChecker>>	getSupportedCheckers()	Returns the list of independent subcheckers to be run together.

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

getImmediateSubcheckerClasses

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

createSupportedLintOptions, expandCFOptions, fullMessageOf, getAnnotationProvider, 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, getSuppressWarningsPrefixes, getSuppressWarningsPrefixesOfSubcheckers, getTreePathCacher, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, getVisitor, hasOption, hasOptionNoSubcheckers, init, initChecker, instantiateSubcheckers, message, message, messageKeyMatches, printOrStoreMessage, printOrStoreMessage, printStats, printStoredMessages, processErrorMessageArg, report, reportError, reportOnce, reportWarning, setLintOption, setParentChecker, setRoot, shouldAddShutdownHook, shouldResolveReflection, shouldSkipDefs, shouldSkipDefs, shouldSkipDefs, shouldSkipFiles, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, shutdownHook, 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

Constructor Details

ModifiabilityChecker

public ModifiabilityChecker()

Creates a ModifiabilityChecker.

Method Details

getSupportedCheckers

protected Collection<Class<? extends SourceChecker>> getSupportedCheckers()

Description copied from class: AggregateChecker

Returns the list of independent subcheckers to be run together. An aggregate checker overrides this method to indicate its immediate subcheckers.

Specified by:

getSupportedCheckers in class AggregateChecker

Returns:

the list of immediate subcheckers checkers to be run

createSourceVisitor

protected SourceVisitor<?,?> createSourceVisitor()

Description copied from class: SourceChecker

Provides the SourceVisitor that the checker should use to scan input source trees.

Overrides:

createSourceVisitor in class AggregateChecker

Returns:

a SourceVisitor to use to scan source trees