UnitsChecker (checker-framework 3.39.0-eisop1 API)

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, OptionConfiguration
```
@SupportedOptions({"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

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

UnitsChecker()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.NavigableSet<java.lang.String>`	`getSuppressWarningsPrefixes()`	Returns a modifiable set of lower-case strings that are prefixes for SuppressWarnings strings.

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 Detail
  - UnitsChecker
```
public UnitsChecker()
```
- Method Detail
  - getSuppressWarningsPrefixes
```
public java.util.NavigableSet<java.lang.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