com.sun.enterprise.universal.i18n
Class LocalStrings

java.lang.Object
  com.sun.enterprise.universal.i18n.LocalStrings

public class LocalStrings
extends java.lang.Object

This class makes getting localized strings super-simple. All methods are static. The reason is that that makes it much simpler to use -- you never need to create an instance and store it. You simply call one of the 2 methods directly. However, there is a performance penalty for this convenience. This class has to figure out what package your calling code is in (every time). My reasoning is that the emitting of log messages tends to be much less frequent than other normal processing steps. If performance is an issue -- use an instance of LocalStringsImpl.

Specifics:

• Your calling code should have a file named LocalStrings.properties in its package directory.
• If your localized string has no arguments call get(String) to get the localized String value.
• If you have a parameterized string, call get(String, Object...)

Note: You can not get an Exception out of calling this code! If the String or the properties file does not exist, it will return the String that you gave in the first place as the argument.

Examples:

• String s = LocalStrings.get("xyz");
• String s = LocalStrings.get("xyz", new Date(), 500, "something", 2.00003);
• String s = LocalStrings.get("xyz", "something", "foo", "whatever");

Author:

bnevins

Method Summary

static java.lang.String	get(java.lang.String indexString) Get a String from the caller's package's LocalStrings.properties
static java.lang.String	get(java.lang.String indexString, java.lang.Object... objects) Get and format a String from the caller's package's LocalStrings.properties
boolean	getBoolean(java.lang.String indexString, boolean defaultValue) Get a boolean from the caller's package's LocalStrings.properties
static int	getInt(java.lang.String indexString, int defaultValue) Get an integer from the caller's package's LocalStrings.properties
java.lang.String	getString(java.lang.String indexString, java.lang.String defaultValue) Get a String from the caller's package's LocalStrings.properties

Methods inherited from class java.lang.Object

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

Method Detail

get

public static java.lang.String get(java.lang.String indexString)

Get a String from the caller's package's LocalStrings.properties

Parameters:

indexString - The string index into the localized string file

Returns:

the String from LocalStrings or the supplied String if it doesn't exist

get

public static java.lang.String get(java.lang.String indexString,
                                   java.lang.Object... objects)

Get and format a String from the caller's package's LocalStrings.properties

Parameters:

indexString - The string index into the localized string file

objects - The arguments to give to MessageFormat

Returns:

the String from LocalStrings or the supplied String if it doesn't exist -- using the array of supplied Object arguments

getString

public java.lang.String getString(java.lang.String indexString,
                                  java.lang.String defaultValue)

Get a String from the caller's package's LocalStrings.properties

Parameters:

indexString - The string index into the localized string file

Returns:

the String from LocalStrings or the supplied default value if it doesn't exist

getInt

public static int getInt(java.lang.String indexString,
                         int defaultValue)

Get an integer from the caller's package's LocalStrings.properties

Parameters:

indexString - The string index into the localized string file

Returns:

the integer value from LocalStrings or the supplied default if it doesn't exist or is bad.

getBoolean

public boolean getBoolean(java.lang.String indexString,
                          boolean defaultValue)

Get a boolean from the caller's package's LocalStrings.properties

Parameters:

indexString - The string index into the localized string file

Returns:

the integer value from LocalStrings or the supplied default if it doesn't exist or is bad.