net.sf.mmm.util.lang.base

Class AbstractErrorMessage

java.lang.Object

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

net.sf.mmm.util.lang.base.AbstractErrorMessage

All Implemented Interfaces:

Serializable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, Message

Direct Known Subclasses:

ErrorMessage

public abstract class AbstractErrorMessage
extends AbstractMessage

This is the abstract base class for an error 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 static long	serialVersionUID
private boolean	technical

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

Method Summary

Modifier and Type	Method and Description
String	getType() This method gets the type of this Message.

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

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

technical

private boolean technical

Constructor Detail

AbstractErrorMessage

protected AbstractErrorMessage()

The constructor for de-serialization in GWT.

AbstractErrorMessage

public AbstractErrorMessage(String code,
                            Object source,
                            String message,
                            UUID uuid,
                            String details,
                            boolean technical)

The constructor.

Parameters:

code - - see AbstractMessage.getCode().

source - - see AbstractMessage.getSource().

message - - see AbstractMessage.getMessage().

uuid - - see AbstractMessage.getUuid().

details - - see AbstractMessage.getDetails().

technical - - true in case of technical error with Message.TYPE_TECHNICAL_ERROR, false otherwise (business error).

AbstractErrorMessage

public AbstractErrorMessage(String code,
                            Object source,
                            NlsMessage message,
                            UUID uuid,
                            String details,
                            boolean technical)

The constructor.

Parameters:

code - - see AbstractMessage.getCode().

source - - see AbstractMessage.getSource().

message - - see AbstractMessage.getMessage().

uuid - - see AbstractMessage.getUuid().

details - - see AbstractMessage.getDetails().

technical - - true in case of technical error with Message.TYPE_TECHNICAL_ERROR, false otherwise (business error).

AbstractErrorMessage

public AbstractErrorMessage(NlsThrowable error)

The constructor.

Parameters:

error - is the NlsThrowable to convert as error message.

Method Detail

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.