org.alfresco.service.cmr.i18n

Interface MessageLookup

All Known Subinterfaces:

DictionaryService

All Known Implementing Classes:

DictionaryComponent, FilteredDictionaryComponent, StaticMessageLookup

@AlfrescoPublicApi
public interface MessageLookup

An object providing basic message lookup facilities. May (or may not) be directly conntect to resource bundles.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getMessage(java.lang.String messageKey) Get message from registered resource bundle.
java.lang.String	getMessage(java.lang.String messageKey, java.util.Locale locale) Get a localised message string
java.lang.String	getMessage(java.lang.String messageKey, java.util.Locale locale, java.lang.Object[] params) Get a localised message string, parameterized using standard MessageFormatter.
java.lang.String	getMessage(java.lang.String messageKey, java.lang.Object[] params) Get a localised message string, parameterized using standard MessageFormatter.

Method Detail

getMessage

@NotAuditable
java.lang.String getMessage(java.lang.String messageKey)

Get message from registered resource bundle.

Parameters:

messageKey - message key

Returns:

localised message string, null if not found

getMessage

@NotAuditable
java.lang.String getMessage(java.lang.String messageKey,
                                       java.util.Locale locale)

Get a localised message string

Parameters:

messageKey - the message key

locale - override the current locale

Returns:

the localised message string, null if not found

getMessage

@NotAuditable
java.lang.String getMessage(java.lang.String messageKey,
                                       java.lang.Object[] params)

Get a localised message string, parameterized using standard MessageFormatter.

Parameters:

messageKey - message key

params - format parameters

Returns:

the localised string, null if not found

getMessage

@NotAuditable
java.lang.String getMessage(java.lang.String messageKey,
                                       java.util.Locale locale,
                                       java.lang.Object[] params)

Get a localised message string, parameterized using standard MessageFormatter.

Parameters:

messageKey - the message key

locale - override current locale

params - the localised message string

Returns:

the localised string, null if not found