davmail

Class BundleMessage

java.lang.Object

davmail.BundleMessage

All Implemented Interfaces:

Serializable

public class BundleMessage
extends Object
implements Serializable

Internationalization message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BundleMessage.BundleMessageList Typed bundle message collection

Field Summary

Fields

Modifier and Type	Field and Description
protected String	key
protected static String	MESSAGE_BUNDLE_NAME
static Locale	ROOT_LOCALE Root locale to get english messages for logging.

Constructor Summary

Constructors

Constructor and Description
BundleMessage(String key, Object... arguments) Internationalization message.

Method Summary

Modifier and Type	Method and Description
String	format() Format message with the default locale.
String	format(Locale locale) Format message with the given locale.
static String	format(Locale locale, String key, Object... arguments) Get formatted message for message key and values with the given locale.
static String	format(String key, Object... arguments) Get formatted message for message key and values with the default locale.
String	formatLog() Format message for logging (with the root locale).
static String	formatLog(String key, Object... arguments) Get formatted log message for message key and values.
protected static ResourceBundle	getBundle(Locale locale) Get bundle for the given locale.
static String	getExceptionLogMessage(BundleMessage message, Exception e) Get formatted error message for bundle message and exception for logging.
static String	getExceptionMessage(BundleMessage message, Exception e) Get formatted error message for bundle message and exception with default locale.
static String	getExceptionMessage(BundleMessage message, Exception e, Locale locale) Get formatted error message for bundle message and exception with given locale.
String	toString() Format message for logging (with the root locale).

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_LOCALE

public static final Locale ROOT_LOCALE

Root locale to get english messages for logging.

MESSAGE_BUNDLE_NAME

protected static final String MESSAGE_BUNDLE_NAME

See Also:

Constant Field Values

key

protected final String key

Constructor Detail

BundleMessage

public BundleMessage(String key,
                     Object... arguments)

Internationalization message.

Parameters:

key - message key in resource bundle

arguments - message values

Method Detail

format

public String format()

Format message with the default locale.

Returns:

formatted message

format

public String format(Locale locale)

Format message with the given locale.

Parameters:

locale - resource bundle locale

Returns:

formatted message

formatLog

public String formatLog()

Format message for logging (with the root locale). Log file should remain in english

Returns:

log formatted message

toString

public String toString()

Format message for logging (with the root locale). Log file should remain in english

Overrides:

toString in class Object

Returns:

log formatted message

getBundle

protected static ResourceBundle getBundle(Locale locale)

Get bundle for the given locale. Load the properties file for the given locale in a resource bundle

Parameters:

locale - resource bundle locale

Returns:

resource bundle

format

public static String format(String key,
                            Object... arguments)

Get formatted message for message key and values with the default locale.

Parameters:

key - message key in resource bundle

arguments - message values

Returns:

formatted message

format

public static String format(Locale locale,
                            String key,
                            Object... arguments)

Get formatted message for message key and values with the given locale.

Parameters:

locale - resource bundle locale

key - message key in resource bundle

arguments - message values

Returns:

formatted message

formatLog

public static String formatLog(String key,
                               Object... arguments)

Get formatted log message for message key and values. Use the root locale

Parameters:

key - message key in resource bundle

arguments - message values

Returns:

formatted message

getExceptionLogMessage

public static String getExceptionLogMessage(BundleMessage message,
                                            Exception e)

Get formatted error message for bundle message and exception for logging. Use the root locale

Parameters:

message - bundle message

e - exception

Returns:

formatted message

getExceptionMessage

public static String getExceptionMessage(BundleMessage message,
                                         Exception e)

Get formatted error message for bundle message and exception with default locale.

Parameters:

message - bundle message

e - exception

Returns:

formatted message

getExceptionMessage

public static String getExceptionMessage(BundleMessage message,
                                         Exception e,
                                         Locale locale)

Get formatted error message for bundle message and exception with given locale.

Parameters:

message - bundle message

e - exception

locale - bundle locale

Returns:

formatted message