Package nz.org.riskscape.engine.i18n

Interface MessageSource

public interface MessageSource

Strategy interface for resolving messages, with support for the parameterization and internationalization of such messages.

Inspired/Copied from: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/MessageSource.html

Method Summary

Modifier and Type	Method	Description
String	getMessage(String code, Object... args)	Same as getMessage(java.lang.String, java.lang.Object[], java.lang.String, java.util.Locale) with Locale.getDefault() and null default.
String	getMessage(String code, Object[] args, String defaultMessage, Locale locale)	Try to resolve the message.
String	getMessage(String code, Object[] args, Locale locale)	Same as getMessage(java.lang.String, java.lang.Object[], java.lang.String, java.util.Locale) with null default.
String	getMessage(MessageKey resolvable)	Same as getMessage(MessageKey, java.util.Locale) for Locale.getDefault().
String	getMessage(MessageKey resolvable, Locale locale)	Try to resolve the resolvable, returning MessageKey.getDefaultMessage() if lookup fails.
<T extends MessageFactory> T	getMessageFactory(Class<T> factory, Locale locale)	Returns an implementation of the given factory class that resolves messages against the given locale and message source.

Method Details

getMessage

String getMessage(MessageKey resolvable)

Same as getMessage(MessageKey, java.util.Locale) for Locale.getDefault().

Parameters:

resolvable -

Returns:

String

getMessage

String getMessage(MessageKey resolvable,
 Locale locale)

Try to resolve the resolvable, returning MessageKey.getDefaultMessage() if lookup fails.

All of the codes returned by MessageKey.getCode() are attempted in order until either: - one resolves to a message with is returned - none resolve to a message in which case the default is returned.

Parameters:

resolvable -

locale -

Returns:

the resolved message or default if lookup fails

getMessage

String getMessage(String code,
 Object... args)

Same as getMessage(java.lang.String, java.lang.Object[], java.lang.String, java.util.Locale) with Locale.getDefault() and null default.

Parameters:

code -

args -

Returns:

the resolved message or null if lookup fails

getMessage

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

Same as getMessage(java.lang.String, java.lang.Object[], java.lang.String, java.util.Locale) with null default.

Parameters:

code -

args -

locale -

Returns:

the resolved message or null if lookup fails

getMessage

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

Try to resolve the message. Return default message if no message was found.

Parameters:

code - identifying message

args - an array of arguments for MessageFormat replacements

defaultMessage - a default message to return if lookup fails

locale - the locale in which do to the lookup

Returns:

the resolved message or default if lookup fails

getMessageFactory

<T extends MessageFactory> T getMessageFactory(Class<T> factory,
 Locale locale)

Returns an implementation of the given factory class that resolves messages against the given locale and message source.