rocks.xmpp.extensions.pubsub.model.event

Class Event

java.lang.Object

rocks.xmpp.extensions.pubsub.model.event.Event

public final class Event
extends Object

The implementation of the <event/> element in the http://jabber.org/protocol/pubsub#event namespace.

See Also:

XEP-0060: Publish-Subscribe, XML Schema

Method Summary

Modifier and Type	Method and Description
DataForm	getConfigurationForm() Gets the configuration form.
List<Item>	getItems() Gets the items of the event.
String	getNode() Gets the 'node' attribute of the child element.
URI	getRedirectUri() Gets the redirect URI in case the event is a delete event.
Subscription	getSubscription() Gets the subscription approval.
boolean	isConfiguration() Indicates, whether the event is a configuration change event.
boolean	isDelete() Indicates, whether the event is a delete event.
boolean	isPurge() Indicates, whether the event is purge event.

Methods inherited from class java.lang.Object

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

Method Detail

getNode

public final String getNode()

Gets the 'node' attribute of the child element.

Returns:

The node.

isConfiguration

public final boolean isConfiguration()

Indicates, whether the event is a configuration change event.

Returns:

True, if the configuration has changed.

isDelete

public final boolean isDelete()

Indicates, whether the event is a delete event.

Returns:

True, if a node has been deleted.

isPurge

public final boolean isPurge()

Indicates, whether the event is purge event.

Returns:

True, if a node has been purged.

getSubscription

public final Subscription getSubscription()

Gets the subscription approval.

Returns:

The subscription approval or null, if the event did not include a subscription.

getItems

public final List<Item> getItems()

Gets the items of the event.

Returns:

The items of the event or an empty list, if the event did not include any items.

getConfigurationForm

public final DataForm getConfigurationForm()

Gets the configuration form.

Returns:

The configuration form or null, if the configuration form isn't included.

See Also:

isConfiguration()

getRedirectUri

public final URI getRedirectUri()

Gets the redirect URI in case the event is a delete event.

Returns:

The redirect URI or null, if a redirect URI isn't included.

See Also:

isDelete()