net.sf.eBus.client.sysmessages

Class KeyMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ESystemMessage

net.sf.eBus.client.sysmessages.KeyMessage

All Implemented Interfaces:

Serializable

public final class KeyMessage
extends ESystemMessage
implements Serializable

This system message is used to exchange message key-to-identifier mappings.

Author:

Charles W. Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyMessage.Builder Class used to create KeyMessage instances.

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
String	keyClass The message key class name.
int	keyId The sender's message key identifier.
String	keySubject The message key subject.

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

SYSTEM_SUBJECT

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

subject, timestamp

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

MAX_FIELDS

Method Summary

Modifier and Type	Method and Description
static KeyMessage.Builder	builder() Returns a new instance of the KeyMessage builder.
boolean	equals(Object o) Returns true if o is a non-null EMessage instance with a subject and timestamp equal to this EMessage instance and false otherwise.
int	hashCode() Returns the message header hash code.
String	toString() Returns the message subject and timestamp as a string.

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

isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

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

Field Detail

keyId

public final int keyId

The sender's message key identifier. The receiver may assign its own unique identifier for the key.

keyClass

public final String keyClass

The message key class name.

keySubject

public final String keySubject

The message key subject.

Method Detail

equals

public boolean equals(Object o)

Description copied from class: EMessage

Returns true if o is a non-null EMessage instance with a subject and timestamp equal to this EMessage instance and false otherwise.

Overrides:

equals in class EMessage

Parameters:

o - comparison object.

Returns:

true if the message fields are equal and false otherwise.

hashCode

public int hashCode()

Description copied from class: EMessage

Returns the message header hash code.

Overrides:

hashCode in class EMessage

Returns:

the message header hash code.

toString

public String toString()

Description copied from class: EMessage

Returns the message subject and timestamp as a string.

Overrides:

toString in class EMessage

Returns:

the message as text.

builder

public static KeyMessage.Builder builder()

Returns a new instance of the KeyMessage builder.

Returns:

message builder instance.