org.frameworkset.spi.support

类 ReloadableResourceBundleMessageSource

java.lang.Object

org.frameworkset.spi.support.MessageSourceSupport

org.frameworkset.spi.support.AbstractMessageSource

org.frameworkset.spi.support.ReloadableResourceBundleMessageSource

所有已实现的接口:

ResourceLoaderAware, HierarchicalMessageSource, MessageSource

public class ReloadableResourceBundleMessageSource
extends AbstractMessageSource
implements ResourceLoaderAware

Title: ReloadableResourceBundleMessageSource.java

Description:

bboss workgroup

Copyright (c) 2007

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	ReloadableResourceBundleMessageSource.PropertiesHolder PropertiesHolder for caching.

字段概要

从类继承的字段 org.frameworkset.spi.support.MessageSourceSupport

logger

构造器概要

构造器

构造器和说明
ReloadableResourceBundleMessageSource()

方法概要

限定符和类型	方法和说明
protected java.util.List	calculateAllFilenames(java.lang.String basename, java.util.Locale locale) Calculate all filenames for the given bundle basename and Locale.
protected java.util.List	calculateFilenamesForLocale(java.lang.String basename, java.util.Locale locale) Calculate the filenames for the given bundle basename and Locale, appending language code, country code, and variant code.
void	clearCache() Clear the resource bundle cache.
void	clearCacheIncludingAncestors() Clear the resource bundle caches of this MessageSource and all its ancestors.
protected ReloadableResourceBundleMessageSource.PropertiesHolder	getMergedProperties(java.util.Locale locale) Get a PropertiesHolder that contains the actually visible properties for a Locale, after merging all specified resource bundles.
protected ReloadableResourceBundleMessageSource.PropertiesHolder	getProperties(java.lang.String filename) Get a PropertiesHolder for the given filename, either from the cache or freshly loaded.
protected java.util.Properties	loadProperties(org.frameworkset.util.io.Resource resource, java.lang.String filename) Load the properties from the given resource.
protected ReloadableResourceBundleMessageSource.PropertiesHolder	refreshProperties(java.lang.String filename, ReloadableResourceBundleMessageSource.PropertiesHolder propHolder) Refresh the PropertiesHolder for the given bundle filename.
protected java.text.MessageFormat	resolveCode(java.lang.String code, java.util.Locale locale) Resolves the given message code as key in the retrieved bundle files, using a cached MessageFormat instance per message code.
protected java.lang.String	resolveCodeWithoutArguments(java.lang.String code, java.util.Locale locale) Resolves the given message code as key in the retrieved bundle files, returning the value found in the bundle as-is (without MessageFormat parsing).
void	setBasename(java.lang.String basename) Set a single basename, following the basic ResourceBundle convention of not specifying file extension or language codes, but in contrast to ResourceBundleMessageSource referring to a Bboss resource location: e.g.
void	setBasenames(java.lang.String[] basenames) Set an array of basenames, each following the basic ResourceBundle convention of not specifying file extension or language codes, but in contrast to ResourceBundleMessageSource referring to a Bboss resource location: e.g.
void	setCacheSeconds(int cacheSeconds) Set the number of seconds to cache loaded properties files.
void	setDefaultEncoding(java.lang.String defaultEncoding) Set the default charset to use for parsing properties files.
void	setFallbackToSystemLocale(boolean fallbackToSystemLocale) Set whether to fall back to the system Locale if no files for a specific Locale have been found.
void	setFileEncodings(java.util.Properties fileEncodings) Set per-file charsets to use for parsing properties files.
void	setPropertiesPersister(org.frameworkset.util.PropertiesPersister propertiesPersister) Set the PropertiesPersister to use for parsing properties files.
void	setResourceLoader(org.frameworkset.util.io.ResourceLoader resourceLoader) Set the ResourceLoader to use for loading bundle properties files.
java.lang.String	toString()

从类继承的方法 org.frameworkset.spi.support.AbstractMessageSource

destroy, getDefaultMessage, getMessage, getMessage, getMessage, getMessage, getMessage, getMessageFromParent, getMessageInternal, getParentMessageSource, isUseCodeAsDefaultMessage, renderDefaultMessage, resolveArguments, setParentMessageSource, setUseCodeAsDefaultMessage

