eu.bandm.tools.message

Class Message

java.lang.Object

eu.bandm.tools.message.Message

Direct Known Subclasses:

SimpleMessage

public abstract class Message
extends Object

Abstract base class of the ^meta-tools message architecture.
Does have as attributes only a Kind, a timestamp and a cause (which even is inherited, cf. Throwable.getCause()!)
But all the message processing classes in this package (derived from MessageReceiver) are very undemanding and operate on this meager data.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Exception	cause
protected Message.Kind	kind
protected long	timestamp

Constructor Summary

Constructors

Constructor and Description
Message(Exception e)
Message(Message.Kind k)
Message(Message.Kind k, Exception e)

Method Summary

Modifier and Type	Method and Description
RuntimeException	explode() Throws an exception carrying this message.
Exception	getException() HISTORIC RELICT: return the "cause" which was specified when constructing.
Message.Kind	getKind()
StackTraceElement[]	getStackTrace() returns a StackTraceElement[] taken from the "cause", if there is one.
long	getTimeStamp() returns the time when this message was constructed, encoded according to System.currentTimeMillis().
boolean	isCritical() Distinguishes in many processing situations between Message.Kind.error and Message.Kind.failure vs all others.
String	render(Object... formatHints) NOT YET OPERATIVE; simply calls toString()
String	toString() returns a debugging visualization with all attributes (kind, time, cause and stacktrace), but not at all pretty.

Methods inherited from class java.lang.Object

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

Field Detail

kind

protected Message.Kind kind

timestamp

protected final long timestamp

cause

protected Exception cause

Constructor Detail

Message

public Message(Message.Kind k)

Message

public Message(Message.Kind k,
               Exception e)

Message

public Message(Exception e)

Method Detail

getKind

public final Message.Kind getKind()

isCritical

public final boolean isCritical()

Distinguishes in many processing situations between Message.Kind.error and Message.Kind.failure vs all others. Cf. Kind.isCritical().

getTimeStamp

public final long getTimeStamp()

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

getException

public final Exception getException()

HISTORIC RELICT: return the "cause" which was specified when constructing. The result is the same as when calling Throwable.getCause(), but the result is checked to be an exception.

getStackTrace

public final StackTraceElement[] getStackTrace()

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

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

toString

public String toString()

returns a debugging visualization with all attributes (kind, time, cause and stacktrace), but not at all pretty.

Overrides:

toString in class Object

render

public String render(Object... formatHints)

NOT YET OPERATIVE; simply calls toString()

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