org.mule.runtime.api.i18n

Class I18nMessageFactory

java.lang.Object

org.mule.runtime.api.i18n.I18nMessageFactory

Direct Known Subclasses:

CoreMessages

public abstract class I18nMessageFactory
extends Object

Base MessageFactory for I18n supported messages.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceBundle.Control	DEFAULT_RELOAD_CONTROL Default is ReloadControl.Always.
protected static ResourceBundle.Control	reloadControl Do not use the default reload control to avoid loading the resource bundle upon each request.

Constructor Summary

Constructors

Constructor and Description
I18nMessageFactory()

Method Summary

Modifier and Type	Method and Description
protected I18nMessage	createMessage(String bundlePath, int code) Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.
protected I18nMessage	createMessage(String bundlePath, int code, Object... arguments) Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.
protected I18nMessage	createMessage(String bundlePath, int code, Object arg) Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.
protected I18nMessage	createMessage(String bundlePath, int code, Object arg1, Object arg2) Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.
protected I18nMessage	createMessage(String bundlePath, int code, Object arg1, Object arg2, Object arg3) Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.
static I18nMessage	createStaticMessage(String message) Factory method to create a I18nMessage instance that is not read from a resource bundle.
static I18nMessage	createStaticMessage(String message, Object... arguments) Factory method to create a I18nMessage instance that is not read from a resource bundle.
protected ResourceBundle	getBundle(String bundlePath)
protected static String	getBundlePath(String bundleName) Computes the bundle's full path (META-INF/org/mule/i18n/<bundleName>-messages.properties) from bundleName.
protected ClassLoader	getClassLoader() Override this method to return the classloader for the bundle/module which contains the needed resource files.
protected ResourceBundle.Control	getReloadControl() Subclasses should override to customize the bundle reload control.
protected String	getString(String bundlePath, int code) Factory method to read the message with code code from the resource bundle.
protected String	getString(String bundlePath, int code, Object arg) Factory method to read the message with code code from the resource bundle.
protected String	getString(String bundlePath, int code, Object[] args)
protected String	getString(String bundlePath, int code, Object arg1, Object arg2) Factory method to read the message with code code from the resource bundle.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RELOAD_CONTROL

public static final ResourceBundle.Control DEFAULT_RELOAD_CONTROL

Default is ReloadControl.Always.

reloadControl

protected static final ResourceBundle.Control reloadControl

Do not use the default reload control to avoid loading the resource bundle upon each request. Subclasses can override to provide a different default.

Constructor Detail

I18nMessageFactory

public I18nMessageFactory()

Method Detail

getBundlePath

protected static String getBundlePath(String bundleName)

Computes the bundle's full path (META-INF/org/mule/i18n/<bundleName>-messages.properties) from bundleName.

Parameters:

bundleName - Name of the bundle without the "messages" suffix and without file extension.

createMessage

protected I18nMessage createMessage(String bundlePath,
                                    int code,
                                    Object arg)

Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.

Parameters:

bundlePath - complete path to the resource bundle for lookup

code - numeric code of the message

arg -

See Also:

getBundlePath(String)

createMessage

protected I18nMessage createMessage(String bundlePath,
                                    int code,
                                    Object arg1,
                                    Object arg2)

Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.

Parameters:

bundlePath - complete path to the resource bundle for lookup

code - numeric code of the message

arg1 -

arg2 -

See Also:

getBundlePath(String)

createMessage

protected I18nMessage createMessage(String bundlePath,
                                    int code,
                                    Object arg1,
                                    Object arg2,
                                    Object arg3)

Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.

Parameters:

bundlePath - complete path to the resource bundle for lookup

code - numeric code of the message

arg1 -

arg2 -

arg3 -

See Also:

getBundlePath(String)

createMessage

protected I18nMessage createMessage(String bundlePath,
                                    int code,
                                    Object... arguments)

Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath. Attention: do not confuse this method with this#createMessage.

Parameters:

bundlePath - complete path to the resource bundle for lookup

code - numeric code of the message

arguments -

See Also:

getBundlePath(String)

createMessage

protected I18nMessage createMessage(String bundlePath,
                                    int code)

Factory method to create a new I18nMessage instance that is filled with the formatted message with id code from the resource bundle bundlePath.

Parameters:

bundlePath - complete path to the resource bundle for lookup

code - numeric code of the message

createStaticMessage

public static I18nMessage createStaticMessage(String message)

Factory method to create a I18nMessage instance that is not read from a resource bundle.

Parameters:

message - Message's message text

Returns:

a Messsage instance that has an error code of -1 and no arguments.

createStaticMessage

public static I18nMessage createStaticMessage(String message,
                                              Object... arguments)

Factory method to create a I18nMessage instance that is not read from a resource bundle.

Parameters:

message - Static message text that may contain format specifiers

arguments - Arguments referenced by the format specifiers in the message string.

Returns:

a Messsage instance that has an error code of -1 and no arguments.

getString

protected String getString(String bundlePath,
                           int code)

Factory method to read the message with code code from the resource bundle.

Parameters:

bundlePath - complete path to the resource bundle for lookup

code - numeric code of the message

Returns:

formatted error message as String

getString

protected String getString(String bundlePath,
                           int code,
                           Object arg)

Factory method to read the message with code code from the resource bundle.

Parameters:

bundlePath - complete path to the resource bundle for lookup

code - numeric code of the message

arg -

Returns:

formatted error message as String

getString

protected String getString(String bundlePath,
                           int code,
                           Object arg1,
                           Object arg2)

Factory method to read the message with code code from the resource bundle.

Parameters:

bundlePath - complete path to the resource bundle for lookup

code - numeric code of the message

arg1 -

arg2 -

Returns:

formatted error message as String

getString

protected String getString(String bundlePath,
                           int code,
                           Object[] args)

getBundle

protected ResourceBundle getBundle(String bundlePath)

Throws:

MissingResourceException - if resource is missing

getClassLoader

protected ClassLoader getClassLoader()

Override this method to return the classloader for the bundle/module which contains the needed resource files.

getReloadControl

protected ResourceBundle.Control getReloadControl()

Subclasses should override to customize the bundle reload control. Implementations must save the instance in a field for stateful reload control. Return null to fallback to default JVM behavior (permanent cache).

See Also:

DEFAULT_RELOAD_CONTROL