Module io.github.mmm.nls

Package io.github.mmm.nls

Interface NlsMessage

All Superinterfaces:

io.github.mmm.base.i18n.Localizable, io.github.mmm.base.i18n.LocalizableObject

public interface NlsMessage
extends io.github.mmm.base.i18n.Localizable

This is the interface for an internationalized message. It stores an internationalized-message separated from language independent arguments. This approach ensures that the message is always available in the internationalized language (should be English) while it still allows to translate the message to a native language. For an introduction first read here
The format of the internationalized-message is similar to MessageFormat. This allows to migrate existing code from MessageFormat to NlsMessage easily. However, there are some advanced features available. While using numbers to identify the arguments is a maintenance-hell for large messages, this solution is using named arguments (keys) that should be self-explanatory. Further, there is also support for additional styles as well as Justification. See NlsVariable for the specification of the argument syntax.
To specify NlsMessages you create an NlsBundle per module. For the term internationalization usually the shortcut i18n is used.

See Also:

• NlsVariable
• NlsBundle
• NlsMessageFactory
• io.github.mmm.nls

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCALIZATION_FAILURE_PREFIX	The prefix appended to the message if the localization (translation) failed.

Fields inherited from interface io.github.mmm.base.i18n.Localizable

BUNDLE_PREFIX

Method Summary

Modifier and Type	Method	Description
default Object	getArgument(String key)
NlsArguments	getArguments()
NlsMessageDescriptor	getDescriptor()
String	getInternationalizedMessage()	This method gets the internationalized message what is the actual message template for the root locale without resolving its arguments.
default String	getLocalizedMessage(Locale locale)	This method gets the resolved and localized message. First it will translate the internationalized message to the given Locale.

Methods inherited from interface io.github.mmm.base.i18n.Localizable

getLocalizedMessage, getLocalizedMessage, getMessage, toLocalizable

Field Details

LOCALIZATION_FAILURE_PREFIX

static final String LOCALIZATION_FAILURE_PREFIX

The prefix appended to the message if the localization (translation) failed.

See Also:

• Constant Field Values

Method Details

getInternationalizedMessage

String getInternationalizedMessage()

This method gets the internationalized message what is the actual message template for the root locale without resolving its arguments.

Returns:

the message for internationalization (e.g. "Welcome {name}!").

See Also:

• NlsMessage
• getArguments()
• NlsVariable

getArgument

default Object getArgument(String key)

Specified by:

getArgument in interface io.github.mmm.base.i18n.Localizable

See Also:

• NlsArguments.get(String)
• NlsVariable

getArguments

NlsArguments getArguments()

Returns:

the dynamic NlsArguments to fill into the message after localization.

See Also:

• NlsArguments
• NlsVariable

getLocalizedMessage

default String getLocalizedMessage(Locale locale)

This method gets the resolved and localized message.
First it will translate the internationalized message to the given Locale. If this fails for whatever reason, the internationalized message is used as fallback.
Then this message gets resolved by replacing the variables with their according arguments.
Example:
We assume the internationalized message is "Welcome {name}!" and the argument with the key "name" has the value "Joelle". After translation to Locale.GERMAN the message may be "Willkommen {name}!". This results in the resolved message "Willkommen Joelle!". If the German localization was not present or has a syntax error, the root locale is used as fallback resulting in "Welcome Joelle!".

Specified by:

getLocalizedMessage in interface io.github.mmm.base.i18n.Localizable

See Also:

• io.github.mmm.nls

getDescriptor

NlsMessageDescriptor getDescriptor()

Returns:

the NlsMessageDescriptor.