net.sf.mmm.util.nls.api

Interface NlsBundleWithLookup

All Superinterfaces:

NlsBundle, NlsMessageLookup

public interface NlsBundleWithLookup
extends NlsBundle, NlsMessageLookup

This is the interface for NlsBundles that require generic lookup of a NlsMessage.
Note:
Please only use this interface when the getMessage(String, Map) is really required. Otherwise only extend NlsBundle.

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.mmm.util.nls.api.NlsBundle

INTERFACE_NAME_SUFFIX

Method Summary

Modifier and Type	Method and Description
NlsMessage	getMessage(String methodName, Map<String,Object> nlsArguments) This method create the NlsMessage for the given key with the given nlsArguments.

Method Detail

getMessage

NlsMessage getMessage(String methodName,
                      Map<String,Object> nlsArguments)

This method create the NlsMessage for the given key with the given nlsArguments. This allows generic access to invoke a specific method of your bundle. E.g. assume you have an interface NlsBundleMyExampleRoot extending NlsMessageLookup that declares the following method:

 @NlsBundleMessage("The object \"{object}\" is null!")
 NlsMessage errorArgumentNull(@Named("object") Object object);
 

Then you could do:

 NlsBundleMyExampleRoot myBundle = NlsAccess.getBundleFactory().createBundle(NlsBundleMyExampleRoot.class);
 Map<String, Object> parameters = new HashMap<>();
 parameters.put("object", myObject);
 NlsMessage message = myBundle.getMessage("errorArgumentNull", parameters);
 

This would have the same result as myBundle.errorArgumentNull(myObject).

Specified by:

getMessage in interface NlsMessageLookup

Parameters:

methodName - is the method name.

nlsArguments - are the arguments. May be null for no arguments.

Returns:

the NlsMessage or null if no message exists for the given methodName (no such method exists).