com.sap.netweaver.bc.rf.util.exception

Class ResourceMessage

java.lang.Object

com.sap.localization.LocalizableTextFormatter

com.sap.netweaver.bc.rf.util.exception.ResourceMessage

All Implemented Interfaces:

com.sap.localization.Localizable, com.sap.localization.LocalizableText, Serializable

public class ResourceMessage
extends com.sap.localization.LocalizableTextFormatter

Class implementing a resource message wrapping the standard exception location class due to the bad implementation and bad name scheme in that package and the fact that the package seems to be totally misnamed as com.sap.localization being just a localization package for the exception framework. This class also allows to store messages not necessarily being localized in order to support easy exception creation.

Created 19. März 2003

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.localization.LocalizableText

com.sap.localization.LocalizableText.Key0, com.sap.localization.LocalizableText.Key1, com.sap.localization.LocalizableText.Key2, com.sap.localization.LocalizableText.Key3, com.sap.localization.LocalizableText.Key4, com.sap.localization.LocalizableText.Key5, com.sap.localization.LocalizableText.Key6, com.sap.localization.LocalizableText.Msg

Field Summary

Fields inherited from interface com.sap.localization.Localizable

defaultLocale

Constructor Summary

Constructors

Constructor and Description
ResourceMessage(ClassLoader resourceBundleClassLoader, String resourceBundleName, String key) Construct object of class ResourceMessage.
ResourceMessage(ClassLoader resourceBundleClassLoader, String resourceBundleName, String key, Object[] args) Construct object of class ResourceMessage.
ResourceMessage(ResourceAccessor resourceAccessor, String key) Construct object of class ResourceMessage.
ResourceMessage(ResourceAccessor resourceAccessor, String key, Object[] args) Construct object of class ResourceMessage.
ResourceMessage(String message) Construct object of class ResourceMessage.
ResourceMessage(String message, Object[] args) Construct object of class ResourceMessage.

Method Summary

Modifier and Type	Method and Description
void	finallyLocalize() Finally localize the message according to locale and timezone.
void	finallyLocalize(Locale locale) Finally localize the message according to locale and timezone.
void	finallyLocalize(Locale locale, TimeZone timeZone) Finally localize the message according to locale and timezone.
void	finallyLocalize(TimeZone timeZone) Finally localize the message according to locale and timezone.
String	format() Format message according to locale and timezone.
String	format(Locale locale) Format message according to locale and timezone.
String	format(Locale locale, TimeZone timeZone) Format message according to locale and timezone.
String	format(TimeZone timeZone) Format message according to locale and timezone.
Locale	getLocale() Get actual locale to be used for the message.
TimeZone	getTimeZone() Get actual time zone to be used for the message.
void	setLocale(Locale locale) Set actual locale to be used for the message.
void	setTimeZone(TimeZone timeZone) Set actual time zone to be used for the message.

Methods inherited from class com.sap.localization.LocalizableTextFormatter

clearCache, clearLocalizableTextFormatter, createKey0, createKey1, createKey2, createKey3, createKey4, createKey5, createKey6, formatString, formatString, formatString, formatString, formatString, getApplicationName, getArguments, getCacheEntry, getErrorText, getPatternKey, getResourceAccessor, getResourceBundleName, isCacheSetting, isFinallySetting, isLocalFormat, setApplicationName, setArguments, setCacheSetting, setLocalFormat, setPatternKey, setResourceAccessor, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceMessage

public ResourceMessage(String message)

Construct object of class ResourceMessage.

Parameters:

message - not localized message

ResourceMessage

public ResourceMessage(String message,
                       Object[] args)

Construct object of class ResourceMessage.

Parameters:

message - not localized message

args - message arguments inserted by MessageFormat means

ResourceMessage

public ResourceMessage(ClassLoader resourceBundleClassLoader,
                       String resourceBundleName,
                       String key)

Construct object of class ResourceMessage.

Parameters:

resourceBundleClassLoader - class loader having access to the resource bundle

resourceBundleName - resource bundle name used to look up resource bundle

key - resource identifier for localized message

ResourceMessage

public ResourceMessage(ClassLoader resourceBundleClassLoader,
                       String resourceBundleName,
                       String key,
                       Object[] args)

Construct object of class ResourceMessage.

Parameters:

resourceBundleClassLoader - class loader having access to the resource bundle

resourceBundleName - resource bundle name used to look up resource bundle

key - resource identifier for localized message

args - message arguments inserted by MessageFormat means

ResourceMessage

public ResourceMessage(ResourceAccessor resourceAccessor,
                       String key)

Construct object of class ResourceMessage.

Parameters:

resourceAccessor - resource accessor for localized message

key - resource identifier for localized message

ResourceMessage

public ResourceMessage(ResourceAccessor resourceAccessor,
                       String key,
                       Object[] args)

