checkers.propkey

Class PropertyKeyChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

checkers.source.AbstractTypeProcessor

checkers.source.SourceChecker

checkers.basetype.BaseTypeChecker

checkers.propkey.PropertyKeyChecker

All Implemented Interfaces:

Processor

Direct Known Subclasses:

CompilerMessagesChecker, LocalizableKeyChecker

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 and compilermsgs checkers. 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 a colon ":".
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.

Nested Class Summary

Nested classes/interfaces inherited from class checkers.source.SourceChecker

SourceChecker.CheckerError

Field Summary

Fields inherited from class checkers.source.SourceChecker

currentPath, currentRoot, messager, messages, trees

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
PropertyKeyChecker()

Method Summary

Methods

Modifier and Type	Method and Description
GraphQualifierHierarchy	createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory) Factory method to easily change what QualifierHierarchy is created.
Set<@ReadOnly String>	getLookupKeys() Returns a set of the valid keys that can be used.
void	initChecker() Initialize the checker.

Methods inherited from class checkers.basetype.BaseTypeChecker

createFactory, createQualifierHierarchy, createQualifierHierarchyFactory, createSourceVisitor, createSupportedTypeQualifiers, createTypeHierarchy, getQualifierHierarchy, getSupportedLintOptions, getSupportedTypeQualifiers, getTypeHierarchy, invokeConstructorFor

Methods inherited from class checkers.source.SourceChecker

errorAbort, errorAbort, formatStackTrace, fullMessageOf, getLintOption, getLintOption, getMessages, getProcessingEnvironment, getProperties, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, getSuppressWarningsKey, message, report, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, typeProcess, typeProcessingStart

Methods inherited from class checkers.source.AbstractTypeProcessor

init, process, typeProcessingOver

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyKeyChecker

public PropertyKeyChecker()

Method Detail

initChecker

public void initChecker()

Description copied from class: SourceChecker

Initialize the checker.

Overrides:

initChecker in class BaseTypeChecker

See Also:

AbstractProcessor.init(ProcessingEnvironment)

getLookupKeys

public Set<@ReadOnly String> getLookupKeys()

Returns a set of the valid keys that can be used.

createQualifierHierarchy

public GraphQualifierHierarchy createQualifierHierarchy(MultiGraphQualifierHierarchy.MultiGraphFactory factory)

Description copied from class: BaseTypeChecker

Factory method to easily change what QualifierHierarchy is created. Needs to be public only because the GraphFactory must be able to call this method. No external use of this method is necessary.

Overrides:

createQualifierHierarchy in class BaseTypeChecker