io.chapp.commons.locale

Annotation Type Bundle

public @interface Bundle

This annotation represents the configuration of generated resource bundles using ChappIO Commons Locale. Place this annotation on any class (generally on the main class of your application) to instruct the compiler to generate a statically accessible class that allows you to retrieve your messages.

This annotation activates the following behaviors:

• It generates a class in the target chosen in the className parameter
• It validates all locales defined in requiredLocales for completeness and parameter consistency

The generated class will contain a static getter for every defined message. It will accept parameters based on the parameters defined in the message itself.

Full documentation can be found on: ChappIO Commons GitHub

Author:

Thomas Biesaart

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	bundleName The base name of the resource bundle.
String	className The fully qualified path to the accessor class.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	requiredLocales List the validated locales.

Element Detail

bundleName

public abstract String bundleName

The base name of the resource bundle. If you create your resource bundle at /org/example/logging.properties then the base name will be org/example/logging.properties. Note the missing / from the name.

Returns:

the base bundle name

className

public abstract String className

The fully qualified path to the accessor class. This is where the compiler will generate the static class from which you can fetch your messages. This must be a non-existing class or otherwise compilation will fail.

Returns:

the target qualified task name

requiredLocales

public abstract String[] requiredLocales

List the validated locales. All locales listed in this array must:

• Implement the all the messages that are implemented by the default locale
• Adhere to the same parameter types as the default locale

Returns:

all required locales

Default:

{}