net.sf.eBus.client.sysmessages

Class AdMessage

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.AdMessage

All Implemented Interfaces:

Serializable

public final class AdMessage
extends AbstractKeyMessage
implements Serializable

Reports either a notification publisher or a request replier advertisement to a remote eBus application and whether the advertisement should be put into place or retracted.

Author:

Charles Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdMessage.AdStatus This enum specifies whether an advertisement should be added or removed.
static class	AdMessage.Builder Class used to create AdMessage instances.

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
EMessage.MessageType	adMessageType The advertised message is for either a notification or a request.
AdMessage.AdStatus	adStatus Add or retract this advertisement.
EFeedState	feedState The advertised feed's current state.

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 AdMessage.Builder	builder() Returns a new instance of the AdMessage builder.
boolean	equals(Object o) Returns true if o is a non-null AdMessage instance with ad status, message class, and message type equal to this AdMessage instance and false otherwise.
int	hashCode() Returns the advertisement 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

adStatus

public final AdMessage.AdStatus adStatus

Add or retract this advertisement.

adMessageType

public final EMessage.MessageType adMessageType

The advertised message is for either a notification or a request.

feedState

public final EFeedState feedState

The advertised feed's current state.

Method Detail

equals

public boolean equals(Object o)

Returns true if o is a non-null AdMessage instance with ad status, message class, and message type equal to this AdMessage 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 advertisement message hash code.

Overrides:

hashCode in class AbstractKeyMessage

Returns:

the advertisement 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 AdMessage.Builder builder()

Returns a new instance of the AdMessage builder.

Returns:

message builder instance.