Module uk.autores

Package uk.autores.handling

package uk.autores.handling

Use these types to extend the API.

Usage

1. Place resource files in the appropriate place for the chosen build system.
   • In Apache Maven this is typically under src/main/resources
2. Annotate a type or package declaration with ResourceFiles.
3. Set the resource file name in the ResourceFiles.value() array.
4. Specify a Handler for non-default behaviour.

Resource Handlers

provided handlers

Handler	Resources	Configuration	Description
AssertResourceExists	any files	(none)	Default Handler that validates resources exist.
GenerateByteArraysFromFiles	any files	CfgVisibility CfgStrategy	Generates classes with a method that return a resource as a byte array.
GenerateConstantsFromProperties	Properties files	CfgVisibility	Generates classes containing String constants of the keys in a properties file.
GenerateInputStreamsFromFiles	any files	CfgVisibility CfgName	Generates a single class with methods for opening resource InputStreams.
GenerateMessagesFromProperties	Properties files	CfgVisibility CfgLocalize CfgMissingKey CfgFormat	Generates classes with methods for returning property values including support for localization and message formatting.
GenerateStringsFromText	text files	CfgVisibility CfgEncoding CfgStrategy	Generates classes with a method that return a resource as a string.

Related Packages

Package	Description
uk.autores	An annotation driven library for working with embedded resource files.
uk.autores.naming	Types for naming classes and their members during code generation.
uk.autores.repeat	Annotations in this package do not need to be referenced by API consumers - they are used automatically when an annotation is used more than once on package or type.

Class	Description
AssertResourceExists	A resource handler that does nothing but can be used to ensure a resource exists at compile time.
CfgEncoding	"encoding": encoding of consumed text files.
CfgFormat	"format": whether to generate format methods.
CfgIncompatibleFormat	"incompatible-format": how to report incompatible format strings in localized Properties resources.
CfgLocalize	"localize": whether to search for localized resources.
CfgMissingKey	"missing-key": how to report missing keys in localized Properties resources.
CfgName	"name": generated class name.
CfgStrategy	"strategy": how to consume resources.
CfgVisibility	"visibility": set to "public" to generate public instead of package visible artefacts.
Config	Config item derived from ResourceFiles.config().
ConfigDef	Defines the configuration supported by a Handler.
Context	Context information for processing resource files.
Context.Builder	Implementation of the builder pattern for Context.
GenerateByteArraysFromFiles	Handler that, for each resource, generates a class with a name derived from the resource name using Namer.simplifyResourceName(String) and Namer.nameType(String).
GenerateConstantsFromProperties	Use this code generation Handler to prevent misspelled keys with ResourceBundle.
GenerateInputStreamsFromFiles	Handler that, for each resource, generates a static method with a name derived from the resource name using Namer.simplifyResourceName(String) and Namer.nameMember(String).
GenerateMessagesFromProperties	Handler that generates message classes from Properties files using Locales to match localized strings and MessageFormat to create typed method signatures.
GenerateStringsFromText	Handler that generates classes that returns file contents as Strings.
Handler	Processes resources from the class path.
Pkg	Character representation of a Java package.
Resource	A representation of the annotated resource.
Resource.ResourceOpener	For retrieving resource contents.
ResourceFiles	Indicates resources that are to be processed at compile time.
ResourceFiles.Cfg	Configuration option.
ResourceFiling	Utility type for working with Filer.