Package org.checkerframework.checker.mustcall

Class MustCallChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.checker.mustcall.MustCallChecker

All Implemented Interfaces:

Processor, OptionConfiguration

Direct Known Subclasses:

MustCallNoCreatesMustCallForChecker

@StubFiles({"IOUtils.astub","JavaEE.astub","JdkCompiler.astub","Reflection.astub","SocketCreatesMustCallFor.astub"})
@SupportedOptions({"noCreatesMustCallFor","noLightweightOwnership","noResourceAliases"})
public class MustCallChecker
extends BaseTypeChecker

This typechecker ensures that @MustCall annotations are consistent with one another. The Resource Leak Checker verifies that the given methods are actually called.

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 String	NO_CREATES_MUSTCALLFOR	Disables @CreatesMustCallFor support.
static final String	NO_LIGHTWEIGHT_OWNERSHIP	Disables @Owning/@NotOwning support.
static final String	NO_RESOURCE_ALIASES	Disables @MustCallAlias support.

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
MustCallChecker()

Method Summary

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

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

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

expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getExtraStubFiles, getImmediateSubcheckerClasses, 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, hasOption, hasOptionNoSubcheckers, init, initChecker, instantiateSubcheckers, message, message, messageKeyMatches, printOrStoreMessage, printOrStoreMessage, printStats, printStoredMessages, report, reportError, reportWarning, setLintOption, setParentChecker, setRoot, shouldResolveReflection, shouldSkipDefs, shouldSkipDefs, shouldSkipDefs, shouldSkipFiles, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, 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

NO_CREATES_MUSTCALLFOR

public static final String NO_CREATES_MUSTCALLFOR

Disables @CreatesMustCallFor support. Not of interest to most users. Not documented in the manual.

See Also:

• Constant Field Values

NO_LIGHTWEIGHT_OWNERSHIP

public static final String NO_LIGHTWEIGHT_OWNERSHIP

Disables @Owning/@NotOwning support. Not of interest to most users. Not documented in the manual.

See Also:

• Constant Field Values

NO_RESOURCE_ALIASES

public static final String NO_RESOURCE_ALIASES

Disables @MustCallAlias support. Not of interest to most users. Not documented in the manual.

See Also:

• Constant Field Values

Constructor Details

MustCallChecker

public MustCallChecker()