Package org.checkerframework.checker.propkey

Class PropertyKeyChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.checkerframework.javacutil.AbstractTypeProcessor

org.checkerframework.framework.source.SourceChecker

org.checkerframework.common.basetype.BaseTypeChecker

org.checkerframework.checker.propkey.PropertyKeyChecker

All Implemented Interfaces:

Processor, OptionConfiguration

Direct Known Subclasses:

CompilerMessagesChecker, LocalizableKeyChecker

@SupportedOptions({"propfiles","bundlenames"})
@RelevantJavaTypes(java.lang.CharSequence.class)
public class PropertyKeyChecker
extends BaseTypeChecker

A type-checker that checks that only valid keys are used to access property files and resource bundles. Subclasses can specialize this class for the different uses of property files, for examples see the I18n Checker and Compiler Messages Checker.

Currently, the checker supports two methods to check:

1. Property files: A common method for localization using a property file, mapping the keys to values. Programmers pass the property file locations via propfiles option (e.g. -Apropfiles=/path/to/messages.properties), separating multiple files by File.pathSeparator.
2. ResourceBundle: Programmers pass the baseName name of the bundle via bundlename (e.g. -Abundlename=MyResource. The checker uses the resource associated with the default Locale in the compilation system.

See the Checker Framework Manual:

Property File 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, trees, types, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitor

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
PropertyKeyChecker()

Method Summary

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

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

PropertyKeyChecker

public PropertyKeyChecker()