Package org.checkerframework.checker.fenum

Class FenumChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.checker.fenum.FenumChecker

All Implemented Interfaces:

Processor, OptionConfiguration

@StubFiles("jdnc.astub")
@SupportedOptions({"quals","qualDirs"})
public class FenumChecker
extends BaseTypeChecker

The main checker class for the Fake Enum Checker.

There are two options to distinguish different enumerators:

1. @Fenum("Name"): introduces a fake enumerator with the name "Name". Enumerators with different names are distinct. The default name is empty, but you are encouraged to use a unique name for your purpose.
2. Alternatively, you can specify the annotation to use with the -Aqual command line argument.

See the Checker Framework Manual:

Fake Enum 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, treePathCacher, trees, types, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
FenumChecker()

Method Summary

Modifier and Type	Method	Description
NavigableSet<String>	getSuppressWarningsPrefixes()	Returns a modifiable set of lower-case strings that are prefixes for SuppressWarnings strings.

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

createSourceVisitor, createSourceVisitorPublic, getAnnotationProvider, getExtraStubFiles, getImmediateSubcheckerClasses, getOptions, getOptionsNoSubcheckers, getRelatedClassName, getSubchecker, getSubcheckers, getSupportedLintOptions, getSupportedOptions, getSuppressWarningsPrefixesOfSubcheckers, 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, getTreePathCacher, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, getWarningMessagePrefix, hasOption, init, message, message, messageKeyMatches, printOrStoreMessage, printStats, report, reportError, reportWarning, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, 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

FenumChecker

public FenumChecker()

Method Details

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