net.sf.eBus.messages

Class EMessageKey

java.lang.Object

net.sf.eBus.messages.EMessageKey

All Implemented Interfaces:

Serializable, Comparable<EMessageKey>

public class EMessageKey
extends Object
implements Comparable<EMessageKey>, Serializable

Provides an immutable key based on the message class and subject. This "type+topic" references a unique eBus message subject.

Author:

Charles Rapp

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	KEY_IFS Use 47 to separate the message class from message subject.

Constructor Summary

Constructors

Constructor and Description
EMessageKey(Class<? extends EMessage> mc, String subject) Creates a new message key for the given message class and subject.

Method Summary

Modifier and Type	Method and Description
String	className() Returns the message class name.
int	compareTo(EMessageKey key) Returns an integer value that is <, equal to or > zero if this EMessageKey is <, equal to or > key.
boolean	equals(Object obj) Returns true if obj is a non-null EMessageKey instance with equivalent message class and subject; returns false otherwise.
int	hashCode() Returns a hash code based on the message identifier and subject.
boolean	isLocalOnly() Returns true if the message class is local-only and false if the message class may be transmitted.
boolean	isNotification() Returns true if the message class is an ENotificationMessage subclass; otherwise, returns false.
boolean	isReply() Returns true if the message class is an EReplyMessage subclass; otherwise, returns false.
boolean	isRequest() Returns true if the message class is an ERequestMessage subclass; otherwise, returns false.
boolean	isSystem() Returns true if the message class is a ESystemMessage subclass; otherwise, returns false.
String	keyString() Returns the key in string format: "message class name/subject".
Class<? extends EMessage>	messageClass() Returns the message class.
EMessage.MessageType	messageType() Returns the key message type.
static EMessageKey	parseKey(String s) Returns a message key parsed from the given input.
String	subject() Returns the subject.
String	toString() Returns a textual representation of this message key.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_IFS

public static final char KEY_IFS

Use 47 to separate the message class from message subject.

See Also:

Constant Field Values

Constructor Detail

EMessageKey

public EMessageKey(Class<? extends EMessage> mc,
                   String subject)

Creates a new message key for the given message class and subject.

Parameters:

mc - message class.

subject - message subject

Throws:

NullPointerException - if either mc or subject is null.

IllegalArgumentException - if subject is an empty string.

Method Detail

compareTo

public int compareTo(EMessageKey key)

Returns an integer value that is <, equal to or > zero if this EMessageKey is <, equal to or > key. Comparison is based on the message class and then the message subject.

Specified by:

compareTo in interface Comparable<EMessageKey>

Parameters:

key - comparison object.

Returns:

an integer value that is <, equal to or > zero.

equals

public boolean equals(Object obj)

Returns true if obj is a non-null EMessageKey instance with equivalent message class and subject; returns false otherwise.

Overrides:

equals in class Object

Parameters:

obj - comparison object.

Returns:

true if obj is equivalent to this.

hashCode

public int hashCode()

Returns a hash code based on the message identifier and subject.

Overrides:

hashCode in class Object

Returns:

the message key hash.

toString

public String toString()

Returns a textual representation of this message key.

Overrides:

toString in class Object

Returns:

a textual representation.

className

public String className()

Returns the message class name.

Returns:

the message class name.

messageClass

public Class<? extends EMessage> messageClass()

Returns the message class.

Returns:

the message class.

subject

public String subject()

Returns the subject.

Returns:

the subject.

keyString

public String keyString()

Returns the key in string format: "message class name/subject". Creates the key string if it has not yet been set.

Returns:

the key in string format.

isSystem

public boolean isSystem()

Returns true if the message class is a ESystemMessage subclass; otherwise, returns false.

Returns:

true if the message key references a system message.

isNotification

public boolean isNotification()

Returns true if the message class is an ENotificationMessage subclass; otherwise, returns false.

Returns:

true if the message key references a notification message.

isRequest

public boolean isRequest()

Returns true if the message class is an ERequestMessage subclass; otherwise, returns false.

Returns:

true if the message key references a request message.

isReply

public boolean isReply()

Returns true if the message class is an EReplyMessage subclass; otherwise, returns false.

Returns:

true if the message key references a reply message.

isLocalOnly

public boolean isLocalOnly()

Returns true if the message class is local-only and false if the message class may be transmitted.

Returns:

true if the message class is local-only.

messageType

public EMessage.MessageType messageType()

Returns the key message type.

Returns:

message type.

parseKey

public static EMessageKey parseKey(String s)
                            throws IllegalArgumentException,
                                   InvalidMessageException

Returns a message key parsed from the given input. The input must be of the form "message class name:subject". If the input is null or an empty string, then null is returned.

Parameters:

s - the message key in text form.

Returns:

the parsed message key instance.

Throws:

IllegalArgumentException - if s is not properly formatted or contains an unknown class name.

InvalidMessageException - if s is properly formatted but contains an unknown message class name.