net.sf.eBus.messages

Class ENotificationMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ENotificationMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractEBusMessage

public abstract class ENotificationMessage
extends EMessage
implements Serializable

Required base class for all application publish/subscribe notification messages. This class has no fields of its own.

Author:

Charles Rapp

See Also:

ERequestMessage, EReplyMessage, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ENotificationMessage.Builder<M extends ENotificationMessage,B extends ENotificationMessage.Builder<M,?>> Base class for all ENotificationMessage builders.

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Field Summary

Fields inherited from class net.sf.eBus.messages.EMessage

subject, timestamp

Fields inherited from class net.sf.eBus.messages.EMessageObject

MAX_FIELDS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ENotificationMessage(ENotificationMessage.Builder<?,?> builder) Creates a new eBus notification message based on the given message builder.
protected	ENotificationMessage(String subject) Creates an eBus notification message with the given subject.
	ENotificationMessage(String subject, long timestamp) Creates a new notification message instance for the given subject and timestamp.

Method Summary

Methods inherited from class net.sf.eBus.messages.EMessage

equals, hashCode, isApplicationMessage, isSystemMessage, key, messageType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ENotificationMessage

protected ENotificationMessage(String subject)
                        throws IllegalArgumentException

Creates an eBus notification message with the given subject. The message timestamp is set to the current time.

This constructor is not deprecated since it is needed by local messages designated by @ELocalOnly annotation.

Parameters:

subject - the notification subject.

Throws:

IllegalArgumentException - if subject is either null or empty.

ENotificationMessage

public ENotificationMessage(String subject,
                            long timestamp)
                     throws IllegalArgumentException

Creates a new notification message instance for the given subject and timestamp. This constructor is used for message de-serialization.

This constructor is public due to automatic message compilation and generic message field requirements.

This constructor is not deprecated since it is needed by local messages designated by @ELocalOnly annotation.

Parameters:

subject - the message subject.

timestamp - the message timestamp (Java millisecond epoch time).

Throws:

IllegalArgumentException - if subject is either of null or empty.

ENotificationMessage

protected ENotificationMessage(ENotificationMessage.Builder<?,?> builder)

Creates a new eBus notification message based on the given message builder. builder is guaranteed to contain a valid message configuration at this point.

Parameters:

builder - contains the eBus notification message configuration.