net.sf.eBus.client.sysmessages

Class SubscribeMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ESystemMessage

net.sf.eBus.client.sysmessages.AbstractKeyMessage

net.sf.eBus.client.sysmessages.SubscribeMessage

All Implemented Interfaces:

Serializable

public final class SubscribeMessage
extends AbstractKeyMessage
implements Serializable

This message is sent to a remote publisher to have a notification feed either started or stopped.

Author:

Charles Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
EFeedState	feedState The subscription is either EFeedState.UP or EFeedState.DOWN.

Fields inherited from class net.sf.eBus.client.sysmessages.AbstractKeyMessage

messageClass, messageSubject

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 SubscribeMessage.Builder	builder() Returns a new instance of the SubscribeMessage builder.
boolean	equals(Object o) Returns true if o is a non-null SubscribeMessage instance with the same up flag as this SubscribeMessage instance and false otherwise.
int	hashCode() Returns the feed status message hash code.
String	toString() Returns a human-readable text version of this message.

Methods inherited from class net.sf.eBus.client.sysmessages.AbstractKeyMessage

messageKey

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

feedState

public final EFeedState feedState

The subscription is either EFeedState.UP or EFeedState.DOWN.

Method Detail

equals

public boolean equals(Object o)

Returns true if o is a non-null SubscribeMessage instance with the same up flag as this SubscribeMessage instance and false otherwise.

Overrides:

equals in class AbstractKeyMessage

Parameters:

o - comparison object.

Returns:

true if the message fields are equal and false otherwise.

hashCode

public int hashCode()

Returns the feed status message hash code.

Overrides:

hashCode in class AbstractKeyMessage

Returns:

the feed status message hash code.

toString

public String toString()

Returns a human-readable text version of this message.

Overrides:

toString in class AbstractKeyMessage

Returns:

text version of this message.

builder

public static SubscribeMessage.Builder builder()

Returns a new instance of the SubscribeMessage builder.

Returns:

message builder instance.