org.jahia.utils.i18n

Class Messages

java.lang.Object

org.jahia.utils.i18n.Messages

public final class Messages
extends Object

Jahia i18n message utilities.

Author:

Sergiy Shyrkov

Method Summary

Modifier and Type	Method and Description
static String	format(String text, Locale locale, Object... arguments) Returns the formatted messages with placeholders substituted by argument values.
static String	format(String text, Object... arguments) Returns the formatted messages with placeholders substituted by argument values.
static String	get(JahiaTemplatesPackage pkg, String key, Locale locale) Looks up the resource bundle key considering locale and current module.
static String	get(JahiaTemplatesPackage pkg, String key, Locale locale, String defaultValue) Looks up the resource bundle key considering locale and current module.
static String	get(ResourceBundle bundle, String key, String defaultValue) Looks up the resource bundle key considering locale and specified ResourceBundle instance.
static String	get(String primaryBundleName, JahiaTemplatesPackage pkg, String key, Locale locale) Looks up the resource bundle key considering locale, specified bundle name and current module.
static String	get(String primaryBundleName, JahiaTemplatesPackage pkg, String key, Locale locale, String defaultValue) Looks up the resource bundle key considering locale, specified bundle name and current module.
static String	get(String bundle, String key, Locale locale) Looks up the resource bundle key considering locale and specified bundle name.
static String	get(String bundle, String key, Locale locale, String defaultValue) Looks up the resource bundle key considering locale and specified bundle name.
static String	getInternal(String key, Locale locale) Looks up the resource bundle key in the ResourceBundles.JAHIA_INTERNAL_RESOURCES bundle, considering locale.
static String	getInternal(String key, Locale locale, String defaultValue) Looks up the resource bundle key in the ResourceBundles.JAHIA_INTERNAL_RESOURCES bundle, considering locale.
static String	getInternalWithArguments(String key, Locale locale, Object... args) Looks up the resource bundle key in the ResourceBundles.JAHIA_INTERNAL_RESOURCES bundle, considering locale.
static String	getInternalWithArguments(String key, String defaultValue, Locale locale, Object... args) Looks up the resource bundle key in the ResourceBundles.JAHIA_INTERNAL_RESOURCES bundle, considering locale.
static String	getNonEmpty(String bundle, String key, Locale locale) Looks up the resource bundle key in the specified bundle, considering locale.
static String	getTypes(String key, Locale locale, String defaultValue) Looks up the resource bundle key in the ResourceBundles.JAHIA_TYPES_RESOURCES bundle, considering locale.
static String	getWithArgs(ResourceBundle bundle, String key, Object... arguments) Looks up the resource bundle key in the specified bundle.
static String	getWithArgs(ResourceBundle bundle, String key, String defaultValue, Object... arguments) Looks up the resource bundle key in the specified bundle.
static String	getWithArgs(String bundle, String key, Locale locale, Object... arguments) Looks up the resource bundle key in the specified bundle, considering locale.
static String	interpolateResourceBundleMacro(String input, Locale locale, JahiaTemplatesPackage module) Performs the interpolation (evaluation) of the resource bundle macro in the provided input.

Methods inherited from class java.lang.Object

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

Method Detail

format

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

Returns the formatted messages with placeholders substituted by argument values.

Parameters:

text - the message text with placeholders

arguments - an array of arguments to be used for substitution

Returns:

the formatted messages with placeholders substituted by argument values

format

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

Returns the formatted messages with placeholders substituted by argument values.

Parameters:

text - the message text with placeholders

locale - the current locale

arguments - an array of arguments to be used for substitution

Returns:

the formatted messages with placeholders substituted by argument values

get

public static String get(JahiaTemplatesPackage pkg,
                         String key,
                         Locale locale)

Looks up the resource bundle key considering locale and current module.

Parameters:

pkg - the current module

key - the key to perform lookup for

locale - current locale

Returns:

the label for the requested key

get

public static String get(JahiaTemplatesPackage pkg,
                         String key,
                         Locale locale,
                         String defaultValue)

Looks up the resource bundle key considering locale and current module. If not found the specified default value is returned.

Parameters:

pkg - the current module

key - the key to perform lookup for

locale - current locale

defaultValue - the default value to return if the lookup has not found anything

Returns:

the label for the requested key; if not found the provided default value it returned

get

public static String get(ResourceBundle bundle,
                         String key,
                         String defaultValue)

Looks up the resource bundle key considering locale and specified ResourceBundle instance. If not found the specified default value is returned.

Parameters:

bundle - the resource bundle key to lookup the key

key - the key to perform lookup for

locale - current locale

defaultValue - the default value to return if the lookup has not found anything

Returns:

the label for the requested key; if not found the provided default value it returned

get

public static String get(String primaryBundleName,
                         JahiaTemplatesPackage pkg,
                         String key,
                         Locale locale)

Looks up the resource bundle key considering locale, specified bundle name and current module.

Parameters:

primaryBundleName - the resource bundle name to perform lookup for the first turn

pkg - the current module

key - the key to perform lookup for

locale - current locale

defaultValue - the default value to return if the lookup has not found anything

Returns:

the label for the requested key

get

public static String get(String primaryBundleName,
                         JahiaTemplatesPackage pkg,
                         String key,
                         Locale locale,
                         String defaultValue)

Looks up the resource bundle key considering locale, specified bundle name and current module. If not found the specified default value is returned.

Parameters:

primaryBundleName - the resource bundle name to perform lookup for the first turn