从类继承的方法 org.frameworkset.spi.support.MessageSourceSupport

createMessageFormat, formatMessage, isAlwaysUseMessageFormat, setAlwaysUseMessageFormat

从类继承的方法 java.lang.Object

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

构造器详细资料

ReloadableResourceBundleMessageSource

public ReloadableResourceBundleMessageSource()

方法详细资料

setBasename

public void setBasename(java.lang.String basename)

Set a single basename, following the basic ResourceBundle convention of not specifying file extension or language codes, but in contrast to ResourceBundleMessageSource referring to a Bboss resource location: e.g. "WEB-INF/messages" for "WEB-INF/messages.properties", "WEB-INF/messages_en.properties", etc.

As of Bboss 1.2.2, XML properties files are also supported: e.g. "WEB-INF/messages" will find and load "WEB-INF/messages.xml", "WEB-INF/messages_en.xml", etc as well. Note that this will only work on JDK 1.5+.

参数:

basename - the single basename

另请参阅:

setBasenames(java.lang.String[]), ResourceEditor, ResourceBundle

setBasenames

public void setBasenames(java.lang.String[] basenames)

Set an array of basenames, each following the basic ResourceBundle convention of not specifying file extension or language codes, but in contrast to ResourceBundleMessageSource referring to a Bboss resource location: e.g. "WEB-INF/messages" for "WEB-INF/messages.properties", "WEB-INF/messages_en.properties", etc.

As of Bboss 1.2.2, XML properties files are also supported: e.g. "WEB-INF/messages" will find and load "WEB-INF/messages.xml", "WEB-INF/messages_en.xml", etc as well. Note that this will only work on JDK 1.5+.

The associated resource bundles will be checked sequentially when resolving a message code. Note that message definitions in a previous resource bundle will override ones in a later bundle, due to the sequential lookup.

参数:

basenames - an array of basenames

另请参阅:

setBasename(java.lang.String), ResourceBundle

setDefaultEncoding

public void setDefaultEncoding(java.lang.String defaultEncoding)

Set the default charset to use for parsing properties files. Used if no file-specific charset is specified for a file.

Default is none, using the java.util.Properties default encoding.

Only applies to classic properties files, not to XML files.

参数:

defaultEncoding - the default charset

另请参阅:

setFileEncodings(java.util.Properties)

setFileEncodings

public void setFileEncodings(java.util.Properties fileEncodings)

Set per-file charsets to use for parsing properties files.

Only applies to classic properties files, not to XML files.

参数:

fileEncodings - Properties with filenames as keys and charset names as values. Filenames have to match the basename syntax, with optional locale-specific appendices: e.g. "WEB-INF/messages" or "WEB-INF/messages_en".

另请参阅:

setBasenames(java.lang.String[])

setFallbackToSystemLocale

public void setFallbackToSystemLocale(boolean fallbackToSystemLocale)

Set whether to fall back to the system Locale if no files for a specific Locale have been found. Default is "true"; if this is turned off, the only fallback will be the default file (e.g. "messages.properties" for basename "messages").

Falling back to the system Locale is the default behavior of java.util.ResourceBundle. However, this is often not desirable in an application server environment, where the system Locale is not relevant to the application at all: Set this flag to "false" in such a scenario.

setCacheSeconds

public void setCacheSeconds(int cacheSeconds)

Set the number of seconds to cache loaded properties files.

• Default is "-1", indicating to cache forever (just like java.util.ResourceBundle).
• A positive number will cache loaded properties files for the given number of seconds. This is essentially the interval between refresh checks. Note that a refresh attempt will first check the last-modified timestamp of the file before actually reloading it; so if files don't change, this interval can be set rather low, as refresh attempts will not actually reload.
• A value of "0" will check the last-modified timestamp of the file on every message access. Do not use this in a production environment!

setPropertiesPersister

public void setPropertiesPersister(org.frameworkset.util.PropertiesPersister propertiesPersister)

Set the PropertiesPersister to use for parsing properties files.

The default is a DefaultPropertiesPersister.

setResourceLoader

public void setResourceLoader(org.frameworkset.util.io.ResourceLoader resourceLoader)

Set the ResourceLoader to use for loading bundle properties files.

The default is a DefaultResourceLoader. Will get overridden by the ApplicationContext if running in a context, as it implements the ResourceLoaderAware interface. Can be manually overridden when running outside of an ApplicationContext.

