net.sf.mmm.util.nls.base

Class AbstractNlsMessage

java.lang.Object

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

All Implemented Interfaces:

Serializable, NlsMessage, NlsObject

Direct Known Subclasses:

BasicNlsMessage, ComposedNlsMessage

public abstract class AbstractNlsMessage
extends Object
implements NlsMessage

This is the abstract base implementation of NlsMessage.
You should extend this class rather than directly implementing the NlsMessage interface to gain compatibility with further releases.

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
static Locale	LOCALE_ROOT Locale.ROOT is only available since java 6.
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

Constructor and Description
AbstractNlsMessage() The constructor.

Method Summary

Modifier and Type	Method and Description
Object	getArgument(int index) Deprecated. use NlsMessage.getArgument(String)
int	getArgumentCount() This method gets the number of language independent arguments of this exception.
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.
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

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

getArgument, getInternationalizedMessage, getLocalizedMessage

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

LOCALE_ROOT

public static final Locale LOCALE_ROOT

Locale.ROOT is only available since java 6.

Constructor Detail

AbstractNlsMessage

public AbstractNlsMessage()

The constructor.

Method Detail

getArgument

@Deprecated
public Object getArgument(int index)

Deprecated. use NlsMessage.getArgument(String)

This method gets the Argument for the given index.

Specified by:

getArgument in interface NlsMessage

Parameters:

index - is the index of the requested argument.

Returns:

the argument at the given index or null if no such argument exists.

getArgumentCount

public int getArgumentCount()

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.

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)

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)

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.

toString

public String toString()

Overrides:

toString in class Object