ilog.views.util

Class IlvResourceUtil

java.lang.Object

ilog.views.util.IlvResourceUtil

public class IlvResourceUtil
extends Object

Utilities for resource bundles.

Use of this class, instead of ResourceBundle.getBundle, allows applets loaded over http to perform only a minimal number of http requests (assuming the applet's main code uses the setAvailableResourceSuffixes(java.lang.String...) method to specify which locale is supported by the applet's resources).

The second idea here is not to hard code resource bundle paths. Instead, we pass the corresponding class. The advantage: if classes are moved, the resource bundle path is also up to date.

For example:

 String s = IlvResourceUtil.getString(key, Myclass.class);
 

It is not recommended to use this utility with an implicit class reference such as

 String s = IlvResourceUtil.getString(key, getClass());
 

because this variant works only if all subclasses of the current class are in the same package.

Since:

JViews 8.1

Method Summary

Modifier and Type	Method and Description
static ResourceBundle	getBundle(String baseName) Deprecated. Since JViews 8.6, use getBundle(String, ClassLoader). This method is unsafe since it used to lead to different results in different JDKs, if multiple class loaders are used in your application. Hence we strongly recommend not to use it anymore.
static ResourceBundle	getBundle(String name, Class<?> clazz) Deprecated. Since JViews 8.7, please use the method getBundle(String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
static ResourceBundle	getBundle(String name, Class<?> clazz, Locale locale) Returns the resource bundle in the package of the input class.
static ResourceBundle	getBundle(String name, Class<?> clazz, com.ibm.icu.util.ULocale locale) Returns the resource bundle in the package of the input class.
static ResourceBundle	getBundle(String baseName, ClassLoader loader) Deprecated. Since JViews 8.7, please use the method getBundle(String, Locale, ClassLoader) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
static ResourceBundle	getBundle(String baseName, Locale locale) Deprecated. Since JViews 8.6, use getBundle(String, Locale, ClassLoader). This method is unsafe since it used to lead to different results in different JDKs, if multiple class loaders are used in your application. Hence we strongly recommend not to use it anymore.
static ResourceBundle	getBundle(String baseName, Locale locale, ClassLoader loader) Returns a resource bundle, examining the available resource suffixes.
static ResourceBundle	getBundle(String baseName, com.ibm.icu.util.ULocale locale, ClassLoader loader) Returns a resource bundle, examining the available resource suffixes.
static String	getCurrentLocaleString(Class<?> clazz, String subkey) Returns a string for the given subkey from the resource bundle named "messages" in the package of the input object.
static String	getSafeString(String key, Class<?> clazz) Deprecated. Since JViews 8.7, please use the method getSafeString(String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
static String	getSafeString(String key, Class<?> clazz, Locale locale) Returns a string for the given key from the resource bundle named "messages" in the package of the input class.
static String	getSafeString(String key, Class<?> clazz, com.ibm.icu.util.ULocale locale) Returns a string for the given key from the resource bundle named "messages" in the package of the input class.
static String	getSafeString(String key, String bundle, Class<?> clazz) Deprecated. Since JViews 8.7, please use the method getSafeString(String, String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
static String	getSafeString(String key, String bundle, Class<?> clazz, Locale locale) Returns a string for the given key from the resource bundle in the package of the input class.
static String	getSafeString(String key, String bundle, Class<?> clazz, com.ibm.icu.util.ULocale locale) Returns a string for the given key from the resource bundle in the package of the input class.
static String	getServerLocaleString(Class<?> clazz, String subkey) Returns a string for the given subkey from the resource bundle named "messages" in the package of the input object.
static String	getString(String key, Class<?> clazz) Deprecated. Since JViews 8.7, please use the method getString(String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
static String	getString(String key, Class<?> clazz, Locale locale) Returns a string for the given key from the resource bundle named "messages" in the package of the input class.
static String	getString(String key, Class<?> clazz, Locale locale, String defString) Returns a string for the given key from the resource bundle named "messages" in the package of the input class.
static String	getString(String key, Class<?> clazz, String defString) Deprecated. Since JViews 8.7, please use the method getString(String, Class, Locale, String) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
static String	getString(String key, Class<?> clazz, com.ibm.icu.util.ULocale locale) Returns a string for the given key from the resource bundle named "messages" in the package of the input class.
static String	getString(String key, Class<?> clazz, com.ibm.icu.util.ULocale locale, String defString) Returns a string for the given key from the resource bundle named "messages" in the package of the input class.
static String	getString(String key, String bundle, Class<?> clazz) Deprecated. Since JViews 8.7, please use the method getString(String, String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
static String	getString(String key, String bundle, Class<?> clazz, Locale locale) Returns a string for the given key from the resource bundle in the package of the input class.
static String	getString(String key, String bundle, Class<?> clazz, Locale locale, String defString) Returns a string for the given key from the resource bundle in the package of the input class.
static String	getString(String key, String bundle, Class<?> clazz, String defString) Deprecated. Since JViews 8.7, please use the method getString(String, String, Class, Locale, String) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().
static String	getString(String key, String bundle, Class<?> clazz, com.ibm.icu.util.ULocale locale) Returns a string for the given key from the resource bundle in the package of the input class.
static String	getString(String key, String bundle, Class<?> clazz, com.ibm.icu.util.ULocale locale, String defString) Returns a string for the given key from the resource bundle in the package of the input class.
static boolean	isInApplet() Tests whether we are running inside an applet.
static void	setAvailableResourceLocales(Locale... locales) Sets the available resource locales.
static void	setAvailableResourceLocales(com.ibm.icu.util.ULocale... locales) Sets the available resource locales.
static void	setAvailableResourceSuffixes(String... suffixes) Sets the available resource suffixes.
static void	setDebug(int debug) Sets the debugging mode.

Methods inherited from class java.lang.Object

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

Method Detail

getString

@Deprecated
public static String getString(String key,
                                           Class<?> clazz)

Deprecated. Since JViews 8.7, please use the method getString(String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class. The default locale is used.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

Returns:

the string for the given key

Throws:

MissingResourceException - if no string for the given key can be found

getString

public static String getString(String key,
                               Class<?> clazz,
                               Locale locale)

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Returns:

the string for the given key

Throws:

MissingResourceException - if no string for the given key can be found

getString

public static String getString(String key,
                               Class<?> clazz,
                               com.ibm.icu.util.ULocale locale)

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Returns:

the string for the given key

Throws:

MissingResourceException - if no string for the given key can be found

Since:

JViews 8.9

getString

@Deprecated
public static String getString(String key,
                                           String bundle,
                                           Class<?> clazz)

Deprecated. Since JViews 8.7, please use the method getString(String, String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class. The default locale is used.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

Returns:

the string for the given key

Throws:

MissingResourceException - if no string for the given key can be found

getString

public static String getString(String key,
                               String bundle,
                               Class<?> clazz,
                               Locale locale)

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Returns:

the string for the given key

Throws:

MissingResourceException - if no string for the given key can be found

getString

public static String getString(String key,
                               String bundle,
                               Class<?> clazz,
                               com.ibm.icu.util.ULocale locale)

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Returns:

the string for the given key

Throws:

MissingResourceException - if no string for the given key can be found

Since:

JViews 8.9

getString

@Deprecated
public static String getString(String key,
                                           Class<?> clazz,
                                           String defString)

Deprecated. Since JViews 8.7, please use the method getString(String, Class, Locale, String) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class. The default locale is used.

This variant does not throw missing resource exceptions. If the resource is missing, the default string is returned instead.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

defString - If the resource bundle is not found or no string for the given key can be found, this default string is returned.

Returns:

the string for the given key

getString

public static String getString(String key,
                               Class<?> clazz,
                               Locale locale,
                               String defString)

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class.

This variant does not throw missing resource exceptions. If the resource is missing, the default string is returned instead.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

defString - If the resource bundle is not found or no string for the given key can be found, this default string is returned.

Returns:

the string for the given key

getString

public static String getString(String key,
                               Class<?> clazz,
                               com.ibm.icu.util.ULocale locale,
                               String defString)

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class.

This variant does not throw missing resource exceptions. If the resource is missing, the default string is returned instead.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

defString - If the resource bundle is not found or no string for the given key can be found, this default string is returned.

Returns:

the string for the given key

Since:

JViews 8.9

getString

@Deprecated
public static String getString(String key,
                                           String bundle,
                                           Class<?> clazz,
                                           String defString)

Deprecated. Since JViews 8.7, please use the method getString(String, String, Class, Locale, String) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class. The default locale is used.

This variant does not throw missing resource exceptions. If the resource is missing, the default string is returned instead.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

defString - If the resource bundle is not found or no string for the given key can be found, this default string is returned.

Returns:

the string for the given key

getString

public static String getString(String key,
                               String bundle,
                               Class<?> clazz,
                               Locale locale,
                               String defString)

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class.

This variant does not throw missing resource exceptions. If the resource is missing, the default string is returned instead.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

defString - If the resource bundle is not found or no string for the given key can be found, this default string is returned.

Returns:

the string for the given key

getString

public static String getString(String key,
                               String bundle,
                               Class<?> clazz,
                               com.ibm.icu.util.ULocale locale,
                               String defString)

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class.

This variant does not throw missing resource exceptions. If the resource is missing, the default string is returned instead.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

defString - If the resource bundle is not found or no string for the given key can be found, this default string is returned.

Returns:

the string for the given key

Since:

JViews 8.9

getSafeString

@Deprecated
public static String getSafeString(String key,
                                               Class<?> clazz)

Deprecated. Since JViews 8.7, please use the method getSafeString(String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class. The default locale is used.

This variant does not throw missing resource exceptions. If the resource is missing, the key is returned instead.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

Returns:

the string for the given key

getSafeString

public static String getSafeString(String key,
                                   Class<?> clazz,
                                   Locale locale)

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class.

This variant does not throw missing resource exceptions. If the resource is missing, the key is returned instead.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Returns:

the string for the given key

getSafeString

public static String getSafeString(String key,
                                   Class<?> clazz,
                                   com.ibm.icu.util.ULocale locale)

Returns a string for the given key from the resource bundle named "messages" in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the string "messages". The class loader is determined from the input class.

This variant does not throw missing resource exceptions. If the resource is missing, the key is returned instead.

Parameters:

key - The key of the resource string.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Returns:

the string for the given key

Since:

JViews 8.9

getSafeString

@Deprecated
public static String getSafeString(String key,
                                               String bundle,
                                               Class<?> clazz)

Deprecated. Since JViews 8.7, please use the method getSafeString(String, String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class. The default locale is used.

This variant does not throw missing resource exceptions. If the resource is missing, the key is returned instead.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

Returns:

the string for the given key

getSafeString

public static String getSafeString(String key,
                                   String bundle,
                                   Class<?> clazz,
                                   Locale locale)

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class.

This variant does not throw missing resource exceptions. If the resource is missing, the key is returned instead.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Returns:

the string for the given key

getSafeString

public static String getSafeString(String key,
                                   String bundle,
                                   Class<?> clazz,
                                   com.ibm.icu.util.ULocale locale)

Returns a string for the given key from the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the bundle name. The class loader is determined from the input class.

This variant does not throw missing resource exceptions. If the resource is missing, the key is returned instead.

Parameters:

key - The key of the resource string.

bundle - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Returns:

the string for the given key

Since:

JViews 8.9

getBundle

@Deprecated
public static ResourceBundle getBundle(String name,
                                                   Class<?> clazz)

Deprecated. Since JViews 8.7, please use the method getBundle(String, Class, Locale) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Returns the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the input name. The class loader is determined from the input class. The default locale is used.

Parameters:

name - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

getBundle

public static ResourceBundle getBundle(String name,
                                       Class<?> clazz,
                                       Locale locale)

Returns the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the input name. The class loader is determined from the input class.

Parameters:

name - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

getBundle

public static ResourceBundle getBundle(String name,
                                       Class<?> clazz,
                                       com.ibm.icu.util.ULocale locale)

Returns the resource bundle in the package of the input class. The fully qualified name is determined by concatenating the path of the class and the input name. The class loader is determined from the input class.

Parameters:

name - The base name of the resource bundle excluding the package name.

clazz - The input class, to determine the package name and the class loader.

locale - The locale.

Since:

JViews 8.9

setAvailableResourceSuffixes

public static void setAvailableResourceSuffixes(String... suffixes)

Sets the available resource suffixes. This is useful for applets that don't provide resources for all possible locales. Normally, if a resource is requested for a locale that is not available, several unsuccessful requests are made to the server to load the resource. This slows down the applet. When setting the available resource suffixes, the requests are avoided for those locales that don't match the available suffixes, and instead the resource bundle for the best matching default locale is loaded. This speeds up the applet.

The following sample shows how to use the API:

 IlvResourceUtil.setAvailableResourceSuffixes("", "_fr", "_de");
 

This statement specifies that the default bundle (""), the generic French bundle ("_fr") and the generic German bundle ("_de") are available. If the locale is currently Canadian French, it will not try to load the bundle "_fr_CA" but immediately use the bundle "fr" instead.

In order to set back to the default behavior, call:

 IlvResourceUtil.setAvailableResourceSuffixes((String[]) null);
 

Suffixes have the following formats:

• "" - the empty string indicates the default bundle
• "_language"
• "_language_country"
• "_language_country_variant"

The language part is a valid ISO Language Code. These codes are the lower-case, two-letter codes as defined by ISO-639. The country part is a valid ISO Country Code. These codes are the upper-case, two-letter codes as defined by ISO-3166. The variant argument is a vendor or browser-specific code. For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX.

setAvailableResourceLocales

public static void setAvailableResourceLocales(Locale... locales)

Sets the available resource locales. This calls setAvailableResourceSuffixes(java.lang.String...) to set the available resource suffixes. This is useful for applets that don't provide resources for all possible locales. Normally, if a resource is requested for a locale that is not available, several unsuccessful requests are made to the server to load the resource. This slows down the applet. When setting the available resource locales, the requests are avoided for those locales that are not in the list passed as argument, and instead the resource bundle for the best matching default locale is loaded. This speeds up the applet.

In order to set back to the default behavior, call:

 IlvResourceUtil.setAvailableResourceLocales((String[]) null);
 

Since:

JViews 8.6

setAvailableResourceLocales

public static void setAvailableResourceLocales(com.ibm.icu.util.ULocale... locales)

Sets the available resource locales. This calls setAvailableResourceSuffixes(java.lang.String...) to set the available resource suffixes. This is useful for applets that don't provide resources for all possible locales. Normally, if a resource is requested for a locale that is not available, several unsuccessful requests are made to the server to load the resource. This slows down the applet. When setting the available resource locales, the requests are avoided for those locales that are not in the list passed as argument, and instead the resource bundle for the best matching default locale is loaded. This speeds up the applet.

In order to set back to the default behavior, call:

 IlvResourceUtil.setAvailableResourceLocales((String[]) null);
 

Since:

JViews 8.9

isInApplet

public static boolean isInApplet()

Tests whether we are running inside an applet. Returns true when called inside an applet. Returns false when called inside an application that is not an applet, or when it is impossible to determine the applet/application mode from the class loader.

Since it is only useful for applets, the typical code to specify the available resources is the following:

 if (IlvResourceUtil.isInApplet())
   IlvResourceUtil.setAvailableResourceSuffixes("", "_fr", "_de");
 

Since:

JViews 8.5

setDebug

public static void setDebug(int debug)

Sets the debugging mode. If the debugging mode is enabled, and available resource suffixes are set, it reports all failures of resource bundle loadings. The mode options are:

• 0 - no debug output (the default),
• 1 - debug output to a logger with the name "ilog.views.util.IlvResourceUtil",
• 2 - debug output to stderr.

getBundle

public static ResourceBundle getBundle(String baseName,
                                       Locale locale,
                                       ClassLoader loader)
                                throws MissingResourceException

Returns a resource bundle, examining the available resource suffixes.

Parameters:

baseName - The base name of the resource bundle including the package name.

locale - The locale.

loader - The class loader to load the bundle.

Throws:

MissingResourceException

getBundle

public static ResourceBundle getBundle(String baseName,
                                       com.ibm.icu.util.ULocale locale,
                                       ClassLoader loader)
                                throws MissingResourceException

Returns a resource bundle, examining the available resource suffixes.

Parameters:

baseName - The base name of the resource bundle including the package name.

locale - The locale.

loader - The class loader to load the bundle.

Throws:

MissingResourceException

Since:

JViews 8.9

getBundle

@Deprecated
public static ResourceBundle getBundle(String baseName,
                                                   ClassLoader loader)
                                            throws MissingResourceException

Deprecated. Since JViews 8.7, please use the method getBundle(String, Locale, ClassLoader) instead, passing a locale explicitly - usually either IlvLocaleUtil.getCurrentLocale() or IlvLocaleUtil.getServerLocale().

Returns a resource bundle, examining the available resource suffixes.

Parameters:

baseName - The base name of the resource bundle including the package name.

loader - The class loader to load the bundle.

Throws:

MissingResourceException

Since:

JViews 8.6

getBundle

@Deprecated
public static ResourceBundle getBundle(String baseName,
                                                   Locale locale)
                                            throws MissingResourceException

Deprecated. Since JViews 8.6, use getBundle(String, Locale, ClassLoader). This method is unsafe since it used to lead to different results in different JDKs, if multiple class loaders are used in your application. Hence we strongly recommend not to use it anymore.

Returns a resource bundle, examining the available resource suffixes.

Parameters:

baseName - The base name of the resource bundle including the package name.

locale - The locale.

Throws:

MissingResourceException

getBundle

@Deprecated
public static ResourceBundle getBundle(String baseName)
                                            throws MissingResourceException

Deprecated. Since JViews 8.6, use getBundle(String, ClassLoader). This method is unsafe since it used to lead to different results in different JDKs, if multiple class loaders are used in your application. Hence we strongly recommend not to use it anymore.

Returns a resource bundle, examining the available resource suffixes. It returns the bundle for the default locale.

Parameters:

baseName - The base name of the resource bundle including the package name.

Throws:

MissingResourceException

getCurrentLocaleString

public static String getCurrentLocaleString(Class<?> clazz,
                                            String subkey)

Returns a string for the given subkey from the resource bundle named "messages" in the package of the input object. The fully qualified name is determined by concatenating the path of the class and the string "messages". The current locale is used. See IlvLocaleUtil.getCurrentLocale().

Parameters:

clazz - The class, to determine the package name and the class loader.

subkey - The subkey of the resource string. The key used will be the concatenation of the simple name of the clazz, a dot, and this subkey.

Returns:

the string for the given key

Throws:

MissingResourceException - if no string for the given key can be found

Since:

JViews 8.7

getServerLocaleString

public static String getServerLocaleString(Class<?> clazz,
                                           String subkey)

Returns a string for the given subkey from the resource bundle named "messages" in the package of the input object. The fully qualified name is determined by concatenating the path of the class and the string "messages". The server locale is used. See IlvLocaleUtil.getServerLocale().

Parameters:

clazz - The class, to determine the package name and the class loader.

subkey - The subkey of the resource string. The key used will be the concatenation of the simple name of the clazz, a dot, and this subkey.

Returns:

the string for the given key

Throws:

MissingResourceException - if no string for the given key can be found

Since:

JViews 8.7