Construct object of class ResourceMessage.

Parameters:

resourceAccessor - resource accessor for localized message

key - resource identifier for localized message

args - message arguments inserted by MessageFormat means

Method Detail

setLocale

public void setLocale(Locale locale)

Set actual locale to be used for the message.

Specified by:

setLocale in interface com.sap.localization.Localizable

Overrides:

setLocale in class com.sap.localization.LocalizableTextFormatter

Parameters:

locale - actual locale to be used for the message

getLocale

public Locale getLocale()

Get actual locale to be used for the message.

Specified by:

getLocale in interface com.sap.localization.Localizable

Overrides:

getLocale in class com.sap.localization.LocalizableTextFormatter

Returns:

actual locale to be used for the message

setTimeZone

public void setTimeZone(TimeZone timeZone)

Set actual time zone to be used for the message.

Specified by:

setTimeZone in interface com.sap.localization.Localizable

Overrides:

setTimeZone in class com.sap.localization.LocalizableTextFormatter

Parameters:

timeZone - actual time zone to be used for the message

getTimeZone

public TimeZone getTimeZone()

Get actual time zone to be used for the message.

Specified by:

getTimeZone in interface com.sap.localization.Localizable

Overrides:

getTimeZone in class com.sap.localization.LocalizableTextFormatter

Returns:

actual time zone to be used for the message

format

public String format()
              throws com.sap.localization.LocalizationException

Format message according to locale and timezone.

Specified by:

format in interface com.sap.localization.LocalizableText

Overrides:

format in class com.sap.localization.LocalizableTextFormatter

Returns:

localized message

Throws:

com.sap.localization.LocalizationException - Exception raised in failure situation

format

public String format(Locale locale)
              throws com.sap.localization.LocalizationException

Format message according to locale and timezone.

Specified by:

format in interface com.sap.localization.LocalizableText

Overrides:

format in class com.sap.localization.LocalizableTextFormatter

Parameters:

locale - locale

Returns:

localized message

Throws:

com.sap.localization.LocalizationException - Exception raised in failure situation

format

public String format(TimeZone timeZone)
              throws com.sap.localization.LocalizationException

Format message according to locale and timezone.

Specified by:

format in interface com.sap.localization.LocalizableText

Overrides:

format in class com.sap.localization.LocalizableTextFormatter

Parameters:

timeZone - time zone

Returns:

localized message

Throws:

com.sap.localization.LocalizationException - Exception raised in failure situation

format

public String format(Locale locale,
                     TimeZone timeZone)
              throws com.sap.localization.LocalizationException

Format message according to locale and timezone.

Specified by:

format in interface com.sap.localization.LocalizableText

Overrides:

format in class com.sap.localization.LocalizableTextFormatter

Parameters:

locale - locale

timeZone - time zone

Returns:

localized message

Throws:

com.sap.localization.LocalizationException - Exception raised in failure situation

finallyLocalize

public void finallyLocalize()
                     throws com.sap.localization.LocalizationException

Finally localize the message according to locale and timezone. The ability to do localization on demand gets lost.

Specified by:

finallyLocalize in interface com.sap.localization.LocalizableText

Overrides:

finallyLocalize in class com.sap.localization.LocalizableTextFormatter

Throws:

com.sap.localization.LocalizationException - Exception raised in failure situation

finallyLocalize

public void finallyLocalize(Locale locale)
                     throws com.sap.localization.LocalizationException

Finally localize the message according to locale and timezone. The ability to do localization on demand gets lost.

Specified by:

finallyLocalize in interface com.sap.localization.LocalizableText

Overrides:

finallyLocalize in class com.sap.localization.LocalizableTextFormatter

Parameters:

locale - locale

Throws:

com.sap.localization.LocalizationException - Exception raised in failure situation

finallyLocalize

public void finallyLocalize(TimeZone timeZone)
                     throws com.sap.localization.LocalizationException

Finally localize the message according to locale and timezone. The ability to do localization on demand gets lost.

Specified by:

finallyLocalize in interface com.sap.localization.LocalizableText

Overrides:

finallyLocalize in class com.sap.localization.LocalizableTextFormatter

Parameters:

timeZone - time zone

Throws:

com.sap.localization.LocalizationException - Exception raised in failure situation

finallyLocalize

public void finallyLocalize(Locale locale,
                            TimeZone timeZone)
                     throws com.sap.localization.LocalizationException

Finally localize the message according to locale and timezone. The ability to do localization on demand gets lost.

Specified by:

finallyLocalize in interface com.sap.localization.LocalizableText

Overrides:

finallyLocalize in class com.sap.localization.LocalizableTextFormatter

Parameters:

locale - locale

timeZone - time zone

Throws:

com.sap.localization.LocalizationException - Exception raised in failure situation