org.checkerframework.checker.units

Class UnitsChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.checker.units.UnitsChecker

All Implemented Interfaces:

javax.annotation.processing.Processor, BaseTypeContext, BaseContext, CFContext, OptionConfiguration, ErrorHandler

@SupportedOptions(value={"units","unitsDirs"})
public class UnitsChecker
extends BaseTypeChecker

Units Checker main class.

Supports "units" option to add support for additional individually named and externally defined units, and "unitsDirs" option to add support for directories of externally defined units. Directories must be well-formed paths from file system root, separated by colon (:) between each directory.

See the Checker Framework Manual:

Units Checker

Nested Class Summary

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

SourceChecker.CheckerError

Field Summary

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

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

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
UnitsChecker()

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

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

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

UnitsChecker

public UnitsChecker()

Method Detail

getSuppressWarningsKeys

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

Copied from SubtypingChecker; cannot reuse it, because SubtypingChecker is final. TODO: SubtypingChecker might also want to always call super.

Overrides:

getSuppressWarningsKeys in class SourceChecker

Returns:

string keys that a checker honors for suppressing warnings and errors that it issues. Each such key suppresses all warnings issued by the checker.

See Also:

SuppressWarningsKeys