org.openmrs.messagesource.impl

Class MutableResourceBundleMessageSource

java.lang.Object

org.springframework.context.support.MessageSourceSupport

org.springframework.context.support.AbstractMessageSource

org.springframework.context.support.AbstractResourceBasedMessageSource

org.springframework.context.support.ReloadableResourceBundleMessageSource

org.openmrs.messagesource.impl.MutableResourceBundleMessageSource

All Implemented Interfaces:

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

public class MutableResourceBundleMessageSource
extends org.springframework.context.support.ReloadableResourceBundleMessageSource
implements MutableMessageSource

ResourceBundleMessageSource extends ReloadableResourceBundleMessageSource to provide the additional features of a MutableMessageSource.

Nested Class Summary

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

org.springframework.context.support.ReloadableResourceBundleMessageSource.PropertiesHolder

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
MutableResourceBundleMessageSource()

Method Summary

Modifier and Type	Method and Description
void	addPresentation(PresentationMessage message) Adds a presentation message to the source.
Collection<Locale>	getLocales() Gets the locales for which messages are available from this source.
PresentationMessage	getPresentation(String key, Locale forLocale) Gets the PresentationMessage for a particular locale.
Collection<PresentationMessage>	getPresentations() Returns all available messages.
Collection<PresentationMessage>	getPresentationsInLocale(Locale locale) Gets alll the available messages in a particular locale, packaged as PresentationMessages.
void	merge(MutableMessageSource fromSource, boolean overwrite) Merge messages from another source into this source.
void	removePresentation(PresentationMessage message) Removes a presentation message from the source.
void	setBasename(String basename) Override to obtain a local reference to the basenames.
void	setBasenames(String... basenames) Override to obtain a local reference to the basenames.
void	setCacheSeconds(int cacheSeconds)

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, getDefaultLocale, isFallbackToSystemLocale, setCacheMillis, setDefaultEncoding, setDefaultLocale, 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.HierarchicalMessageSource

getParentMessageSource, setParentMessageSource

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

Constructor Detail

MutableResourceBundleMessageSource

public MutableResourceBundleMessageSource()

Method Detail

getLocales

public Collection<Locale> getLocales()

Description copied from interface: MutableMessageSource

Gets the locales for which messages are available from this source.

Specified by:

getLocales in interface MutableMessageSource

Returns:

available message locales

See Also:

MutableMessageSource.getLocales()

setCacheSeconds

public void setCacheSeconds(int cacheSeconds)

Overrides:

setCacheSeconds in class org.springframework.context.support.AbstractResourceBasedMessageSource

getPresentations

public Collection<PresentationMessage> getPresentations()

Returns all available messages.

Specified by:

getPresentations in interface MutableMessageSource

Returns:

collection of presentation messages

See Also:

MutableMessageSource.getPresentations()

setBasename

public void setBasename(String basename)

Override to obtain a local reference to the basenames.

Overrides:

setBasename in class org.springframework.context.support.AbstractResourceBasedMessageSource

See Also:

AbstractResourceBasedMessageSource.setBasename(java.lang.String)

setBasenames

public void setBasenames(String... basenames)

Override to obtain a local reference to the basenames.

Overrides:

setBasenames in class org.springframework.context.support.AbstractResourceBasedMessageSource

See Also:

AbstractResourceBasedMessageSource.setBasenames(java.lang.String[])

addPresentation

public void addPresentation(PresentationMessage message)

Description copied from interface: MutableMessageSource

Adds a presentation message to the source. This operation should overwrite any existing message which conflicts (has the same code and locale).

Specified by:

addPresentation in interface MutableMessageSource

Parameters:

message - message to add to the source

See Also:

MutableMessageSource.addPresentation(org.openmrs.messagesource.PresentationMessage)

removePresentation

public void removePresentation(PresentationMessage message)

Description copied from interface: MutableMessageSource

Removes a presentation message from the source.

Specified by:

removePresentation in interface MutableMessageSource

Parameters:

message - the message to remove

See Also:

MutableMessageSource.removePresentation(org.openmrs.messagesource.PresentationMessage)

merge

public void merge(MutableMessageSource fromSource,
                  boolean overwrite)

Description copied from interface: MutableMessageSource

Merge messages from another source into this source.

Specified by:

merge in interface MutableMessageSource

Parameters:

fromSource - message source from which messages should be merge

overwrite - whether to overwrite existing messages

See Also:

MutableMessageSource.merge(MutableMessageSource, boolean)

getPresentation

public PresentationMessage getPresentation(String key,
                                           Locale forLocale)

Description copied from interface: MutableMessageSource

Gets the PresentationMessage for a particular locale.

Specified by:

getPresentation in interface MutableMessageSource

Parameters:

key - textual key for the message

forLocale - locale for which to get the message

Returns:

corresponding PresentationMessage, or null if not available

See Also:

MutableMessageSource.getPresentation(java.lang.String, java.util.Locale)

getPresentationsInLocale

public Collection<PresentationMessage> getPresentationsInLocale(Locale locale)

Description copied from interface: MutableMessageSource

Gets alll the available messages in a particular locale, packaged as PresentationMessages.

Specified by:

getPresentationsInLocale in interface MutableMessageSource

Parameters:

locale - locale for which to get the messages

Returns:

collection of PresentationMessages in the locale

See Also:

MutableMessageSource.getPresentationsInLocale(java.util.Locale)