Package eu.bandm.tools.message

Class Message

java.lang.Object

eu.bandm.tools.message.Message

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SimpleMessage

public abstract class Message
extends Object
implements Serializable

Abstract base class of the metatools message architecture.
Does have as attributes only a Kind, a timestamp and a cause. All message processing classes in this package (derived from MessageReceiver) operate on this data.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Message.Kind	Fundamental enum type for categorization of all Message objects.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Opt Throwable	cause	Evident
protected final Message.Kind	kind	Evident
protected final long	timestamp	The system time when this message is created.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Message(@Opt Throwable e)	Creates a message of Message.Kind.failure kind.
protected	Message(Message.Kind k)	Create a message with only kind and timestamp set
protected	Message(Message.Kind k, @Opt Throwable e)	Create a message with kind, cause and timestamp set

Method Summary

Modifier and Type	Method	Description
RuntimeException	explode()	Throws an exception carrying this message.
final @Opt Throwable	getCause()	Evident
final Message.Kind	getKind()	Evident
final StackTraceElement[]	getStackTrace()	returns a StackTraceElement[] taken from the "cause", if there is one.
final long	getTimeStamp()	returns the time when this message was constructed.
final boolean	isCritical()	Distinguishes in many processing situations between Message.Kind.error and Message.Kind.failure as "critical" and all others as "uncritical".
String	toString()	Delivers a primitive visualisation, required for tracing and debugging.

Methods inherited from class java.lang.Object

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

Field Details

kind

protected final Message.Kind kind

Evident

timestamp

protected final long timestamp

The system time when this message is created.

cause

@Opt
protected @Opt Throwable cause

Evident

Constructor Details

Message

protected Message(Message.Kind k)

Create a message with only kind and timestamp set

Message

protected Message(Message.Kind k,
 @Opt
 @Opt Throwable e)

Create a message with kind, cause and timestamp set

Message

protected Message(@Opt
 @Opt Throwable e)

Creates a message of Message.Kind.failure kind.

Method Details

getKind

public final Message.Kind getKind()

Evident

isCritical

public final boolean isCritical()

Distinguishes in many processing situations between Message.Kind.error and Message.Kind.failure as "critical" and all others as "uncritical". See Kind.isCritical().

getTimeStamp

public final long getTimeStamp()

returns the time when this message was constructed. It is encoded according to System.currentTimeMillis().

getCause

@Opt
public final @Opt Throwable getCause()

Evident

getStackTrace

public final StackTraceElement[] getStackTrace()

returns a StackTraceElement[] taken from the "cause", if there is one.

The "cause" is the Throwable returned by getCause(). If this is null, the method returns an empty array.

toString

public String toString()

Delivers a primitive visualisation, required for tracing and debugging. An actual user-level MessagePrinter or sim., will provide much more elaborate rendering.

Overrides:

toString in class Object

explode

public RuntimeException explode()

Throws an exception carrying this message.

Returns:

nothing; the return type is RuntimeException nevertheless. The calling code can use this method as the argument to a throw statement to inform control flow analysis that the call never completes normally.

Throws:

MessageException