info.magnolia.i18nsystem

Class TranslationServiceImpl

java.lang.Object

info.magnolia.i18nsystem.TranslationServiceImpl

All Implemented Interfaces:

TranslationService

@Singleton
public class TranslationServiceImpl
extends Object
implements TranslationService

A TranslationService which relies on a "global" message bundle, as loaded per DefaultMessageBundlesLoader. Each given key is looked up in the given locale, then in less specific locales, then in the fallback locale. That is, if [a, b, c] are passed as keys, with country-specific Locale such as de_CH, and "b" is defined in the de_CH message bundle, it will be returned, even if "a" is defined in the less specific "de" Locale. When a basename is explicitly specified, it however uses MessagesManager to look the keys up, falls back to the default bundle of MessagesManager, then finally falls back on its own global message bundle.

Constructor Summary

Constructors

Constructor and Description
TranslationServiceImpl() Deprecated. since 5.4.4. Use #TranslationServiceImpl(javax.inject.Provider, javax.inject.Provider) instead.
TranslationServiceImpl(javax.inject.Provider<I18nModule> i18nModuleProvider) Deprecated. since 5.4.5. Use #TranslationServiceImpl(javax.inject.Provider, javax.inject.Provider) instead.
TranslationServiceImpl(javax.inject.Provider<I18nModule> i18nModuleProvider, info.magnolia.objectfactory.ComponentProvider componentProvider, info.magnolia.resourceloader.ResourceOrigin resourceOrigin, info.magnolia.event.EventBus systemEventBus) Deprecated. since 5.5.2. Use #TranslationServiceImpl(javax.inject.Provider, javax.inject.Provider) instead.
TranslationServiceImpl(javax.inject.Provider<I18nModule> i18nModuleProvider, javax.inject.Provider<DefaultMessageBundlesLoader> defaultMessageBundlesLoaderProvider)

Method Summary

Modifier and Type	Method and Description
protected String	handleUnknownKey(Locale locale, String basename, String[] keys)
void	reloadMessageBundles() Deprecated. since 5.5.2. Reload message bundles in DefaultMessageBundlesLoader directly.
protected DefaultMessageBundlesLoader	setupMessageBundles() Deprecated. since 5.5.2. Use defaultMessageBundlesLoaderProvider directly or setup message bundles in DefaultMessageBundlesLoader.
String	translate(LocaleProvider localeProvider, String[] keys)
String	translate(LocaleProvider localeProvider, String[] keys, String fallback)
String	translate(LocaleProvider localeProvider, String basename, String[] keys)

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslationServiceImpl

@Inject
public TranslationServiceImpl(javax.inject.Provider<I18nModule> i18nModuleProvider,
                                      javax.inject.Provider<DefaultMessageBundlesLoader> defaultMessageBundlesLoaderProvider)

TranslationServiceImpl

@Deprecated
public TranslationServiceImpl(javax.inject.Provider<I18nModule> i18nModuleProvider,
                                          info.magnolia.objectfactory.ComponentProvider componentProvider,
                                          info.magnolia.resourceloader.ResourceOrigin resourceOrigin,
                                          @Named(value="system")
                                          info.magnolia.event.EventBus systemEventBus)

Deprecated. since 5.5.2. Use #TranslationServiceImpl(javax.inject.Provider, javax.inject.Provider) instead.

TranslationServiceImpl

@Deprecated
public TranslationServiceImpl(javax.inject.Provider<I18nModule> i18nModuleProvider)

Deprecated. since 5.4.5. Use #TranslationServiceImpl(javax.inject.Provider, javax.inject.Provider) instead.

TranslationServiceImpl

@Deprecated
public TranslationServiceImpl()

Deprecated. since 5.4.4. Use #TranslationServiceImpl(javax.inject.Provider, javax.inject.Provider) instead.

Method Detail

setupMessageBundles

@Deprecated
protected DefaultMessageBundlesLoader setupMessageBundles()

Deprecated. since 5.5.2. Use defaultMessageBundlesLoaderProvider directly or setup message bundles in DefaultMessageBundlesLoader.

translate

public String translate(LocaleProvider localeProvider,
                        String[] keys)

Specified by:

translate in interface TranslationService

translate

public String translate(LocaleProvider localeProvider,
                        String[] keys,
                        String fallback)

Specified by:

translate in interface TranslationService

translate

public String translate(LocaleProvider localeProvider,
                        String basename,
                        String[] keys)

Specified by:

translate in interface TranslationService

basename - Usage of a basename is deprecated since 5.1. This method is here to allow backwards compatibility.

handleUnknownKey

protected String handleUnknownKey(Locale locale,
                                  String basename,
                                  String[] keys)

reloadMessageBundles

@Deprecated
public void reloadMessageBundles()

Deprecated. since 5.5.2. Reload message bundles in DefaultMessageBundlesLoader directly.

Description copied from interface: TranslationService

Allows to reload all the message bundles - useful in development.

Specified by:

reloadMessageBundles in interface TranslationService