sirius.kernel.nls

Class Babelfish

java.lang.Object

sirius.kernel.nls.Babelfish

public class Babelfish
extends Object

Internal translation engine used by NLS.

Loads all .properties files in the given Classpath which match the pattern name_lang.properties. Where name is any string (must not contain "_") and lang is a two letter language code.

See Also:

NLS

Field Summary

Fields

Modifier and Type	Field and Description
protected static Log	LOG Logs WARN messages if translations are inconsistent (override each other).

Constructor Summary

Constructors

Constructor and Description
Babelfish()

Method Summary

Modifier and Type	Method and Description
protected Translation	get(String property, String fallback, boolean create) Retrieves the Translation for the given property.
Stream<Translation>	getEntriesStartingWith(String key) Enumerates all translations which key starts with the given prefix
List<String>	getLoadedResourceBundles() Returns a list of all loaded resource bundles.
Stream<Translation>	getTranslations(String filter) Enumerates all translations matching the given filter.
protected void	init(Classpath classpath) Initializes the translation engine by using the given classpath.
protected void	reloadBundle(String name)
void	reportMissingTranslations() Throws an exception if any unknown translations where encountered so far.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Log LOG

Logs WARN messages if translations are inconsistent (override each other).

Constructor Detail

Babelfish

public Babelfish()

Method Detail

getTranslations

public Stream<Translation> getTranslations(@Nullable
                                           String filter)

Enumerates all translations matching the given filter.

Parameters:

filter - the filter to apply when enumerating translations. The given filter must occur in either the key or in one of the translations.

Returns:

a stream of all translations matching the given filter

getEntriesStartingWith

public Stream<Translation> getEntriesStartingWith(@Nonnull
                                                  String key)

Enumerates all translations which key starts with the given prefix

Parameters:

key - the prefix with which the key must start

Returns:

a stream of all translations matching the given filter

get

protected Translation get(@Nonnull
                          String property,
                          @Nullable
                          String fallback,
                          boolean create)

Retrieves the Translation for the given property.

If no matching entry is found, the given fallback is used. If still no match was found, either a new one is create (if create is true) or false otherwise.

Parameters:

property - the property key for which a translation is required

fallback - a fallback key, if no translation is found. May be null.

create - determines if a new Translation is created if non-existent

Returns:

a Translation for the given property or fallback. Returns null if no translation was found and create is false.

getLoadedResourceBundles

public List<String> getLoadedResourceBundles()

Returns a list of all loaded resource bundles.

Returns:

a list of all loaded resource bundles (.properties files)

init

protected void init(Classpath classpath)

Initializes the translation engine by using the given classpath.

Scans for all .properties files matching PROPERTIES_FILE and loads their contents.

Parameters:

classpath - the classpath used to discover all relevant properties files

reloadBundle

protected void reloadBundle(String name)

reportMissingTranslations

public void reportMissingTranslations()

Throws an exception if any unknown translations where encountered so far.

This is called by Sirius.stop() if the framework was initialized as test environment. The idea is to break unit-tests if unknown translations are encountered.

Throws:

HandledException - if unknown translations where detected.