rocks.xmpp.core.stanza

Class MessageEvent

java.lang.Object

java.util.EventObject

rocks.xmpp.core.stanza.MessageEvent

All Implemented Interfaces:

java.io.Serializable

public final class MessageEvent
extends java.util.EventObject

A message event is fired whenever a message is received or sent.

This class is immutable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageEvent(java.lang.Object source, Message message, boolean inbound) Constructs a message event.

Method Summary

Modifier and Type	Method and Description
void	consume() Marks this event as consumed.
Message	getMessage() Gets the message.
boolean	isConsumed() Indicates, whether this event has been consumed.
boolean	isInbound() Indicates, whether the stanza has been received (inbound) or is about to being sent (outbound).
java.lang.String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageEvent

public MessageEvent(java.lang.Object source,
                    Message message,
                    boolean inbound)

Constructs a message event.

Parameters:

source - The object on which the event initially occurred.

message - The message stanza.

inbound - True, if the stanza is inbound.

Throws:

java.lang.IllegalArgumentException - if source is null.

Method Detail

getMessage

public final Message getMessage()

Gets the message.

Returns:

The message.

isInbound

public final boolean isInbound()

Indicates, whether the stanza has been received (inbound) or is about to being sent (outbound).

Returns:

True, if the stanza is inbound; false if it is outbound.

consume

public final void consume()

Marks this event as consumed. For outbound stanzas, consuming this event cancels sending the stanza.

See Also:

isConsumed()

isConsumed

public final boolean isConsumed()

Indicates, whether this event has been consumed.

Returns:

True, if this event has been consumed.

See Also:

consume()

toString

public final java.lang.String toString()

Overrides:

toString in class java.util.EventObject