net.sf.mmm.util.nls.base

Class NlsBundleHelper

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.util.nls.base.NlsBundleHelper

public class NlsBundleHelper
extends AbstractLoggableObject

Helper class to deal with NlsBundle interfaces.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static NlsBundleHelper	INSTANCE

Constructor Summary

Constructors

Constructor and Description
NlsBundleHelper() The constructor.

Method Summary

Modifier and Type	Method and Description
NlsArgumentDescriptor[]	getArguments(Method method)
NlsMessageDescriptor	getDescriptor(Method method)
static NlsBundleHelper	getInstance()
String	getKey(Method method)
String	getMessage(Method method)
private String	getName(Annotation[] annotations, int i)
ClassName	getQualifiedLocation(Class<? extends NlsBundle> nlsBundleInterface) This method gets the location of the ResourceBundle base name for the given NlsBundle interface.
ResourceBundle	getResourceBundle(String qualifiedBundleName, Locale locale)
boolean	isNlsBundleMethod(Method method, boolean ignoreIllegalMethods) This method determines if the given Method is a regular NlsBundle-method.
ResourceBundle	toResourceBundle(Class<? extends NlsBundle> bundleClass) Converts the given NlsBundle class to a ResourceBundle.

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NlsBundleHelper INSTANCE

See Also:

getInstance()

Constructor Detail

NlsBundleHelper

public NlsBundleHelper()

The constructor.

Method Detail

getInstance

public static NlsBundleHelper getInstance()

Returns:

the singleton instance of this class.

Since:

4.0.0

getQualifiedLocation

public ClassName getQualifiedLocation(Class<? extends NlsBundle> nlsBundleInterface)

This method gets the location of the ResourceBundle base name for the given NlsBundle interface.

Parameters:

nlsBundleInterface - is the NlsBundle interface.

Returns:

the fully qualified ResourceBundle base name for the given NlsBundle interface.

getKey

public String getKey(Method method)

Parameters:

method - is the Method of a NlsBundle.

Returns:

the key of the Method (defaults to Method.getName() if not annotated with NlsBundleKey).

getResourceBundle

public ResourceBundle getResourceBundle(String qualifiedBundleName,
                                        Locale locale)

Parameters:

qualifiedBundleName - the qualified name of the ResourceBundle to load.

locale - the Locale to translate to.

Returns:

the requested ResourceBundle.

getMessage

public String getMessage(Method method)

Parameters:

method - the NlsBundle Method.

Returns:

the bundle message or null if not present.

Since:

4.0.0

getDescriptor

public NlsMessageDescriptor getDescriptor(Method method)

Parameters:

method - the NlsBundle Method.

Returns:

the NlsMessageDescriptor for the given Method.

getArguments

public NlsArgumentDescriptor[] getArguments(Method method)

Parameters:

method - is the Method of a NlsBundle.

Returns:

an array of NlsArgumentDescriptors describing the method parameters.

Since:

7.3.0

getName

private String getName(Annotation[] annotations,
                       int i)

toResourceBundle

public ResourceBundle toResourceBundle(Class<? extends NlsBundle> bundleClass)

Converts the given NlsBundle class to a ResourceBundle.

Parameters:

bundleClass - is the class reflecting a NlsBundle.

Returns:

a ResourceBundle with the key/value pairs of the given bundleClass for Locale.ROOT.

Since:

4.0.0

isNlsBundleMethod

public boolean isNlsBundleMethod(Method method,
                                 boolean ignoreIllegalMethods)

This method determines if the given Method is a regular NlsBundle-method.

Parameters:

method - the Method to check.

ignoreIllegalMethods - - true if illegal methods (non NlsBundleMethods other than those defined by Object) should be ignored, false if they should cause an exception.

Returns:

true if the given Method is a legal NlsBundle method, false otherwise (e.g. for toString()).