All Superinterfaces:

Localizable, LocalizableObject
```
public interface NlsMessage
extends 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 String LOCALIZATION_FAILURE_PREFIX
The prefix appended to the message if the localization (translation) failed.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default Object`	`getArgument(String key)`	This method gets the language independent argument value for the given `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 Detail
  - 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 Detail
  - 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)
```
    Description copied from interface: Localizable
    
    This method gets the language independent argument value for the given key.
    
    Specified by:
    
    getArgument in interface Localizable
    
    Parameters:
    
    key - is the name of the requested argument.
    
    Returns:
    
    the argument value for the given key or null if NOT defined.
    
    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 Localizable
    
    Parameters:
    
    locale - is the locale to translate to.
    
    Returns:
    
    the localized message.
    
    See Also:
    
    io.github.mmm.nls
  - getDescriptor
```
NlsMessageDescriptor getDescriptor()
```
    Returns:
    
    the NlsMessageDescriptor.

Interface NlsMessage

Field Summary

Method Summary

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

Field Detail

LOCALIZATION_FAILURE_PREFIX

Method Detail

getInternationalizedMessage

getArgument

getArguments

getLocalizedMessage

getDescriptor