pkg - the current module

key - the key to perform lookup for

locale - current locale

defaultValue - the default value to return if the lookup has not found anything

Returns:

the label for the requested key; if not found the provided default value it returned

get

public static String get(String bundle,
                         String key,
                         Locale locale)
                  throws MissingResourceException

Looks up the resource bundle key considering locale and specified bundle name.

Parameters:

bundle - the bundle name to perform the lookup, must use "resources" prefix i. e. resources.JahiaServerSettings

key - the key to perform lookup for

locale - current locale

Returns:

the label for the requested key

Throws:

MissingResourceException - in case the key is not found in the specified bundle

get

public static String get(String bundle,
                         String key,
                         Locale locale,
                         String defaultValue)

Looks up the resource bundle key considering locale and specified bundle name. If not found the specified default value is returned.

Parameters:

bundle - the bundle name to perform the lookup, must use "resources" prefix i. e. resources.JahiaServerSettings

key - the key to perform lookup for

locale - current locale

defaultValue - the default value to return if the lookup has not found anything

Returns:

the label for the requested key; if not found the provided default value it returned

getInternal

public static String getInternal(String key,
                                 Locale locale)

Looks up the resource bundle key in the ResourceBundles.JAHIA_INTERNAL_RESOURCES bundle, considering locale. This method does not throw MissingResourceException in case the key is not found, but rather returns the key itself.

Parameters:

key - the key to perform lookup for

locale - current locale

Returns:

the label for the requested key

See Also:

getNonEmpty(String, String, Locale)

getInternal

public static String getInternal(String key,
                                 Locale locale,
                                 String defaultValue)

Looks up the resource bundle key in the ResourceBundles.JAHIA_INTERNAL_RESOURCES bundle, considering locale. If not found the specified default value is returned.

Parameters:

key - the key to perform lookup for

locale - current locale

defaultValue - the default value to return if the lookup has not found anything

Returns:

the label for the requested key; if not found the provided default value it returned

getInternalWithArguments

public static String getInternalWithArguments(String key,
                                              Locale locale,
                                              Object... args)

Looks up the resource bundle key in the ResourceBundles.JAHIA_INTERNAL_RESOURCES bundle, considering locale. Additionally placeholders are replaced with the provided arguments.

Parameters:

key - the key to perform lookup for

locale - current locale

args - the arguments to replace placeholders with

Returns:

the label for the requested key

getInternalWithArguments

public static String getInternalWithArguments(String key,
                                              String defaultValue,
                                              Locale locale,
                                              Object... args)

Looks up the resource bundle key in the ResourceBundles.JAHIA_INTERNAL_RESOURCES bundle, considering locale. Additionally placeholders are replaced with the provided arguments.

Parameters:

key - the key to perform lookup for

defaultValue - the default value to return if the lookup has not found anything

locale - current locale

args - the arguments to replace placeholders with

Returns:

the label for the requested key

getNonEmpty

public static String getNonEmpty(String bundle,
                                 String key,
                                 Locale locale)

Looks up the resource bundle key in the specified bundle, considering locale. This method does not throw MissingResourceException in case the key is not found, but rather returns the key itself.

Parameters:

bundle - the bundle name to perform the lookup

key - the key to perform lookup for

locale - current locale

Returns:

the label for the requested key

getTypes

public static String getTypes(String key,
                              Locale locale,
                              String defaultValue)

Looks up the resource bundle key in the ResourceBundles.JAHIA_TYPES_RESOURCES bundle, considering locale. If not found the specified default value is returned.

Parameters:

key - the key to perform lookup for

locale - current locale

defaultValue - the default value to return if the lookup has not found anything

Returns:

the label for the requested key; if not found the provided default value it returned

getWithArgs

public static String getWithArgs(ResourceBundle bundle,
                                 String key,
                                 Object... arguments)
                          throws MissingResourceException

Looks up the resource bundle key in the specified bundle. Additionally placeholders are replaced with the provided arguments.

Parameters:

bundle - the bundle to perform the lookup in

key - the key to perform lookup for

args - the arguments to replace placeholders with

Returns:

the label for the requested key

Throws:

MissingResourceException

getWithArgs

public static String getWithArgs(ResourceBundle bundle,
                                 String key,
                                 String defaultValue,
                                 Object... arguments)
                          throws MissingResourceException

Looks up the resource bundle key in the specified bundle. Additionally placeholders are replaced with the provided arguments.

Parameters:

bundle - the bundle to perform the lookup in

key - the key to perform lookup for

defaultValue - the default value to return if the lookup has not found anything

args - the arguments to replace placeholders with

Returns:

the label for the requested key

Throws:

MissingResourceException

getWithArgs

public static String getWithArgs(String bundle,
                                 String key,
                                 Locale locale,
                                 Object... arguments)
                          throws MissingResourceException

Looks up the resource bundle key in the specified bundle, considering locale. Additionally placeholders are replaced with the provided arguments.

Parameters:

bundle - the bundle name to perform the lookup

key - the key to perform lookup for

locale - current locale

args - the arguments to replace placeholders with

Returns:

the label for the requested key

Throws:

MissingResourceException

interpolateResourceBundleMacro

public static String interpolateResourceBundleMacro(String input,
                                                    Locale locale,
                                                    JahiaTemplatesPackage module)

Performs the interpolation (evaluation) of the resource bundle macro in the provided input.

Parameters:

input - the text to be interpolated

locale - current local

module - current module

Returns:

the text after evaluation of the resource bundle macros