com.solacesystems.common.util.i18n

Class StringResourceBundleSupport

java.lang.Object

com.solacesystems.common.util.i18n.GenericResourceBundleSupport

com.solacesystems.common.util.i18n.StringResourceBundleSupport

public class StringResourceBundleSupport
extends GenericResourceBundleSupport

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	NO_TRIM_PACKAGE_NAME default values for trimming the package name when getting a String safely
static boolean	TRIM_PACKAGE_NAME

Fields inherited from class com.solacesystems.common.util.i18n.GenericResourceBundleSupport

LOCAL_COUNTRY_CMDARG, LOCAL_LANGUAGE_CMDARG

Constructor Summary

Constructors

Constructor and Description
StringResourceBundleSupport(String baseName, ClassLoader classloader) create a new instance for the basename and classloader

Method Summary

Modifier and Type	Method and Description
char	getChar(String key) Look up the specified key in the receiver's resource bundle.
Character	getCharacter(String key) Look up the specified key in the receiver's resource bundle.
MessageFormat	getFormat(String key) Look up the specified key in the receiver's resource bundle.
String	getFormattedMessage(String key, Object[] args) Look up a key and use a MessageFormat to format it, plugging in arguments.
String	getString(String key) Look up the specified key in the receiver's resource bundle.
String	getStringSafely(String key) Look up the specified key in the receiver's resource bundle.
String	getStringSafely(String key, boolean trimPackageName) Look up the specified key in the receiver's resource bundle.
URL	getURL(String key) Look up the specified key in the receiver's resource bundle.
URL	getURLByValue(String value) Look up the specified file as passed-in return an URL for that file.

Methods inherited from class com.solacesystems.common.util.i18n.GenericResourceBundleSupport

getObject

Methods inherited from class java.lang.Object

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

Field Detail

NO_TRIM_PACKAGE_NAME

public static final boolean NO_TRIM_PACKAGE_NAME

default values for trimming the package name when getting a String safely

See Also:

Constant Field Values

TRIM_PACKAGE_NAME

public static final boolean TRIM_PACKAGE_NAME

See Also:

Constant Field Values

Constructor Detail

StringResourceBundleSupport

public StringResourceBundleSupport(String baseName,
                                   ClassLoader classloader)
                            throws MissingResourceException

create a new instance for the basename and classloader

Parameters:

baseName - (e.g. : "com.lwm.core.ui.mptable.i18n.UiBundle")

classloader - parameter

Throws:

MissingResourceException - on error

Method Detail

getChar

public char getChar(String key)
             throws ChainedException

Look up the specified key in the receiver's resource bundle. Cast the value to a string and return the first character in the string.

Parameters:

key - parameter

Returns:

char

Throws:

ChainedException - on error

getCharacter

public Character getCharacter(String key)
                       throws ChainedException

Look up the specified key in the receiver's resource bundle. Cast the value to a string and return the first character in the string.

Parameters:

key - parameter

Returns:

Character

Throws:

ChainedException - on error

getFormat

public MessageFormat getFormat(String key)

Look up the specified key in the receiver's resource bundle. Create and return a new MessageFormat with the returned value. No exceptions are thrown in this method, since the getString() method always returns a non-null string.

Parameters:

key - parameter

Returns:

MessageFormat

See Also:

MessageFormat

getFormattedMessage

public String getFormattedMessage(String key,
                                  Object[] args)

Look up a key and use a MessageFormat to format it, plugging in arguments.

Parameters:

key - Key to look up in resource bundle

args - Array of arguments

Returns:

Formatted message

getString

public String getString(String key)

Look up the specified key in the receiver's resource bundle. Cast the value to a String and return it.

Parameters:

key - parameter

Returns:

String

getStringSafely

public String getStringSafely(String key)

Look up the specified key in the receiver's resource bundle. Cast the value to a String and return it. If the key does not exist return a default key

Parameters:

key - parameter

Returns:

String

getStringSafely

public String getStringSafely(String key,
                              boolean trimPackageName)

Look up the specified key in the receiver's resource bundle. Cast the value to a String and return it. If the key does not exist return either the key, or the key stripped of its package name ie.

Parameters:

key - the lookup key

trimPackageName - decide if we trim the package name if the key does not exist true will trim it, false won't

Returns:

String the String value associated to this key.

getURL

public URL getURL(String key)
           throws ChainedException

Look up the specified key in the receiver's resource bundle. Assume that the found value is the name of a file which may be found on the classpath, or in a .jar file on the classpath. Use the java.lang.Class method to locate a file anywhere in these locations and return an URL for that file. Return the URL. WARNING: throws an exception if the file cannot be located

Parameters:

key - parameter

Returns:

URL

Throws:

ChainedException - on error

See Also:

Class.getResource(java.lang.String)

getURLByValue

public URL getURLByValue(String value)
                  throws ChainedException

Look up the specified file as passed-in return an URL for that file. Return the URL. WARNING: returns null if the desired file could not be found.

Parameters:

value - parameter

Returns:

URL

Throws:

ChainedException - on error

See Also:

Class.getResource(java.lang.String)