public abstract class StringManager
extends java.lang.Object
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.
Modifier and Type | Field and Description |
---|---|
protected StringManager |
mLast |
static java.lang.String |
NULL_VALUE_BLANK |
static java.lang.String |
NULL_VALUE_EMPTY |
Modifier | Constructor and Description |
---|---|
protected |
StringManager() |
Modifier and Type | Method and Description |
---|---|
void |
addResourceDef(ResourceBundleDef def) |
abstract void |
appendCustomMessageBundles(java.util.ArrayList list) |
abstract java.util.Iterator |
getCustomMessageBundlesIter() |
static java.util.Locale |
getDefaultLocale()
Returns the default Locale for messages, which can be controlled with the
jbo properties jbo.default.language, jbo.default.country and jbo.default.locale.variant.
|
static java.lang.String |
getGeneralExceptionString(ResourceBundleDef resBundleDef,
java.lang.String key,
java.lang.Exception ex)
Constructs a message describing a fatal exception.
|
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,
boolean useDefault)
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 java.lang.String |
getLocalizedString(java.lang.String bundle,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.lang.Object[] values,
boolean useDefault)
Formats and localizes a message using a specified locale.
|
static java.lang.String |
getLocalizedStringFromResourceDef(ResourceBundleDef resBundleDef,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.util.Map values)
Formats and localizes a message using a specified locale.
|
static java.lang.String |
getLocalizedStringFromResourceDef(ResourceBundleDef resourceDef,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.util.Map values,
boolean useDefault)
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)
Uses default locale set on ADFcontext to perform string resolution.
|
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) |
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,
boolean useDefault) |
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) |
protected java.lang.String |
getStringFromResourceDef(ResourceBundleDef resourceDef,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.util.Map values,
boolean useDefault) |
protected java.lang.String |
getStringFromResourceInternal(ResourceBundleDef resourceDef,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.util.Map values,
boolean useDefault) |
protected java.lang.String |
getStringInternal(java.lang.String bundle,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.lang.Object[] values,
boolean useDefault) |
protected java.lang.String |
getStringUsingLocale(java.util.ResourceBundle bundle,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.lang.Object[] values,
boolean useDefault) |
static boolean |
isElString(java.lang.String key) |
void |
releaseBundles() |
abstract void |
removeCustomMessageBundle(java.lang.String clzName) |
void |
removeMessageBundle(java.lang.String key,
java.util.Locale loc) |
java.lang.String |
resolveKeyAsEl(java.lang.String key)
Uses adfcontext's locale for bundle lookup if any.
|
java.lang.String |
resolveKeyAsElWithLocale(java.util.Locale lc,
java.lang.String key) |
protected java.lang.String |
resolveStringWithNamedTokens(java.util.ResourceBundle bundle,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.util.Map values,
boolean useDefault)
Deprecated.
since 12.1.3.1 use version ith locale.
|
protected java.lang.String |
resolveStringWithNamedTokensUsingLocale(java.util.ResourceBundle bundle,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.util.Map values,
boolean useDefault) |
protected java.lang.String |
resolveStringWithTokenFromBundle(ResourceBundleDef resourceDef,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.util.Map values,
boolean useDefault) |
protected java.lang.String |
resolveStringWithTokenFromBundle(java.lang.String bundle,
java.lang.String key,
java.lang.String dflt,
java.util.Locale locale,
java.util.Map values,
boolean useDefault) |
abstract void |
setCustomMessageBundles(java.util.ArrayList list) |
static void |
setExtension(StringManager ext) |
protected StringManager mLast
public static final java.lang.String NULL_VALUE_EMPTY
public static final java.lang.String NULL_VALUE_BLANK
public static StringManager getSingleton()
public void addResourceDef(ResourceBundleDef def)
public void releaseBundles()
public static void setExtension(StringManager ext)
public static final java.lang.String getString(java.lang.String bundle, java.lang.String key, java.lang.String dflt)
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.dflt
if key
is not found.public static final java.lang.String getString(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.lang.Object[] values)
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.dflt
if key
is not found.public static final java.lang.String getLocalizedString(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, boolean useDefault)
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.dflt
if key
is not found.public static final java.lang.String getLocalizedString(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale)
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.dflt
if key
is not found.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)
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.dflt
if key
is not found.public static final java.lang.String getLocalizedStringFromResourceDef(ResourceBundleDef resBundleDef, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.util.Map values)
resBundleDef
- a ResourceBundleDef.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
- a map of message parameters to be inserted into the message.dflt
if key
is not found.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, boolean useDefault)
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.dflt
if key
is not found.public static final java.lang.String getLocalizedStringFromResourceDef(ResourceBundleDef resourceDef, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.util.Map values, boolean useDefault)
resourceDef
- ResourceBundleDef which creates the ResourceBundlekey
- 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
- a map of message parameters to be inserted into the message.dflt
if key
is not found.public static java.util.Locale getDefaultLocale()
public abstract java.util.Iterator getCustomMessageBundlesIter()
public abstract void setCustomMessageBundles(java.util.ArrayList list)
public abstract void appendCustomMessageBundles(java.util.ArrayList list)
public abstract void removeCustomMessageBundle(java.lang.String clzName)
protected final java.lang.String getString(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.lang.Object[] values)
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, boolean useDefault)
protected java.lang.String getStringFromResourceDef(ResourceBundleDef resourceDef, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.util.Map values, boolean useDefault)
protected final java.lang.String getStringInternal(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.lang.Object[] values, boolean useDefault)
@Concealed protected final java.lang.String getStringFromResourceInternal(ResourceBundleDef resourceDef, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.util.Map values, boolean useDefault)
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)
protected java.lang.String resolveStringWithTokenFromBundle(java.lang.String bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.util.Map values, boolean useDefault)
protected java.lang.String resolveStringWithTokenFromBundle(ResourceBundleDef resourceDef, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.util.Map values, boolean useDefault)
public static final boolean isElString(java.lang.String key)
protected java.lang.String getString(java.util.ResourceBundle bundle, java.lang.String key, java.lang.String dflt, java.lang.Object[] values, boolean useDefault)
bundle
- key
- dflt
- locale
- values
- useDefault
- protected java.lang.String getStringUsingLocale(java.util.ResourceBundle bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.lang.Object[] values, boolean useDefault)
public java.lang.String resolveKeyAsEl(java.lang.String key)
key
- to resolvepublic final java.lang.String resolveKeyAsElWithLocale(java.util.Locale lc, java.lang.String key)
protected java.lang.String resolveStringWithNamedTokens(java.util.ResourceBundle bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.util.Map values, boolean useDefault)
bundle
- key
- dflt
- locale
- values
- useDefault
- protected java.lang.String resolveStringWithNamedTokensUsingLocale(java.util.ResourceBundle bundle, java.lang.String key, java.lang.String dflt, java.util.Locale locale, java.util.Map values, boolean useDefault)
public static final java.lang.String getGeneralExceptionString(java.lang.String bundle, java.lang.String key, java.lang.Exception ex)
bundle
- the name of a ResourceBundle
class.key
- a message code found in bundle
.ex
- the exception to be described.public static final java.lang.String getGeneralExceptionString(ResourceBundleDef resBundleDef, java.lang.String key, java.lang.Exception ex)
resBundleDef
- a ResourceBundleDef.key
- a message code found in bundle
.ex
- the exception to be described.public void removeMessageBundle(java.lang.String key, java.util.Locale loc)