Package com.vaadin.flow.i18n

Class DefaultI18NProvider

java.lang.Object

com.vaadin.flow.i18n.DefaultI18NProvider

All Implemented Interfaces:

I18NProvider, Serializable

public class DefaultI18NProvider
extends Object
implements I18NProvider

Default i18n provider that will be initialized if custom I18NProvider is not available.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUNDLE_FILENAME
static final String	BUNDLE_FOLDER
static final String	BUNDLE_PREFIX

Constructor Summary

Constructors

Constructor	Description
DefaultI18NProvider(List<Locale> providedLocales)	Construct DefaultI18NProvider for a list of locales that we have translations for.
DefaultI18NProvider(List<Locale> providedLocales, ClassLoader classLoader)	Construct DefaultI18NProvider for a list of locales that we have translations for.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAllTranslations(Locale locale)	Retrieves all available translations.
List<Locale>	getProvidedLocales()	Get the locales that we have translations for.
String	getTranslation(String key, Locale locale, Object... params)	Get the translation for key with given locale.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.i18n.I18NProvider

getDefaultLocale, getTranslation, getTranslations

Field Details

BUNDLE_FOLDER

public static final String BUNDLE_FOLDER

See Also:

• Constant Field Values

BUNDLE_FILENAME

public static final String BUNDLE_FILENAME

See Also:

• Constant Field Values

BUNDLE_PREFIX

public static final String BUNDLE_PREFIX

See Also:

• Constant Field Values

Constructor Details

DefaultI18NProvider

public DefaultI18NProvider(List<Locale> providedLocales)

Construct DefaultI18NProvider for a list of locales that we have translations for.

Parameters:

providedLocales - List of locales. The first locale should be the default locale.

DefaultI18NProvider

public DefaultI18NProvider(List<Locale> providedLocales,
 ClassLoader classLoader)

Construct DefaultI18NProvider for a list of locales that we have translations for. Enables giving a specific classloader if needed.

Parameters:

providedLocales - List of locales. The first locale should be the default locale.

classLoader - ClassLoader to use for loading translation bundles.

Method Details

getProvidedLocales

public List<Locale> getProvidedLocales()

Description copied from interface: I18NProvider

Get the locales that we have translations for. The first locale should be the default locale.

Specified by:

getProvidedLocales in interface I18NProvider

Returns:

provided locales

getTranslation

public String getTranslation(String key,
 Locale locale,
 Object... params)

Description copied from interface: I18NProvider

Get the translation for key with given locale.

Note! For usability and catching missing translations implementation should never return a null, but an exception string e.g. '!{key}!'

Specified by:

getTranslation in interface I18NProvider

Parameters:

key - translation key

locale - locale to use

params - parameters used in translation string

Returns:

translation for key if found

getAllTranslations

public Map<String,String> getAllTranslations(Locale locale)

Description copied from interface: I18NProvider

Retrieves all available translations. This is currently used only by Hilla in development mode.

Specified by:

getAllTranslations in interface I18NProvider

Parameters:

locale - locale to use

Returns:

a map of all available translations (the default implementation just returns an empty map)