net.sf.mmm.util.lang.base

Class InformationMessage

java.lang.Object

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

net.sf.mmm.util.lang.base.InformationMessage

All Implemented Interfaces:

Serializable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, Message

public class InformationMessage
extends AbstractMessage

This is the implementation of an information Message.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID

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	InformationMessage() The constructor for de-serialization in GWT.
	InformationMessage(String code, Object source, NlsMessage message) The constructor.
	InformationMessage(String code, Object source, NlsMessage message, UUID uuid, String details) The constructor.
	InformationMessage(String code, Object source, String message) The constructor.
	InformationMessage(String code, Object source, String message, UUID uuid, String details) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getDetails() This method gets optional details for this message.
String	getType() This method gets the type of this Message.
UUID	getUuid() This method gets the UUID of this object.

Methods inherited from class net.sf.mmm.util.lang.base.AbstractMessage

getCode, getMessage, getMessage, getSource, 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

Constructor Detail

InformationMessage

protected InformationMessage()

The constructor for de-serialization in GWT.

InformationMessage

public InformationMessage(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.

InformationMessage

public InformationMessage(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.

InformationMessage

public InformationMessage(String code,
                          Object source,
                          String message)

The constructor.

Parameters:

code - is the code.

source - is the source.

message - is the message.

InformationMessage

public InformationMessage(String code,
                          Object source,
                          NlsMessage message)

The constructor.

Parameters:

code - is the code.

source - is the source.

message - is the message.

Method Detail

getDetails

public String getDetails()

Description copied from interface: Message

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

Overrides:

getDetails in class AbstractMessage

Returns:

the details or null if no additional details are available.

getType

public String getType()

Description copied from interface: Message

This method gets the type of this Message. This should be one of the following options:

• "ValidationFailure" - for a ValidationFailure.
• "UserError" - for an error caused by the end-user (e.g. by providing invalid data). Unlike Message.TYPE_VALIDATION_FAILURE this is an actual error that has been detected after a successful validation.
• "TechnicalError" - for an error related to a technical problem (e.g. programming failure such as NullPointerException or operational error like ConnectException).
• "Warning" - for a warning such as "The hit-list for your query has been truncated."). In such case it should be possible to continue the use-case or operation normally.
• "Information" - for additional information - e.g. a hint.

Returns:

the message type.

getUuid

public UUID getUuid()

Description copied from interface: Message

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

Overrides:

getUuid in class AbstractMessage

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.