Module org.apache.lucene.queryparser

Package org.apache.lucene.queryparser.flexible.messages

Class NLS

java.lang.Object

org.apache.lucene.queryparser.flexible.messages.NLS

Direct Known Subclasses:

QueryParserMessages

public class NLS
extends Object

MessageBundles classes extend this class, to implement a bundle.

For Native Language Support (NLS), system of software internationalization.

This interface is similar to the NLS class in eclipse.osgi.util.NLS class - initializeMessages() method resets the values of all static strings, should only be called by classes that extend from NLS (see TestMessages.java for reference) - performs validation of all message in a bundle, at class load time - performs per message validation at runtime - see NLSTest.java for usage reference

MessageBundle classes may subclass this type.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<String,Class<? extends NLS>>	bundles

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NLS()

Method Summary

Modifier and Type	Method	Description
static String	getLocalizedMessage(String key)
static String	getLocalizedMessage(String key, Object... args)
static String	getLocalizedMessage(String key, Locale locale)
static String	getLocalizedMessage(String key, Locale locale, Object... args)
private static Object	getResourceBundleObject(String messageKey, Locale locale)
protected static void	initializeMessages(String bundleName, Class<? extends NLS> clazz)	Initialize a given class with the message bundle Keys Should be called from a class that extends NLS in a static block at class load time.
private static void	load(Class<? extends NLS> clazz)
private static void	loadfieldValue(Field field, Class<? extends NLS> clazz)
private static void	validateMessage(String key, Class<? extends NLS> clazz)

Methods inherited from class java.lang.Object

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

Field Details

bundles

private static final Map<String,Class<? extends NLS>> bundles

Constructor Details

NLS

protected NLS()

Method Details

getLocalizedMessage

public static String getLocalizedMessage(String key)

getLocalizedMessage

public static String getLocalizedMessage(String key,
 Locale locale)

getLocalizedMessage

public static String getLocalizedMessage(String key,
 Locale locale,
 Object... args)

getLocalizedMessage

public static String getLocalizedMessage(String key,
 Object... args)

initializeMessages

protected static void initializeMessages(String bundleName,
 Class<? extends NLS> clazz)

Initialize a given class with the message bundle Keys Should be called from a class that extends NLS in a static block at class load time.

Parameters:

bundleName - Property file with that contains the message bundle

clazz - where constants will reside

getResourceBundleObject

private static Object getResourceBundleObject(String messageKey,
 Locale locale)

load

private static void load(Class<? extends NLS> clazz)

loadfieldValue

private static void loadfieldValue(Field field,
 Class<? extends NLS> clazz)

validateMessage

private static void validateMessage(String key,
 Class<? extends NLS> clazz)

Parameters:

key - - Message Key