Package org.checkerframework.checker.i18n

Class I18nChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.framework.source.AggregateChecker

org.checkerframework.checker.i18n.I18nChecker

All Implemented Interfaces:

Processor, OptionConfiguration

public class I18nChecker
extends AggregateChecker

A type-checker that enforces (and finds the violations of) two properties:

1. Only localized output gets emitted to the user
2. Only localizable keys (i.e. keys found in localizing resource bundles) get used as such.

See Also:

• I18nSubchecker
• LocalizableKeyChecker

See the Checker Framework Manual:

Internationalization Checker

Field Summary

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

checkers

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
I18nChecker()

Method Summary

Modifier and Type	Method	Description
protected Collection<Class<? extends SourceChecker>>	getSupportedCheckers()	Returns the list of supported checkers to be run together.

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

createSourceVisitor, getOptions, getSupportedLintOptions, getSupportedOptions, initChecker, setProcessingEnvironment, typeProcess, typeProcessingOver

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

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

I18nChecker

public I18nChecker()

Method Details

getSupportedCheckers

protected Collection<Class<? extends SourceChecker>> getSupportedCheckers()

Description copied from class: AggregateChecker

Returns the list of supported checkers to be run together. Subclasses need to override this method.

Specified by:

getSupportedCheckers in class AggregateChecker

Returns:

the list of checkers to be run