net.java.hulp.i18n

Class LocalizationSupport

java.lang.Object

net.java.hulp.i18n.LocalizationSupport

public abstract class LocalizationSupport
extends Object

Tools for obtaining localized messages

Version:

$Revision: 1.6 $

Author:

fkieviet

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULTBUNDLENAME Default name for resource bundles
static Pattern	DEFAULTPATTERN Default pattern to parse a message with

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalizationSupport(Pattern idpattern, String prefix, String bundlename)
protected	LocalizationSupport(String prefix)

Method Summary

Methods

Modifier and Type	Method and Description
String	t(String msg, Object... args) Returns a localized message.
String	tNoID(String msg, Object... args) Returns a localized message without its messageid.
LocalizedString	x(String msg, Object... args)
LocalizedString	xNoID(String msg, Object... args)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULTBUNDLENAME

public static final String DEFAULTBUNDLENAME

Default name for resource bundles

See Also:

Constant Field Values

DEFAULTPATTERN

public static Pattern DEFAULTPATTERN

Default pattern to parse a message with

Constructor Detail

LocalizationSupport

protected LocalizationSupport(Pattern idpattern,
                   String prefix,
                   String bundlename)

Parameters:

idpattern - pattern to parse message

prefix - module name

LocalizationSupport

protected LocalizationSupport(String prefix)

Parameters:

idpattern - pattern to parse message

prefix - module name

Method Detail

x

public LocalizedString x(String msg,
                Object... args)

Parameters:

msg - Message to be localized

args - arguments

Returns:

LocalizedString

See Also:

t(String, Object...)

t

public String t(String msg,
       Object... args)

Returns a localized message. Msg is a string of the form "E001: this is a message". The format of the id is specified in the constructor, and is the first group of the pattern. E.g. in a specified pattern of "([A-Z]\d\d\d)(: )( .*), the message id is [A-Z]\d\d\d; in the example that would be E001. It returns the localized form of "MODULE-E999: This is a message", e.g. "MODULE-X001: Dit is een bericht". If the message is improperly formatted, it will return MODULE-: This is a message If the message cannot be found, it will return "MODULE-E999: This is a message" (English)

Parameters:

msg - Message to be localized

args - arguments

Returns:

java.lang.String

tNoID

public String tNoID(String msg,
           Object... args)

Returns a localized message without its messageid. Msg is a string of the form "E001: this is a message". The format of the id is specified in the constructor, and is the first group of the pattern. E.g. in a specified pattern of "([A-Z]\d\d\d)(: )( .*), the message id is [A-Z]\d\d\d; in the example that would be E001. It returns the localized form of "This is a message", e.g. "Dit is een bericht". If the message is improperly formatted, e.g. "INV: This is a message" will return "INV: This is a message (*)" If the message cannot be found in the bundle, it will return "This is a message" provided that the regular expression has two groups. If the regurlar expression yields only one group, it will return "X001: this is a message".

Parameters:

msg - msg to localize in the form of "X001: this is a message" (the exact format must match the specified regular expression)

args - arguments to substitute in msg

Returns:

localized string

xNoID

public LocalizedString xNoID(String msg,
                    Object... args)

Parameters:

msg - Message to be localized

args - arguments

Returns:

LocalizedString

See Also:

tNoID(String, Object...)