org.jahia.utils.i18n

Class ModuleMessageSource

java.lang.Object

org.jahia.utils.i18n.ModuleMessageSource

All Implemented Interfaces:

JahiaModuleAware, org.springframework.context.MessageSource

public class ModuleMessageSource
extends Object
implements org.springframework.context.MessageSource, JahiaModuleAware

Message source implementation that uses current module's resource bundle for I18N messages.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
ModuleMessageSource()

Method Summary

Modifier and Type	Method and Description
String	getMessage(org.springframework.context.MessageSourceResolvable resolvable, Locale locale)
String	getMessage(String code, Object[] args, Locale locale)
String	getMessage(String code, Object[] args, String defaultMessage, Locale locale)
void	setJahiaModule(JahiaTemplatesPackage module)
void	setUseCodeAsDefaultMessage(boolean useCodeAsDefaultMessage) Set whether to use the message code as default message instead of throwing a NoSuchMessageException.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleMessageSource

public ModuleMessageSource()

Method Detail

getMessage

public String getMessage(org.springframework.context.MessageSourceResolvable resolvable,
                         Locale locale)
                  throws org.springframework.context.NoSuchMessageException

Specified by:

getMessage in interface org.springframework.context.MessageSource

Throws:

org.springframework.context.NoSuchMessageException

getMessage

public String getMessage(String code,
                         Object[] args,
                         Locale locale)
                  throws org.springframework.context.NoSuchMessageException

Specified by:

getMessage in interface org.springframework.context.MessageSource

Throws:

org.springframework.context.NoSuchMessageException

getMessage

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

Specified by:

getMessage in interface org.springframework.context.MessageSource

setJahiaModule

public void setJahiaModule(JahiaTemplatesPackage module)

Specified by:

setJahiaModule in interface JahiaModuleAware

setUseCodeAsDefaultMessage

public void setUseCodeAsDefaultMessage(boolean useCodeAsDefaultMessage)

Set whether to use the message code as default message instead of throwing a NoSuchMessageException. Useful for development and debugging. Default is "false".

Note: In case of a MessageSourceResolvable with multiple codes (like a FieldError) and a MessageSource that has a parent MessageSource, do not activate "useCodeAsDefaultMessage" in the parent: Else, you'll get the first code returned as message by the parent, without attempts to check further codes.

To be able to work with "useCodeAsDefaultMessage" turned on in the parent, AbstractMessageSource and AbstractApplicationContext contain special checks to delegate to the internal #getMessageInternal method if available. In general, it is recommended to just use "useCodeAsDefaultMessage" during development and not rely on it in production in the first place, though.