com.lf.commons.msg

Class MessageFactory

java.lang.Object

com.lf.commons.msg.MessageFactory

public class MessageFactory
extends java.lang.Object

Factory class for vending various message objects.

Whenever possible, this factory will hand out references to shared instances. Use this if you need many, many MessageCodes objects while running your application and it is acceptable for you to continously use a certain amount of memory for the cached object. If you only use instances once then you should either install an object as usual (by calling new), or let this factory create a shared instance and flush the factory after you're finished with the object. The garbage collector will then release memory on-the-fly as the objects are no longer referenced so the overall memory footprint can be very small. You should keep the shared instances created by this class if you make heavy use of the supported classes (currently MessageCodes).

Since:

1.5

Version:

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

Author:

Axel Schwolow

See Also:

MessageCodes

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Hashtable<java.lang.String,MessageCodes>	mcodesByID Container with shared codes (key: String, value: MessageCodes).

Constructor Summary

Constructors

Constructor and Description
MessageFactory() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
static MessageCodes	createMessageCodes(java.lang.String id, java.lang.String base, java.lang.Object loader) Creates a shared MessageCodes instance.
static void	flushMessageCodes(java.lang.String id) Removes the shared MessageCodes instance if installed.
static boolean	hasMessageCodes(java.lang.String id) Determines whether a shared MessageCodes instance has already been created.

Methods inherited from class java.lang.Object

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

Field Detail

mcodesByID

protected static final java.util.Hashtable<java.lang.String,MessageCodes> mcodesByID

Container with shared codes (key: String, value: MessageCodes).

Constructor Detail

MessageFactory

public MessageFactory()
               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

Method Detail

createMessageCodes

public static MessageCodes createMessageCodes(java.lang.String id,
                              java.lang.String base,
                              java.lang.Object loader)

Creates a shared MessageCodes instance.

Parameters:

id - The desired domain identifier like "LIMA"

base - The classpath with language specific sub-directories with page files

loader - The instance to use as class loader for the resources

Returns:

The shared MessageCodes instance

Since:

1.5

flushMessageCodes

public static void flushMessageCodes(java.lang.String id)

Removes the shared MessageCodes instance if installed.

Parameters:

id - The desired domain identifier like "LIMA", null clears whole cache

Since:

1.5

hasMessageCodes

public static boolean hasMessageCodes(java.lang.String id)

Determines whether a shared MessageCodes instance has already been created.

Parameters:

id - The desired domain identifier like "LIMA"

Returns:

Are such message codes installed?

Since:

1.5