rocks.xmpp.core.stanza

Class IQEvent

java.lang.Object

java.util.EventObject

rocks.xmpp.core.stanza.IQEvent

All Implemented Interfaces:

Serializable

public final class IQEvent
extends EventObject

An IQ event is fired whenever an IQ stanza is received or sent.

Author:

Christian Schudt

See Also:

IQListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected S	stanza

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
IQEvent(Object source, IQ iq, boolean incoming) Constructs an IQ event.

Method Summary

Modifier and Type	Method and Description
void	consume() Consumes this event, which basically indicates, that an IQ response has been sent by an event handler.
IQ	getIQ() Gets the IQ stanza.
S	getStanza() Gets the stanza.
boolean	isConsumed() Indicates, if this event has been consumed by an event handler, i.e. if the IQ has been responded to.
boolean	isIncoming() Indicates, whether the stanza has been received (incoming) or is about to being sent (outgoing).

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

stanza

protected final S extends Stanza & ClientStreamElement stanza

Constructor Detail

IQEvent

public IQEvent(Object source,
               IQ iq,
               boolean incoming)

Constructs an IQ event.

Parameters:

source - The object on which the event initially occurred.

iq - The IQ stanza.

incoming - True, if the stanza is incoming.

Throws:

IllegalArgumentException - if source is null.

Method Detail

getIQ

public IQ getIQ()

Gets the IQ stanza.

Returns:

The IQ stanza.

isConsumed

public boolean isConsumed()

Indicates, if this event has been consumed by an event handler, i.e. if the IQ has been responded to.

Returns:

True, if this event has been consumed.

consume

public void consume()

Consumes this event, which basically indicates, that an IQ response has been sent by an event handler.

isIncoming

public boolean isIncoming()

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

Returns:

True, if the stanza is incoming; false if it is outgoing.

getStanza

public S getStanza()

Gets the stanza.

Returns:

The stanza.