org.ka2ddo.yaac.util

Class Localizer

java.lang.Object

org.ka2ddo.yaac.util.Localizer

public class Localizer
extends java.lang.Object

This class wraps all the business logic for searching ResourceBundles for localized text messages for display on the UI and in reports. This will be used to phase out dependencies on the YAAC main class (where these methods were originally located) from code packages that do not depend on being in the YAAC application.

Author:

Andrew Pavlin, KA2DDO

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getMsg(java.lang.String tagName) Get the appropriate localized String corresponding to a ResourceBundle tag name in a specific ResourceBundle.
static java.lang.String	getMsg(java.lang.String bundleBaseName, java.lang.String tagName) Get the appropriate localized String corresponding to a ResourceBundle tag name in a specific ResourceBundle.
static java.util.ResourceBundle	getMsgBundle() Get the appropriate locale-specific message bundle for YAAC.
static java.util.ResourceBundle	getMsgBundle(java.lang.String altBundleName) Get the appropriate locale-specific variant of some message bundle in one or more of the provided plugins.
static java.lang.String	getMsgNoException(java.lang.String tagName) Get the appropriate localized String corresponding to a ResourceBundle tag name in a specific ResourceBundle.
static void	setContextClassLoader(java.lang.ClassLoader cl) Update the ClassLoader hierarchy that will be used to look for ResourceBundle property files.

Methods inherited from class java.lang.Object

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

Method Detail

setContextClassLoader

public static void setContextClassLoader(java.lang.ClassLoader cl)

Update the ClassLoader hierarchy that will be used to look for ResourceBundle property files. This should be called by any code that dynamically loads additional jar files into the Java virtual machine after the jar file this class comes from.

Parameters:

cl - ClassLoader to be the most complete set available

getMsgBundle

public static java.util.ResourceBundle getMsgBundle()

Get the appropriate locale-specific message bundle for YAAC.

Returns:

a ResourceBundle that is the most locale-specific possible for the runtime environment

getMsgBundle

public static java.util.ResourceBundle getMsgBundle(java.lang.String altBundleName)

Get the appropriate locale-specific variant of some message bundle in one or more of the provided plugins.

Parameters:

altBundleName - String base name of the ResourceBundle to search for

Returns:

a ResourceBundle that is the most locale-specific possible for the runtime environment

getMsg

public static java.lang.String getMsg(java.lang.String tagName)
                               throws java.util.MissingResourceException

Get the appropriate localized String corresponding to a ResourceBundle tag name in a specific ResourceBundle. If the tagName String contains a colon ':', this is the delimiter between the ResourceBundle name and the name of the resource within the bundle; otherwise, the entire tagName string is considered to be the name of the resource within the default bundle.

Parameters:

tagName - String name to look up

Returns:

localized String corresponding to the tag, or NoSuchResourceException if the if the tag cannot be found

Throws:

java.util.MissingResourceException - if the tag cannot be found

getMsgNoException

public static java.lang.String getMsgNoException(java.lang.String tagName)
                                          throws java.util.MissingResourceException

Get the appropriate localized String corresponding to a ResourceBundle tag name in a specific ResourceBundle. If the tagName String contains a colon ':', this is the delimiter between the ResourceBundle name and the name of the resource within the bundle; otherwise, the entire tagName string is considered to be the name of the resource within the default bundle.

Parameters:

tagName - String name to look up

Returns:

localized String corresponding to the tag, or null if the if the tag cannot be found

Throws:

java.util.MissingResourceException - if the ResourceBundle cannot be found

getMsg

public static java.lang.String getMsg(java.lang.String bundleBaseName,
                                      java.lang.String tagName)
                               throws java.util.MissingResourceException

Get the appropriate localized String corresponding to a ResourceBundle tag name in a specific ResourceBundle.

Parameters:

bundleBaseName - String name of bundle containing the tag

tagName - String name to look up

Returns:

localized String corresponding to the tag, or NoSuchResourceException if the if the tag cannot be found

Throws:

java.util.MissingResourceException - if the bundle or tag cannot be found