net.sf.eBus.messages

Enum EMessage.MessageType

java.lang.Object

java.lang.Enum<EMessage.MessageType>

net.sf.eBus.messages.EMessage.MessageType

All Implemented Interfaces:

Serializable, Comparable<EMessage.MessageType>

Enclosing class:

EMessage

public static enum EMessage.MessageType
extends Enum<EMessage.MessageType>

Messages are divided into four types: notification, request, reply and system. System messages are reserved for use by the eBus system itself and may not be used by applications.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOTIFICATION A notification is an event with an associated subject.
REPLY A reply contains a subject, request identifier, reply status and optional reason.
REQUEST A request contains a subject and request identifier and is routed by subject.
SYSTEM eBus system message.

Method Summary

Modifier and Type	Method and Description
boolean	isMatching(Class mc) Returns true if mc is not null and is assignable from this message type.
Class<? extends EMessage>	messageClass() Returns the associated message class.
static EMessage.MessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EMessage.MessageType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOTIFICATION

public static final EMessage.MessageType NOTIFICATION

A notification is an event with an associated subject. Notifications are routed by subject.

REQUEST

public static final EMessage.MessageType REQUEST

A request contains a subject and request identifier and is routed by subject.

REPLY

public static final EMessage.MessageType REPLY

A reply contains a subject, request identifier, reply status and optional reason. Replies are routed by their destination address. The destination is the corresponding request source address.

SYSTEM

public static final EMessage.MessageType SYSTEM

eBus system message. Reserved for use by the eBus system and may not be used by applications.

Method Detail

values

public static EMessage.MessageType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EMessage.MessageType c : EMessage.MessageType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EMessage.MessageType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

messageClass

public Class<? extends EMessage> messageClass()

Returns the associated message class.

Returns:

message class.

isMatching

public boolean isMatching(Class mc)

Returns true if mc is not null and is assignable from this message type.

Parameters:

mc - check if this message class matches this type.

Returns:

true if mc matches this message type.