net.sf.mmm.util.lang.base

Class AbstractMessage

java.lang.Object

net.sf.mmm.util.lang.base.AbstractMessage

All Implemented Interfaces:

Serializable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, Message

Direct Known Subclasses:

AbstractErrorMessage, AbstractValidationFailure, InformationMessage, WarningMessage

public abstract class AbstractMessage
extends Object
implements Message

This is the abstract base implementation of Message.

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	code
private String	details
private NlsMessage	message
private static long	serialVersionUID UID for serialization.
private String	source
private UUID	uuid

Fields inherited from interface net.sf.mmm.util.lang.api.Message

TYPE_INFORMATION, TYPE_TECHNICAL_ERROR, TYPE_USER_ERROR, TYPE_VALIDATION_FAILURE, TYPE_WARNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMessage() The constructor for de-serialization in GWT.
	AbstractMessage(String code, Object source, NlsMessage message, UUID uuid, String details) The constructor.
	AbstractMessage(String code, Object source, String message, UUID uuid, String details) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getCode() This method gets the code that identifies the detailed type of this object.
String	getDetails() This method gets optional details for this message.
String	getMessage() This method gets the actual message that describes this object.
String	getMessage(Locale locale) This method gets the message localized for the given Locale.
String	getSource() This method gets the (optional) source of the message.
UUID	getUuid() This method gets the UUID of this object.
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.lang.api.Message

getType

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

code

private String code

See Also:

getCode()

source

private String source

See Also:

getSource()

message

private NlsMessage message

See Also:

getMessage(java.util.Locale)

uuid

private UUID uuid

See Also:

getUuid()

details

private String details

See Also:

getDetails()

Constructor Detail

AbstractMessage

protected AbstractMessage()

The constructor for de-serialization in GWT.

AbstractMessage

public AbstractMessage(String code,
                       Object source,
                       String message,
                       UUID uuid,
                       String details)

The constructor.

Parameters:

code - is the code.

source - is the source.

message - is the message.

uuid - is the uuid.

details - are the details.

AbstractMessage

public AbstractMessage(String code,
                       Object source,
                       NlsMessage message,
                       UUID uuid,
                       String details)

The constructor.

Parameters:

code - is the code.

source - is the source.

message - is the message.

uuid - is the uuid.

details - are the details.

Method Detail

getCode

public String getCode()

This method gets the code that identifies the detailed type of this object. While UUID or ID are typically unique per instance of an object the code is unique for all instances of the exact same kind. So e.g. a particular kind of exception or ValidationFailure can be identified by its code. A simple generic implementation may return the classname or the key of the NLS message. However, the code should remain stable after refactoring (so at least after the rename the previous code should be returned as String literal). This code may be used as a compact identifier to reference the related problem or information as well as for automatic tests of error situations that should remain stable even if the message text gets improved or the locale is unknown.

Specified by:

getCode in interface AttributeReadMessageCode

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message

getSource

public String getSource()

This method gets the (optional) source of the message. E.g. the name or a field or file that is invalid. It can be used to enrich messages displayed to end-users. This will help to find the problem easier.

Specified by:

getSource in interface Message

Returns:

the source or null if NOT available.

getMessage

public final String getMessage()

This method gets the actual message that describes this object. Such message should contain contextual information to describe and track down the information, problem, warning or error. It is either technical and should help operators or developers to identify what happened or it will be information displayed to end-users and should be clear and easy to understand. For internationalization see Message and NlsMessage. In any case it should NOT contain sensitive information such as passwords or (detailed) personal data.

Specified by:

getMessage in interface AttributeReadMessage

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message

getMessage

public String getMessage(Locale locale)

This method gets the message localized for the given Locale.
ATTENTION:
This method is designed for server applications with NLS. On client side (e.g. for GWT clients) only a single locale may be supported at a time and this method may behave like AttributeReadMessage.getMessage() ignoring the Locale.

Specified by:

getMessage in interface Message

Parameters:

locale - is the Locale.

Returns:

the message.

getDetails

public String getDetails()

This method gets optional details for this message. E.g. in case of an exception this can be the stacktrace.

Specified by:

getDetails in interface Message

Returns:

the details or null if no additional details are available.

getUuid

public UUID getUuid()

This method gets the UUID of this object. When the object is created, a UUID is generated. In case the object is created from another object that already has a UUID, the existing UUID will be used (e.g. for chained exceptions).
The UUID will appear in a stacktrace but NOT in the message. It will therefore be written to log-files if the NlsThrowable is logged. If you supply the UUID to the end-user in an error panel or popup (see Message), he can provide it with the problem report so an administrator or software developer can easily find the stacktrace in the log-files.

Specified by:

getUuid in interface AttributeReadUuid

Specified by:

getUuid in interface Message

Returns:

the UUID if this Message. Will typically only be available if type is Message.TYPE_TECHNICAL_ERROR or Message.TYPE_USER_ERROR. Will be null if not available.

toString

public String toString()

Overrides:

toString in class Object