net.sf.mmm.util.nls.base

Class BasicNlsMessage

java.lang.Object

net.sf.mmm.util.nls.base.AbstractNlsMessage

net.sf.mmm.util.nls.base.BasicNlsMessage

All Implemented Interfaces:

Serializable, NlsMessage, NlsObject

Direct Known Subclasses:

NlsMessageImpl

public abstract class BasicNlsMessage
extends AbstractNlsMessage

This is the abstract implementation of NlsMessage with the basic features.
You should extend this class whenever suitable to implement NlsMessage.

Since:

2.0.1

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Object>	arguments
private String	message
private static long	serialVersionUID
private NlsTemplate	template The message as NlsTemplate.

Fields inherited from class net.sf.mmm.util.nls.base.AbstractNlsMessage

LOCALE_ROOT

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

LOCALIZATION_FAILURE_PREFIX

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

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_USER, KEY_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicNlsMessage() The constructor for de-serialization in GWT.
	BasicNlsMessage(NlsTemplate template, Map<String,Object> messageArguments) The constructor.
private	BasicNlsMessage(NlsTemplate template, String internationalizedMessage, Map<String,Object> messageArguments) The constructor.
	BasicNlsMessage(String internationalizedMessage, Map<String,Object> messageArguments) The constructor.

Method Summary

Modifier and Type	Method and Description
Object	getArgument(String key) This method gets the language independent argument value for the given key.
protected Map<String,Object>	getArguments() This method gets the message arguments.
String	getInternationalizedMessage() This method gets the internationalized message what is the actual message template for the root locale without resolving its NlsArguments.
NlsTemplate	getTemplate() This method gets the NlsTemplate of this message.
NlsTemplate	getTemplate(NlsTemplateResolver resolver) This method gets the NlsTemplate of this message.

Methods inherited from class net.sf.mmm.util.nls.base.AbstractNlsMessage

getArgument, getArgumentCount, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, toNlsMessage, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.nls.api.NlsMessage

getLocalizedMessage

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

template

private NlsTemplate template

The message as NlsTemplate.

message

private String message

arguments

private Map<String,Object> arguments

Constructor Detail

BasicNlsMessage

protected BasicNlsMessage()

The constructor for de-serialization in GWT.

BasicNlsMessage

public BasicNlsMessage(NlsTemplate template,
                       Map<String,Object> messageArguments)

The constructor.

Parameters:

template - is the NlsTemplate for the raw message.

messageArguments - are the arguments filled into the message after nationalization.

BasicNlsMessage

public BasicNlsMessage(String internationalizedMessage,
                       Map<String,Object> messageArguments)

The constructor.

Parameters:

internationalizedMessage - is the internationalized message.

messageArguments - are the arguments filled into the message after nationalization.

BasicNlsMessage

private BasicNlsMessage(NlsTemplate template,
                        String internationalizedMessage,
                        Map<String,Object> messageArguments)

The constructor.

Parameters:

template - is the NlsTemplate for the raw message.

internationalizedMessage - is the internationalized message.

messageArguments - are the arguments filled into the message after nationalization.

Method Detail

getArgument

public Object getArgument(String key)

Description copied from interface: NlsMessage

This method gets the language independent argument value for the given key.

Parameters:

key - is the name of the requested argument.

Returns:

the argument value for the given key or null if NOT defined.

See Also:

NlsArgument

getInternationalizedMessage

public String getInternationalizedMessage()

Description copied from interface: NlsMessage

This method gets the internationalized message what is the actual message template for the root locale without resolving its NlsArguments.

Returns:

the message for internationalization (e.g. "Welcome {name}!").

See Also:

NlsMessage, NlsMessage.getArgument(String), MessageFormat

getArguments

protected final Map<String,Object> getArguments()

This method gets the message arguments.

Returns:

the Map with the arguments.

getTemplate

public NlsTemplate getTemplate()

This method gets the NlsTemplate of this message.

Returns:

the text the NlsTemplate or null if NOT yet resolved.

getTemplate

public NlsTemplate getTemplate(NlsTemplateResolver resolver)

This method gets the NlsTemplate of this message.

Parameters:

resolver - is the NlsTemplateResolver used to resolve the NlsTemplate if NOT yet available.

Returns:

the text the NlsTemplate.