to.etc.webapp.nls

Class BundleRef

java.lang.Object

to.etc.webapp.nls.BundleBase

to.etc.webapp.nls.BundleRef

All Implemented Interfaces:

IBundle, NlsMessageProvider

public final class BundleRef
extends BundleBase
implements IBundle

A bundleRef represents a single set of messages in multiple languages. It differs from a ResourceBundle in that a single instantiated ResourceBundle is always for a single language; this makes a ResourceBundle unusable for server based code since every request can be in a different language.

BundleRefs specify a code location in the webapp's classpath. The code location consists of a class which defines the "start location" to look for the message files and which determines the basic classloader to use to load those files. BundleRef's are cached globally; when you define the same BundleRef multiple times in the code you will always get a reference to the same bundle. This prevents the same bundle from being reloaded multiple times.

Author:

Frits Jalvingh Created on Sep 18, 2006

Field Summary

Fields

Modifier and Type	Field and Description
static BundleRef	DUMMY

Method Summary

Modifier and Type	Method and Description
static BundleRef	create(Class<?> clz, String name) Create or find the BundleRef representing this path.
static BundleRef	createWrapper(NlsMessageProvider mp)
boolean	exists()
String	findMessage(Locale loc, String code) Locate the specified key for the specified locale.
String	getBundleKey() Returns the dotted name of the message bundle as (class package name) '.' (file-name-without-.properties).
static void	internalClear() Clears the cache.

Methods inherited from class to.etc.webapp.nls.BundleBase

formatMessage, formatMessage, getString, getString

Methods inherited from class java.lang.Object

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

Methods inherited from interface to.etc.webapp.nls.IBundle

formatMessage, getString, getString

Field Detail

DUMMY

public static final BundleRef DUMMY

Method Detail

createWrapper

public static BundleRef createWrapper(@Nonnull
                                      NlsMessageProvider mp)

create

@Nonnull
public static BundleRef create(@Nonnull
                                        Class<?> clz,
                                        @Nonnull
                                        String name)

Create or find the BundleRef representing this path. If the ref already exists it gets returned, else it gets created lazily.

Parameters:

clz -

name - Name of the bundle file (minus the ".properties" extension). Case is important!!!

Returns:

exists

public boolean exists()

findMessage

public String findMessage(@Nonnull
                          Locale loc,
                          @Nonnull
                          String code)

Description copied from interface: NlsMessageProvider

Locate the specified key for the specified locale. This does fallback, meaning that if the exact locale is not matched it will try a less restrictive one, until the empty (default) locale has been reached. The first match is returned; if not even the empty locale returns a match this returns null.

Specified by:

findMessage in interface NlsMessageProvider

Specified by:

findMessage in class BundleBase

Returns:

internalClear

public static void internalClear()

Clears the cache. In use by reloading class mechanism, hence only ever called while developing never in production. Dont use otherwise.

getBundleKey

@Nonnull
public String getBundleKey()

Returns the dotted name of the message bundle as (class package name) '.' (file-name-without-.properties). For a bundleRef to (to.etc.domui.DomUtil.class, "messages") the name would be "to.etc.domui.messages".

Returns: