oracle.jbo.common
Class StringManager

java.lang.Object
  |
  +--oracle.jbo.common.StringManager

Direct Known Subclasses:

StringManagerImpl

public abstract class StringManager

extends java.lang.Object

Provides methods for managing localizable messages.

This class provides static methods for obtaining unformatted messages from a resource and performing formatting.

This class ia a wrapper for the standard Java ResourceBundle and MessageFormat classes.

This class traps exceptions that may occur while constructing messages, and describes the failure in the message that is returned.

Since:

Jdeveloper 3.0

Constructor Summary

Type	Constructor
protected	StringManager()

Method Summary

Type	Method
abstract void	appendCustomMessageBundles(com.sun.java.util.collections.ArrayList list)
abstract com.sun.java.util.collections.Iterator	getCustomMessageBundlesIter()
static java.lang.String	getGeneralExceptionString(java.lang.String bundle, java.lang.String key, java.lang.Exception ex) Constructs a message describing a fatal exception.
static java.lang.String	getLocalizedString(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale) Localizes a message using a specified locale.
static java.lang.String	getLocalizedString(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.lang.Object[] values) Formats and localizes a message using a specified locale.
static StringManager	getSingleton()
protected java.lang.String	getString(java.util.ResourceBundle bundle, java.lang.String key, java.lang.String dflt, java.lang.Object[] values, boolean useDefault)
static java.lang.String	getString(java.lang.String bundle, java.lang.String key, java.lang.String dflt) Localizes a message using the default locale.
protected java.lang.String	getString(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.lang.Object[] values)
static java.lang.String	getString(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.lang.Object[] values) Formats and localizes a message using the default locale.
protected java.lang.String	getStringFromBundle(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.lang.Object[] values, boolean useDefault)
abstract void	removeCustomMessageBundle(java.lang.String clzName)
abstract void	setCustomMessageBundles(com.sun.java.util.collections.ArrayList list)

Methods inherited from class java.lang.Object

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

Constructor Detail

StringManager

protected StringManager()

Method Detail

getSingleton

public static StringManager getSingleton()

getString

public static final java.lang.String getString(java.lang.String bundle,
                                               java.lang.String key,
                                               java.lang.String dflt)

Localizes a message using the default locale.

Parameters:

bundle - the name of a ResourceBundle class.

key - a message code found in bundle.

dflt - the default value; returned if the message named by key is not found.

Returns:

a localized message, or dflt if key is not found.

getString

public static final java.lang.String getString(java.lang.String bundle,
                                               java.lang.String key,
                                               java.lang.String dflt,
                                               java.lang.Object[] values)

Formats and localizes a message using the default locale.

Parameters:

bundle - the name of a ResourceBundle class.

key - a message code found in bundle.

dflt - the default value; returned if the message named by key is not found.

values - an array of parameters to be inserted into the message.

Returns:

a localized message, or dflt if key is not found.

getLocalizedString

public static final java.lang.String getLocalizedString(java.lang.String bundle,
                                                        java.lang.String key,
                                                        java.lang.String dflt,
                                                        java.util.Locale locale)

Localizes a message using a specified locale.

Parameters:

bundle - the name of a ResourceBundle class.

key - a message code found in bundle.

dflt - the default value; returned if the message named by key is not found.

locale - the target language for the message.

Returns:

a localized message, or dflt if key is not found.

getLocalizedString

public static final java.lang.String getLocalizedString(java.lang.String bundle,
                                                        java.lang.String key,
                                                        java.lang.String dflt,
                                                        java.util.Locale locale,
                                                        java.lang.Object[] values)

Formats and localizes a message using a specified locale.

Parameters:

bundle - the name of a ResourceBundle class.

key - a message code found in bundle.

dflt - the default value; returned if the message named by key is not found.

locale - the target language for the message.

values - an array of message parameters to be inserted into the message.

Returns:

a localized message, or dflt if key is not found.

getCustomMessageBundlesIter

public abstract com.sun.java.util.collections.Iterator getCustomMessageBundlesIter()

setCustomMessageBundles

public abstract void setCustomMessageBundles(com.sun.java.util.collections.ArrayList list)

appendCustomMessageBundles

public abstract void appendCustomMessageBundles(com.sun.java.util.collections.ArrayList list)

removeCustomMessageBundle

public abstract void removeCustomMessageBundle(java.lang.String clzName)

getString

protected java.lang.String getString(java.lang.String bundle,
                                     java.lang.String key,
                                     java.lang.String dflt,
                                     java.util.Locale locale,
                                     java.lang.Object[] values)

getStringFromBundle

protected java.lang.String getStringFromBundle(java.lang.String bundle,
                                               java.lang.String key,
                                               java.lang.String dflt,
                                               java.util.Locale locale,
                                               java.lang.Object[] values,
                                               boolean useDefault)

getString

protected java.lang.String getString(java.util.ResourceBundle bundle,
                                     java.lang.String key,
                                     java.lang.String dflt,
                                     java.lang.Object[] values,
                                     boolean useDefault)

getGeneralExceptionString

public static final java.lang.String getGeneralExceptionString(java.lang.String bundle,
                                                               java.lang.String key,
                                                               java.lang.Exception ex)

Constructs a message describing a fatal exception.

Parameters:

bundle - the name of a ResourceBundle class.

key - a message code found in bundle.

ex - the exception to be described.

Returns:

the message.