com.stc.connector.framework.util
Class MessageManager

java.lang.Object
  com.stc.connector.framework.util.MessageManager

public class MessageManager

extends java.lang.Object

An internationalization / localization helper class which reduces the bother of handling ResourceBundles and takes care of the common cases of message formating which otherwise require the creation of Object arrays and such.

The MessageManager operates on a package basis. One MessageManager per package can be created and accessed via the getManager method call.

The MessageManager will look for a ResourceBundle named by the package name given plus the suffix of "LocalStrings". In practice, this means that the localized information will be contained in a LocalStrings.properties file located in the package directory of the classpath.

Please see the documentation for java.util.ResourceBundle for more information.

Author:

brangara

Method Summary

static MessageManager	getManager(java.lang.String packageName) Get the MessageManager for a particular package.
java.lang.String	getString(java.lang.String key) Get a string from the underlying resource bundle.
java.lang.String	getString(java.lang.String key, java.lang.Object arg) Get a string from the underlying resource bundle and format it with the given object argument.
java.lang.String	getString(java.lang.String key, java.lang.Object[] args) Get a string from the underlying resource bundle and format it with the given set of arguments.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2) Get a string from the underlying resource bundle and format it with the given object arguments.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Get a string from the underlying resource bundle and format it with the given object arguments.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Get a string from the underlying resource bundle and format it with the given object arguments.

Methods inherited from class java.lang.Object

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

Method Detail

getManager

public static MessageManager getManager(java.lang.String packageName)

Get the MessageManager for a particular package. If a manager for a package already exists, it will be reused, else a new MessageManager will be created and returned.

Parameters:

packageName - package name

Returns:

message mgr

getString

public java.lang.String getString(java.lang.String key)

Get a string from the underlying resource bundle.

Parameters:

key - key

Returns:

string

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object[] args)

Get a string from the underlying resource bundle and format it with the given set of arguments.

Parameters:

key - resource bundle key

args - srguments

Returns:

local string

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg)

Get a string from the underlying resource bundle and format it with the given object argument. This argument can of course be a String object.

Parameters:

key - resource bundle key

arg - argument

Returns:

local value

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2)

Get a string from the underlying resource bundle and format it with the given object arguments. These arguments can of course be String objects.

Parameters:

key - resource bundle key string

arg1 - argument 1

arg2 - argument 2

Returns:

local value

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.Object arg3)

Get a string from the underlying resource bundle and format it with the given object arguments. These arguments can of course be String objects.

Parameters:

key - resource bundle key

arg1 - argument 1

arg2 - argument 2

arg3 - argument 3

Returns:

local value

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.Object arg3,
                                  java.lang.Object arg4)

Get a string from the underlying resource bundle and format it with the given object arguments. These arguments can of course be String objects.

Parameters:

key - resource bundle key

arg1 - argument 1

arg2 - argument 2

arg3 - argument 3

arg4 - argument 4

Returns:

local value