Package ch.qos.cal10n

Class MessageConveyor

java.lang.Object

ch.qos.cal10n.MessageConveyor

All Implemented Interfaces:

IMessageConveyor

public class MessageConveyor
extends java.lang.Object
implements IMessageConveyor

The default implementation for IMessageConveyor based on resource bundles.

See also getMessage(Enum, Object...) for details.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.util.Map<java.lang.String,CAL10NBundle>	cache
(package private) java.util.Locale	locale

Constructor Summary

Constructors

Constructor	Description
MessageConveyor(java.util.Locale locale)	The Locale associated with this instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getMessage(MessageParameterObj mpo)	Syntactic sugar for the case where the massage is contained in a MessageParameterObj.
<E extends java.lang.Enum<?>> java.lang.String	getMessage(E key, java.lang.Object... args)	Given an enum as key, find the resource bundle corresponding to this locale and return the message corresponding to the key passed as parameter (internationalized per this locale).
private <E extends java.lang.Enum<?>> CAL10NBundle	lookupResourceBundleByEnumClassAndLocale(java.lang.Class<E> declaringClass)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

locale

final java.util.Locale locale

cache

final java.util.Map<java.lang.String,CAL10NBundle> cache

Constructor Detail

MessageConveyor

public MessageConveyor(java.util.Locale locale)

The Locale associated with this instance.

Parameters:

locale - the Locale which this conveyor targets

Method Detail

getMessage

public <E extends java.lang.Enum<?>> java.lang.String getMessage(E key,
                                                                 java.lang.Object... args)
                                                          throws MessageConveyorException

Given an enum as key, find the resource bundle corresponding to this locale and return the message corresponding to the key passed as parameter (internationalized per this locale).

The name of the resource bundle is defined via the BaseName annotation whereas the locale is specified in this MessageConveyor instance's constructor.

Specified by:

getMessage in interface IMessageConveyor

Type Parameters:

E - an enum type

Parameters:

key - an enum instance used as message key

args - optional arguments

Returns:

The translated/localized message

Throws:

MessageConveyorException

lookupResourceBundleByEnumClassAndLocale

private <E extends java.lang.Enum<?>> CAL10NBundle lookupResourceBundleByEnumClassAndLocale(java.lang.Class<E> declaringClass)
                                                                                     throws MessageConveyorException

Throws:

MessageConveyorException

getMessage

public java.lang.String getMessage(MessageParameterObj mpo)
                            throws MessageConveyorException

Description copied from interface: IMessageConveyor

Syntactic sugar for the case where the massage is contained in a MessageParameterObj.

Equivalent to calling

 getMessage(mpo.getKey(), mpo.getArgs());
 

Specified by:

getMessage in interface IMessageConveyor

Parameters:

mpo - The MessageParameterObj to translate

Returns:

translated message

Throws:

MessageConveyorException

See Also:

IMessageConveyor.getMessage(Enum, Object...)