com.sun.jbi.util

Class StringTranslator

java.lang.Object

com.sun.jbi.util.StringTranslator

public class StringTranslator
extends Object

This is the implementation of the String Translator, which provides services for internationalization of messages to all services running inside the JBI environment.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_BUNDLE_NAME Unqualified name for resource bundles.

Constructor Summary

Constructors

Constructor and Description
StringTranslator(String packageName, ClassLoader classLoader) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getString(String key) Get a localized string using the specified resource key.
String	getString(String key, Object insert1) Get a localized string using the specified resource key.
String	getString(String key, Object[] inserts) Get a localized string using the specified resource key.
String	getString(String key, Object insert1, Object insert2) Get a localized string using the specified resource key.
String	getString(String key, Object insert1, Object insert2, Object insert3) Get a localized string using the specified resource key.
String	getString(String key, Object insert1, Object insert2, Object insert3, Object insert4) Get a localized string using the specified resource key.
String	getString(String key, Object insert1, Object insert2, Object insert3, Object insert4, Object insert5) Get a localized string using the specified resource key.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_BUNDLE_NAME

public static final String RESOURCE_BUNDLE_NAME

Unqualified name for resource bundles.

See Also:

Constant Field Values

Constructor Detail

StringTranslator

public StringTranslator(String packageName,
                ClassLoader classLoader)

Constructor. This loads the Resource Bundle for the current locale, and if the current locale is not Locale.US, it loads the Resource Bundle for Locale.US and stores it as the backup for string lookup.

Parameters:

packageName - - the name of the package that contains the resource bundle.

classLoader - - the class loader to be used for loading the resource bundle. If this parameter is null, the current class loader is used.

Method Detail

getString

public String getString(String key)

Get a localized string using the specified resource key.

Parameters:

key - - the key to the localized string in the resource bundle.

Returns:

the localized string.

getString

public String getString(String key,
               Object insert1)

Get a localized string using the specified resource key. Handle one message insert.

Parameters:

key - - the key to the localized string in the resource bundle.

insert1 - - the message insert.

Returns:

the localized string formatted with the message insert.

getString

public String getString(String key,
               Object insert1,
               Object insert2)

Get a localized string using the specified resource key. Handle two message inserts.

Parameters:

key - - the key to the localized string in the resource bundle.

insert1 - - the first message insert.

insert2 - - the second message insert.

Returns:

the localized string formatted with the message inserts.

getString

public String getString(String key,
               Object insert1,
               Object insert2,
               Object insert3)

Get a localized string using the specified resource key. Handle three message inserts.

Parameters:

key - - the key to the localized string in the resource bundle.

insert1 - - the first message insert.

insert2 - - the second message insert.

insert3 - - the third message insert.

Returns:

the localized string formatted with the message inserts.

getString

public String getString(String key,
               Object insert1,
               Object insert2,
               Object insert3,
               Object insert4)

Get a localized string using the specified resource key. Handle four message inserts.

Parameters:

key - - the key to the localized string in the resource bundle.

insert1 - - the first message insert.

insert2 - - the second message insert.

insert3 - - the third message insert.

insert4 - - the fourth message insert.

Returns:

the localized string formatted with the message inserts.

getString

public String getString(String key,
               Object insert1,
               Object insert2,
               Object insert3,
               Object insert4,
               Object insert5)

Get a localized string using the specified resource key. Handle five message inserts.

Parameters:

key - - the key to the localized string in the resource bundle.

insert1 - - the first message insert.

insert2 - - the second message insert.

insert3 - - the third message insert.

insert4 - - the fourth message insert.

insert5 - - the fifth message insert.

Returns:

the localized string formatted with the message inserts.

getString

public String getString(String key,
               Object[] inserts)

Get a localized string using the specified resource key. Handle any number of message inserts. This method is called by all the other getString() methods in the class. The procedure for string lookup is to first look in the primary resource bundle, then in the fallback resource bundle. If the string is found in the primary, return the translated string quietly. If the string is not found in the primary but in the fallback, log a warning and return the translated string. If the string is not found in either bundle, log an error and return a message formatted with the key and insert values provided by the caller. If there is no resource bundle available, just return a message formatted with the key and insert values provided by the caller.

Parameters:

key - - the key to the localized string in the resource bundle.

inserts - - the array of message inserts.

Returns:

the localized string formatted with the message inserts.