pl.edu.icm.unity.engine.api.msg

Class UnityMessageSource

java.lang.Object

org.springframework.context.support.MessageSourceSupport

org.springframework.context.support.AbstractMessageSource

org.springframework.context.support.AbstractResourceBasedMessageSource

org.springframework.context.support.ReloadableResourceBundleMessageSource

pl.edu.icm.unity.engine.api.msg.UnityMessageSource

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.HierarchicalMessageSource, org.springframework.context.MessageSource, org.springframework.context.ResourceLoaderAware

@Component
public class UnityMessageSource
extends org.springframework.context.support.ReloadableResourceBundleMessageSource
implements pl.edu.icm.unity.MessageSource

Extension of the ResourceBundleMessageSource which automatically sets the proper locale from the InvocationContext and allows for an easier invocation using varargs. It also sets UTF-8 encoding and disables platform's locale fallback.

Another improvement is loading of messages from all classpath resources which are under messages/per-module-id/messages.properties path and from a respective file which is under configured i18n location in the same subdirectory as the per-module-id from classpath.

Author:

K. Benedyczak

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.context.support.ReloadableResourceBundleMessageSource

org.springframework.context.support.ReloadableResourceBundleMessageSource.PropertiesHolder

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROFILE_FAIL_ON_MISSING

Fields inherited from class org.springframework.context.support.MessageSourceSupport

logger

Constructor Summary

Constructors

Constructor and Description
UnityMessageSource(UnityServerConfiguration config, boolean failOnMissing)
UnityMessageSource(UnityServerConfiguration config, org.springframework.core.env.Environment springEnv)

Method Summary

Modifier and Type	Method and Description
String	getDefaultLocaleCode()
Map<String,Locale>	getEnabledLocales()
Locale	getLocale()
static Locale	getLocale(Locale fallback)
String	getLocaleCode()
String	getMessage(String code, Object... args)
String	getMessageNullArg(String code, Object... args) If any of the arguments is null, then empty string is returned
String	getMessageUnsafe(String code, Object... args)
Map<String,Locale>	getSupportedLocales()
String	getYesNo(boolean value)

Methods inherited from class org.springframework.context.support.ReloadableResourceBundleMessageSource

calculateAllFilenames, calculateFilenamesForLocale, clearCache, clearCacheIncludingAncestors, getMergedProperties, getProperties, loadProperties, newProperties, refreshProperties, resolveCode, resolveCodeWithoutArguments, setConcurrentRefresh, setFileEncodings, setPropertiesPersister, setResourceLoader, toString

Methods inherited from class org.springframework.context.support.AbstractResourceBasedMessageSource

addBasenames, getBasenameSet, getCacheMillis, getDefaultEncoding, isFallbackToSystemLocale, setBasename, setBasenames, setCacheMillis, setCacheSeconds, setDefaultEncoding, setFallbackToSystemLocale

Methods inherited from class org.springframework.context.support.AbstractMessageSource

getCommonMessages, getDefaultMessage, getDefaultMessage, getMessage, getMessage, getMessage, getMessageFromParent, getMessageInternal, getParentMessageSource, isUseCodeAsDefaultMessage, resolveArguments, setCommonMessages, setParentMessageSource, setUseCodeAsDefaultMessage

Methods inherited from class org.springframework.context.support.MessageSourceSupport

createMessageFormat, formatMessage, isAlwaysUseMessageFormat, renderDefaultMessage, setAlwaysUseMessageFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

Field Detail

PROFILE_FAIL_ON_MISSING

public static final String PROFILE_FAIL_ON_MISSING

See Also:

Constant Field Values

Constructor Detail

UnityMessageSource

@Autowired
public UnityMessageSource(UnityServerConfiguration config,
                                     org.springframework.core.env.Environment springEnv)
                              throws IOException

Throws:

IOException

UnityMessageSource

public UnityMessageSource(UnityServerConfiguration config,
                          boolean failOnMissing)
                   throws IOException

Throws:

IOException

Method Detail

getMessageUnsafe

public String getMessageUnsafe(String code,
                               Object... args)

getMessage

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

getMessageNullArg

public String getMessageNullArg(String code,
                                Object... args)

If any of the arguments is null, then empty string is returned

Parameters:

code -

args -

Returns:

getYesNo

public String getYesNo(boolean value)

getLocale

public Locale getLocale()

getEnabledLocales

public Map<String,Locale> getEnabledLocales()

getDefaultLocaleCode

public String getDefaultLocaleCode()

getLocaleCode

public String getLocaleCode()

getLocale

public static Locale getLocale(Locale fallback)

getSupportedLocales

public Map<String,Locale> getSupportedLocales()