net.sf.mmm.util.nls.base

Class NlsMessagePlain

java.lang.Object

net.sf.mmm.util.nls.base.NlsMessagePlain

All Implemented Interfaces:

Serializable, NlsMessage, NlsObject

public class NlsMessagePlain
extends Object
implements NlsMessage

This is a dummy implementation of NlsMessage that only returns the message given at construction and never has any arguments.

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private String	message
private static long	serialVersionUID

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	NlsMessagePlain() The constructor for de-serialization in GWT.
	NlsMessagePlain(String message) The constructor.

Method Summary

Modifier and Type	Method and Description
Object	getArgument(int index) Deprecated.
Object	getArgument(String key) This method gets the language independent argument value for the given key.
int	getArgumentCount() Deprecated.
String	getInternationalizedMessage() This method gets the internationalized message what is the actual message template for the root locale without resolving its NlsArguments.
String	getLocalizedMessage() This method tries to get the localized message as String using the default Locale.
String	getLocalizedMessage(Locale locale) This method gets the resolved and localized message. First it will translate the internationalized message to the given Locale.
void	getLocalizedMessage(Locale locale, Appendable buffer) This method writes the localized message to the given buffer.
String	getLocalizedMessage(Locale locale, NlsTemplateResolver resolver) This method gets the localized message as string.
void	getLocalizedMessage(Locale locale, NlsTemplateResolver resolver, Appendable buffer) This method writes the localized message to the given buffer.
String	getMessage() This method gets the untranslated message (default language should be English) with arguments filled in.
NlsMessage	toNlsMessage() This method is the equivalent to Object.toString() with native language support.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

message

private String message

Constructor Detail

NlsMessagePlain

protected NlsMessagePlain()

The constructor for de-serialization in GWT.

NlsMessagePlain

public NlsMessagePlain(String message)

The constructor.

Parameters:

message - is the plain message to return for any locale without modification.

Method Detail

toNlsMessage

public NlsMessage toNlsMessage()

Description copied from interface: NlsObject

This method is the equivalent to Object.toString() with native language support.

Specified by:

toNlsMessage in interface NlsObject

Returns:

an nls message representing this object.

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.

Specified by:

getInternationalizedMessage in interface NlsMessage

Returns:

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

See Also:

NlsMessage, NlsMessage.getArgument(String), MessageFormat

getArgumentCount

@Deprecated
public int getArgumentCount()

Deprecated.

Description copied from interface: NlsMessage

This method gets the number of language independent arguments of this exception.

Specified by:

getArgumentCount in interface NlsMessage

Returns:

the argument count.

getArgument

public Object getArgument(String key)

Description copied from interface: NlsMessage

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

Specified by:

getArgument in interface NlsMessage

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

getArgument

@Deprecated
public Object getArgument(int index)

Deprecated.

Description copied from interface: NlsMessage

This method gets the language independent argument at the given index.

Specified by:

getArgument in interface NlsMessage

Parameters:

index - is the index of the requested argument.

Returns:

the argument for the given key.

getMessage

public String getMessage()

Description copied from interface: NlsMessage

This method gets the untranslated message (default language should be English) with arguments filled in.
ATTENTION:
In most cases you wand to use NlsMessage.getLocalizedMessage(Locale) instead of this method.

Specified by:

getMessage in interface NlsMessage

Returns:

the i18n message with arguments filled in.

See Also:

NlsMessage.getLocalizedMessage(Locale, NlsTemplateResolver)

getLocalizedMessage

public String getLocalizedMessage()

Description copied from interface: NlsMessage

This method tries to get the localized message as String using the default Locale. In the simplest case Locale.getDefault() is used but if available LocaleContextHolder from spring is used.
ATTENTION:
If possible try to avoid using this method and use NlsMessage.getLocalizedMessage(Locale) instead.

Specified by:

getLocalizedMessage in interface NlsMessage

Returns:

the localized message.

getLocalizedMessage

public String getLocalizedMessage(Locale locale)

Description copied from interface: NlsMessage

This method gets the resolved and localized message.
First it will translate the internationalized message to the given Locale. If this fails for whatever reason, the internationalized message is used as fallback.
Then this message gets resolved by replacing the arguments with their according values.
Example:
We assume the internationalized message is "Welcome {name}!" and the argument with the key @c"name" has the value "Joelle". After translation to Locale.GERMAN the message may be "Willkommen {name}!". This results in the resolved message "Willkommen Joelle!". If the German localization was not present or has a syntax error, the root locale is used as fallback result in "Welcome Joelle!".

Specified by:

getLocalizedMessage in interface NlsMessage

Parameters:

locale - is the locale to translate to.

Returns:

the localized message.

See Also:

net.sf.mmm.util.nls.api

getLocalizedMessage

public void getLocalizedMessage(Locale locale,
                                Appendable buffer)

Description copied from interface: NlsMessage

This method writes the localized message to the given buffer.

Specified by:

getLocalizedMessage in interface NlsMessage

Parameters:

locale - is the locale to translate to.

buffer - is the buffer where to write the message to.

See Also:

NlsMessage.getLocalizedMessage(Locale)

getLocalizedMessage

public String getLocalizedMessage(Locale locale,
                                  NlsTemplateResolver resolver)

Description copied from interface: NlsMessage

This method gets the localized message as string.

Specified by:

getLocalizedMessage in interface NlsMessage

Parameters:

locale - is the locale to translate to.

resolver - is used to translate the message.

Returns:

the localized message.

See Also:

NlsMessage.getLocalizedMessage(Locale, NlsTemplateResolver, Appendable)

getLocalizedMessage

public void getLocalizedMessage(Locale locale,
                                NlsTemplateResolver resolver,
                                Appendable buffer)

Description copied from interface: NlsMessage

This method writes the localized message to the given buffer.
The actual localization is done by a template that is provided via the given resolver. If this fails, the original message will be used. After translation is done, the language independent arguments will be filled in the translated message string according to the given locale.

Specified by:

getLocalizedMessage in interface NlsMessage

Parameters:

locale - is the locale to translate to.

resolver - is used to resolve the template required to translate the internationalized message.

buffer - is the buffer where to write the message to.

toString

public String toString()

Overrides:

toString in class Object