com.lf.commons.msg

Class MessageCache

java.lang.Object

com.lf.commons.msg.MessageCache

public class MessageCache
extends java.lang.Object

Handles messages for a certain natural language represented by locale and domain.

Since:

1.5

Version:

$Revision: 1.16 $, $Date: 2016/01/01 15:43:03 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable<java.lang.String,Configuration>	cachePagesByRange Container for fast acquisition of locale dependent messages.
protected java.lang.String	id The desired domain identifier like "LIMA".
protected Locale	locale Supported locale consisting at least of a language code.
protected org.apache.commons.vfs2.FileObject	path The VFS directory with locale specific page files.

Constructor Summary

Constructors

Constructor and Description
MessageCache() Constructor method for i18n purposes only.
MessageCache(Locale locale, java.lang.String id, org.apache.commons.vfs2.FileObject path) Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize() Cares for proper cleanup when is not needed any longer (helps gc).
java.lang.String	getMessage(java.lang.String code, boolean prefix) Returns the message text associated with a certain message code.
boolean	isArmed() Have the underlying message codes been successfully loaded?
void	loadAllPages() Load all available message code pages for the represented locale.

Methods inherited from class java.lang.Object

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

Field Detail

cachePagesByRange

protected java.util.Hashtable<java.lang.String,Configuration> cachePagesByRange

Container for fast acquisition of locale dependent messages. Key is lowest range border (String) like "0100", value is page container (Configuration).

locale

protected Locale locale

Supported locale consisting at least of a language code.

id

protected java.lang.String id

The desired domain identifier like "LIMA".

path

protected org.apache.commons.vfs2.FileObject path

The VFS directory with locale specific page files.

Constructor Detail

MessageCache

public MessageCache()
             throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

MessageCache

public MessageCache(Locale locale,
            java.lang.String id,
            org.apache.commons.vfs2.FileObject path)

Constructor method.

Parameters:

locale - The locale to load the messages for

id - The desired domain identifier like "LIMA"

path - The VFS directory with locale specific page files

Throws:

java.lang.IllegalArgumentException - Error indication

Since:

1.5

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Cares for proper cleanup when is not needed any longer (helps gc).

The caches are cleared here to allow for a faster garbage collecting.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Error indication

Since:

1.5

getMessage

public java.lang.String getMessage(java.lang.String code,
                          boolean prefix)

Returns the message text associated with a certain message code.

Throws NullPointerException if code is null. If the message text cannot be found for the specified code and locale then null is returned and it's up to the caller to react appropriately e.g. by acquiring the message text in a default language like English.

You can either pass code as numerical string like "0001" (four places), or as full code including the domain identifier prefix like "LIMA-0001" which is used for the configuration files as property name.

With the parameter prefix you can specify whether to have the domain identifier automatically prepended (like "LIMA-0000: Unknown message identifier", or to get the plain message text (like "Unknown message identifier").

Parameters:

code - The message code of interest, don't pass null values

prefix - Shall the domain identifier be automatically prepended to the message?

Returns:

The message text, null if code does not exist

Since:

1.5

isArmed

public boolean isArmed()

Have the underlying message codes been successfully loaded?

Returns:

Successful?

Since:

1.6

loadAllPages

public void loadAllPages()

Load all available message code pages for the represented locale.

Since:

1.6