com.sap.cds.feature.localization

Interface LocalizedMessageProvider

All Superinterfaces:

Feature

All Known Implementing Classes:

DefaultLocalizedMessageProvider

public interface LocalizedMessageProvider
extends Feature

A LocalizedMessageProvider is capable to build localized messages based on string formats in the application's resource bundles.

Field Summary

Fields

Modifier and Type	Field and Description
static LocalizedMessageProvider	INSTANCE Gives access to the active DefaultLocalizedMessageProvider

Method Summary

Modifier and Type	Method and Description
String	getMessage(String code, Object[] args, Locale locale) Returns the localized message for the given code, arguments and locale if existing, null otherwise.

Methods inherited from interface com.sap.cds.feature.Feature

getFeatureName, isActiveFeature

Field Detail

INSTANCE

static final LocalizedMessageProvider INSTANCE

Gives access to the active DefaultLocalizedMessageProvider

Method Detail

getMessage

String getMessage(String code,
                  Object[] args,
                  Locale locale)

Returns the localized message for the given code, arguments and locale if existing, null otherwise. The method does not throw and returns code in case of any errors.

Parameters:

code - The code which is used as key for the format string in the defined bundles.

args - The argument objects for the format string

locale - The locale to be used. If no locale is set the default locale is taken.

Returns:

The localized message or null if the code is not resolvable.