Package org.checkerframework.common.subtyping

Class SubtypingChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.common.subtyping.SubtypingChecker

All Implemented Interfaces:

Processor, OptionConfiguration

@SupportedOptions({"quals","qualDirs"})
public final class SubtypingChecker
extends BaseTypeChecker

A checker for type qualifier systems that only checks subtyping relationships.

The annotation(s) are specified on the command line, using an annotation processor argument:

• -Aquals: specifies the annotations in the qualifier hierarchy (as a comma-separated list of fully-qualified annotation names with no spaces in between). Only the annotations for one qualified subtype hierarchy can be passed.

See the Checker Framework Manual:

Subtying Checker

Field Summary

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

currentRoot, DETAILS_SEPARATOR, elements, elementsWithSuppressedWarnings, errsOnLastExit, javacErrored, messager, messagesProperties, MSGS_FILE, OPTION_SEPARATOR, parentChecker, SUPPRESS_ALL_MESSAGE_KEY, SUPPRESS_ALL_PREFIX, trees, types, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
SubtypingChecker()

Method Summary

Modifier and Type	Method	Description
NavigableSet<String>	getSuppressWarningsPrefixes()	Returns a modifiable set of lower-case strings that are prefixes for SuppressWarnings strings.
static NavigableSet<String>	getSuppressWarningsPrefixes(SourceVisitor<?,?> visitor, NavigableSet<String> superSupportedTypeQualifiers)	Compute SuppressWarnings prefixes, based on the names of all the qualifiers.

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

createSourceVisitor, createSourceVisitorPublic, getAnnotationProvider, getExtraStubFiles, getImmediateSubcheckerClasses, getOptions, getOptionsNoSubcheckers, getRelatedClassName, getSubchecker, getSubcheckers, getSupportedLintOptions, getSupportedOptions, getSuppressWarningsPrefixesOfSubcheckers, getTreePathCacher, getTypeFactory, getTypeFactoryOfSubcheckerOrNull, getUltimateParentChecker, getVisitor, hasOptionNoSubcheckers, initChecker, invokeConstructorFor, printOrStoreMessage, processErrorMessageArg, setRoot, shouldAddShutdownHook, shouldResolveReflection, shutdownHook, typeProcess, typeProcessingOver, warnUnneededSuppressions

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

addOptions, createSupportedLintOptions, expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getLintOption, getLintOption, getMessagesProperties, getOption, getOption, getOptionConfiguration, getParentChecker, getPathToCompilationUnit, getProcessingEnvironment, getProperties, getStandardSuppressWarningsPrefixes, getStringsOption, getStringsOption, getSupportedAnnotationTypes, getSupportedSourceVersion, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, init, message, message, messageKeyMatches, printOrStoreMessage, printStats, report, reportError, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipFiles, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, typeProcessingStart, useConservativeDefault, 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

SubtypingChecker

public SubtypingChecker()

Method Details

getSuppressWarningsPrefixes

public static NavigableSet<String> getSuppressWarningsPrefixes(SourceVisitor<?,?> visitor,
 NavigableSet<String> superSupportedTypeQualifiers)

Compute SuppressWarnings prefixes, based on the names of all the qualifiers.

Provided for the convenience of checkers that do not subclass SubtypingChecker (because it is final). Clients should call it like:

 SubtypingChecker.getSuppressWarningsPrefixes(this.visitor, super.getSuppressWarningsPrefixes());
 

Parameters:

visitor - the visitor

superSupportedTypeQualifiers - the result of super.getSuppressWarningsPrefixes(), as executed by checker

Returns:

SuppressWarnings prefixes, based on the names of all the qualifiers

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 SourceChecker

Returns:

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