org.mdiutil.lang

Class MessageProvider

java.lang.Object

org.mdiutil.lang.MessageProvider

public class MessageProvider
extends Object

This class provides several bundles of messages. It manages several bundle of messages, which are simply property files. The way to use this class is:

• Create one or several bundles. For example:

   MessageProvider provider = MessageProvider.getInstance();
   provider.createBundle("aKey", "org/myresources/", "messages.properties");
   

  or

   MessageProvider provider = MessageProvider.getInstance();
   provider.createBundle("anotherKey", url);
   

• Reference one bundle and get some messages anywhere in the code:

   MessageBundle bundle = MessageProvider.getBundle("aKey");
   String message = bundle.getMessage("propertyName");
   

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the bundles.
MessageBundle	createBundle(String key, String pack, String path) Create a bundle with a specified key, resource file path and the context class loader.
MessageBundle	createBundle(String key, String pack, String path, ClassLoader loader) Create a bundle with a specified key, resource file path and class loader.
MessageBundle	createBundle(String key, URL url) Create a bundle with a specified key, and resource URL.
static MessageBundle	getBundle(String key) Return the bundle with a specified key.
protected MessageBundle	getErrorBundle() Return the default bundle defined in the case where the bundle with a specified name does not exist.
static MessageProvider	getInstance() Return the single provider instance.

Methods inherited from class java.lang.Object

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

Method Detail

getErrorBundle

protected MessageBundle getErrorBundle()

Return the default bundle defined in the case where the bundle with a specified name does not exist.

Returns:

the default bundle

clear

public void clear()

Clear the bundles.

createBundle

public MessageBundle createBundle(String key,
                                  String pack,
                                  String path)

Create a bundle with a specified key, resource file path and the context class loader.

Parameters:

key - the bundle key

pack - the resource package

path - the resource path

Returns:

the bundle

See Also:

ResourceLoader

createBundle

public MessageBundle createBundle(String key,
                                  String pack,
                                  String path,
                                  ClassLoader loader)

Create a bundle with a specified key, resource file path and class loader.

Parameters:

key - the bundle key

pack - the resource package

path - the resource path

loader - the class loader to use to retrieve the resource

Returns:

the bundle

See Also:

ResourceLoader

createBundle

public MessageBundle createBundle(String key,
                                  URL url)

Create a bundle with a specified key, and resource URL.

Parameters:

key - the bundle key

url - the resource URL

Returns:

the bundle

getInstance

public static MessageProvider getInstance()

Return the single provider instance.

Returns:

the provider

getBundle

public static MessageBundle getBundle(String key)

Return the bundle with a specified key. If there is no bundle with the specified key, an empty bundle will be returned instead.

Parameters:

key - the bundle key

Returns:

the bundle