指定者:

setResourceLoader 在接口中 ResourceLoaderAware

参数:

resourceLoader - ResourceLoader object to be used by this object

另请参阅:

DefaultResourceLoader, ResourceLoaderAware

resolveCodeWithoutArguments

protected java.lang.String resolveCodeWithoutArguments(java.lang.String code,
                                                       java.util.Locale locale)

Resolves the given message code as key in the retrieved bundle files, returning the value found in the bundle as-is (without MessageFormat parsing).

覆盖:

resolveCodeWithoutArguments 在类中 AbstractMessageSource

参数:

code - the code of the message to resolve

locale - the Locale to resolve the code for (subclasses are encouraged to support internationalization)

返回:

the message String, or null if not found

另请参阅:

AbstractMessageSource.resolveCode(java.lang.String, java.util.Locale), MessageFormat

resolveCode

protected java.text.MessageFormat resolveCode(java.lang.String code,
                                              java.util.Locale locale)

Resolves the given message code as key in the retrieved bundle files, using a cached MessageFormat instance per message code.

指定者:

resolveCode 在类中 AbstractMessageSource

参数:

code - the code of the message to resolve

locale - the Locale to resolve the code for (subclasses are encouraged to support internationalization)

返回:

the MessageFormat for the message, or null if not found

另请参阅:

AbstractMessageSource.resolveCodeWithoutArguments(String, java.util.Locale)

getMergedProperties

protected ReloadableResourceBundleMessageSource.PropertiesHolder getMergedProperties(java.util.Locale locale)

Get a PropertiesHolder that contains the actually visible properties for a Locale, after merging all specified resource bundles. Either fetches the holder from the cache or freshly loads it.

Only used when caching resource bundle contents forever, i.e. with cacheSeconds < 0. Therefore, merged properties are always cached forever.

calculateAllFilenames

protected java.util.List calculateAllFilenames(java.lang.String basename,
                                               java.util.Locale locale)

Calculate all filenames for the given bundle basename and Locale. Will calculate filenames for the given Locale, the system Locale (if applicable), and the default file.

参数:

basename - the basename of the bundle

locale - the locale

返回:

the List of filenames to check

另请参阅:

setFallbackToSystemLocale(boolean), calculateFilenamesForLocale(java.lang.String, java.util.Locale)

getProperties

protected ReloadableResourceBundleMessageSource.PropertiesHolder getProperties(java.lang.String filename)

Get a PropertiesHolder for the given filename, either from the cache or freshly loaded.

参数:

filename - the bundle filename (basename + Locale)

返回:

the current PropertiesHolder for the bundle

refreshProperties

protected ReloadableResourceBundleMessageSource.PropertiesHolder refreshProperties(java.lang.String filename,
                                                                                   ReloadableResourceBundleMessageSource.PropertiesHolder propHolder)

Refresh the PropertiesHolder for the given bundle filename. The holder can be null if not cached before, or a timed-out cache entry (potentially getting re-validated against the current last-modified timestamp).

参数:

filename - the bundle filename (basename + Locale)

propHolder - the current PropertiesHolder for the bundle

loadProperties

protected java.util.Properties loadProperties(org.frameworkset.util.io.Resource resource,
                                              java.lang.String filename)
                                       throws java.io.IOException

Load the properties from the given resource.

参数:

resource - the resource to load from

filename - the original bundle filename (basename + Locale)

返回:

the populated Properties instance

抛出:

java.io.IOException - if properties loading failed

clearCache

public void clearCache()

Clear the resource bundle cache. Subsequent resolve calls will lead to reloading of the properties files.

clearCacheIncludingAncestors

public void clearCacheIncludingAncestors()

Clear the resource bundle caches of this MessageSource and all its ancestors.

另请参阅:

clearCache()

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

calculateFilenamesForLocale

protected java.util.List calculateFilenamesForLocale(java.lang.String basename,
                                                     java.util.Locale locale)

Calculate the filenames for the given bundle basename and Locale, appending language code, country code, and variant code. E.g.: basename "messages", Locale "de_AT_oo" -> "messages_de_AT_OO", "messages_de_AT", "messages_de".

参数:

basename - the basename of the bundle

locale - the locale

返回:

the List of filenames to check