openthinks.libs.i18n

Class I18n

java.lang.Object

openthinks.libs.i18n.I18n

public final class I18n
extends java.lang.Object

Help for multi-languages, use this class as entry.

Author:

dailey_dai

Method Summary

Modifier and Type	Method and Description
static void	configurePackContext(IMessageContext messageContext) Set i18n message context.
static <T extends IMessage> java.lang.String	getMessage(java.lang.Class<T> entityClazz, java.util.Locale locale, java.lang.String messageId, java.lang.Object... args) get message by message entity class type, locale, message id and arguments. it is best to use it as retrieve persist message from database.
static <T extends IMessage> java.lang.String	getMessage(java.lang.Class<T> entityClazz, java.lang.String messageId, java.lang.Object... args)
static java.lang.String	getMessage(IMessageType messageType, java.util.Locale locale, java.lang.String messageId, java.lang.Object... args) get message by message type, locale,message id and arguments.
static java.lang.String	getMessage(IMessageType messageType, java.lang.String messageId, java.lang.Object... args) get message by message type,Locale.getDefault(),message id and arguments.
static java.lang.String	getMessage(java.lang.String packName, java.util.Locale locale, java.lang.String messageId, java.lang.Object... args) get message by message pack/persist name,locale,message id and arguments.
static java.lang.String	getMessage(java.lang.String packName, java.lang.String messageId, java.lang.Object... args) get message by message pack/persist name,Locale.getDefault(),message id and arguments.
static java.util.ResourceBundle	getResourceBundle(IBundleMessageType messageType) get ResourceBundle instance by the instance of IBundleMessageType and the default/current locale maintain by I18nApplicationLocale
static java.util.ResourceBundle	getResourceBundle(IBundleMessageType messageType, java.util.Locale locale) get ResourceBundle instance by the instance of IBundleMessageType and the special Locale
static java.util.ResourceBundle	getResourceBundle(java.lang.String packName)
static java.util.ResourceBundle	getResourceBundle(java.lang.String packName, java.util.Locale locale)

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public static java.lang.String getMessage(java.lang.String packName,
                                          java.util.Locale locale,
                                          java.lang.String messageId,
                                          java.lang.Object... args)

get message by message pack/persist name,locale,message id and arguments. it will check the IMessageContext, if user not call the method
I18n.configurePackContext(IMessageContext messageContext) to set a message context;
it will use the default message context BundleMessageContext

Parameters:

packName - String message pack/persist name

locale - Locale special locale

messageId - message key id

args - message format arguments

Returns:

String the final i18n message for the special locale

getMessage

public static java.lang.String getMessage(java.lang.String packName,
                                          java.lang.String messageId,
                                          java.lang.Object... args)

get message by message pack/persist name,Locale.getDefault(),message id and arguments.

Parameters:

packName - String message pack/persist name

messageId - String message key id

args - Object[] message format arguments

Returns:

String the final i18n message for the default locale

getMessage

public static <T extends IMessage> java.lang.String getMessage(java.lang.Class<T> entityClazz,
                                                               java.util.Locale locale,
                                                               java.lang.String messageId,
                                                               java.lang.Object... args)

get message by message entity class type, locale, message id and arguments.
it is best to use it as retrieve persist message from database.

Parameters:

entityClazz - Entity message class type

locale - Locale

messageId - String

args - Object[]

Returns:

String

getMessage

public static <T extends IMessage> java.lang.String getMessage(java.lang.Class<T> entityClazz,
                                                               java.lang.String messageId,
                                                               java.lang.Object... args)

getMessage

public static java.lang.String getMessage(IMessageType messageType,
                                          java.util.Locale locale,
                                          java.lang.String messageId,
                                          java.lang.Object... args)

get message by message type, locale,message id and arguments.

Parameters:

messageType - IMessageType

locale - Locale special locale

messageId - message key id

args - message format arguments

Returns:

String the final i18n message for the special locale

getMessage

public static java.lang.String getMessage(IMessageType messageType,
                                          java.lang.String messageId,
                                          java.lang.Object... args)

get message by message type,Locale.getDefault(),message id and arguments.

Parameters:

messageType - IMessageType

locale - Locale special locale

messageId - message key id

args - message format arguments

Returns:

String the final i18n message for the default locale

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(java.lang.String packName,
                                                         java.util.Locale locale)

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(java.lang.String packName)

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(IBundleMessageType messageType,
                                                         java.util.Locale locale)

get ResourceBundle instance by the instance of IBundleMessageType and the special Locale

Parameters:

messageType - IBundleMessageType

locale - Locale

Returns:

ResourceBundle the final i18n resource bundle for the special locale

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(IBundleMessageType messageType)

get ResourceBundle instance by the instance of IBundleMessageType and the default/current locale maintain by I18nApplicationLocale

Parameters:

messageType - IBundleMessageType

Returns:

ResourceBundle the final i18n resource bundle for the default/current locale maintain by I18nApplicationLocale

configurePackContext

public static void configurePackContext(IMessageContext messageContext)

Set i18n message context.

Parameters:

messageContext - IMessageContext