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:

javax.annotation.processing.Processor, org.checkerframework.common.basetype.BaseTypeContext, org.checkerframework.framework.util.BaseContext, org.checkerframework.framework.util.CFContext, org.checkerframework.framework.util.OptionConfiguration, org.checkerframework.javacutil.ErrorHandler

@StubFiles(value="jdnc.astub")
 @SupportedOptions(value={"quals","qualDirs"})
public class FenumChecker
extends org.checkerframework.common.basetype.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

Nested Class Summary

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

org.checkerframework.framework.source.SourceChecker.CheckerError

Field Summary

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

currentRoot, DETAILS_SEPARATOR, elementsWithSuppressedWarnings, errsOnLastExit, messager, messages, MSGS_FILE, parentChecker, SUPPRESS_ALL_KEY, trees, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
FenumChecker()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getSuppressWarningsKeys() Copied from SubtypingChecker; cannot reuse it, because SubtypingChecker is final.

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

createSourceVisitor, getAnnotationProvider, getChecker, getContext, getImmediateSubcheckerClasses, getOptions, getSubchecker, getSupportedLintOptions, getSupportedOptions, getTypeFactory, getTypeFactoryOfSubchecker, getVisitor, initChecker, invokeConstructorFor, printMessage, processArg, shouldAddShutdownHook, shouldResolveReflection, shutdownHook, typeProcess, typeProcessingOver, warnUnneededSuppressions

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

addOptions, createSupportedLintOptions, errorAbort, errorAbort, expandCFOptions, formatStackTrace, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getLintOption, getLintOption, getMessages, getOption, getOption, getOptionConfiguration, getProcessingEnvironment, getProperties, getStandardSuppressWarningsKeys, getSupportedAnnotationTypes, getSupportedSourceVersion, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, init, message, printStats, report, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, treeToFilePositionString, typeProcessingStart, userErrorAbort, useUncheckedCodeDefault, warnUnneedSuppressions

Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor

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

getElementUtils, getOptionConfiguration, getProcessingEnvironment, getTreeUtils, getTypeUtils

Constructor Detail

FenumChecker

public FenumChecker()

Method Detail

getSuppressWarningsKeys

public java.util.Collection<java.lang.String> getSuppressWarningsKeys()

Copied from SubtypingChecker; cannot reuse it, because SubtypingChecker is final.

Overrides:

getSuppressWarningsKeys in class org.checkerframework.framework.source.SourceChecker

See Also:

SubtypingChecker.getSuppressWarningsKeys()