org.jivesoftware.smackx.pubsub

Class ItemPublishEvent<T extends Item>

java.lang.Object

org.jivesoftware.smackx.pubsub.NodeEvent

org.jivesoftware.smackx.pubsub.SubscriptionEvent

org.jivesoftware.smackx.pubsub.ItemPublishEvent<T>

public class ItemPublishEvent<T extends Item>
extends SubscriptionEvent

Represents an event generated by an item(s) being published to a node.

Constructor Summary

Constructors

Constructor and Description
ItemPublishEvent(String nodeId, List<T> eventItems) Constructs an ItemPublishEvent with the provided list of Item that were published.
ItemPublishEvent(String nodeId, List<T> eventItems, List<String> subscriptionIds) Constructs an ItemPublishEvent with the provided list of Item that were published.
ItemPublishEvent(String nodeId, List<T> eventItems, List<String> subscriptionIds, Date publishedDate) Constructs an ItemPublishEvent with the provided list of Item that were published in the past.

Method Summary

Modifier and Type	Method and Description
List<T>	getItems() Get the list of Item that were published.
Date	getPublishedDate() Gets the original date the items were published.
boolean	isDelayed() Indicates whether this event was delayed.
String	toString()

Methods inherited from class org.jivesoftware.smackx.pubsub.SubscriptionEvent

getSubscriptions, setSubscriptions

Methods inherited from class org.jivesoftware.smackx.pubsub.NodeEvent

getNodeId

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemPublishEvent

public ItemPublishEvent(String nodeId,
                        List<T> eventItems)

Constructs an ItemPublishEvent with the provided list of Item that were published.

Parameters:

nodeId - The id of the node the event came from

eventItems - The list of Item that were published

ItemPublishEvent

public ItemPublishEvent(String nodeId,
                        List<T> eventItems,
                        List<String> subscriptionIds)

Constructs an ItemPublishEvent with the provided list of Item that were published. The list of subscription ids represents the subscriptions that matched the event, in the case of the user having multiple subscriptions.

Parameters:

nodeId - The id of the node the event came from

eventItems - The list of Item that were published

subscriptionIds - The list of subscriptionIds

ItemPublishEvent

public ItemPublishEvent(String nodeId,
                        List<T> eventItems,
                        List<String> subscriptionIds,
                        Date publishedDate)

Constructs an ItemPublishEvent with the provided list of Item that were published in the past. The published date signifies that this is delayed event. The list of subscription ids represents the subscriptions that matched the event, in the case of the user having multiple subscriptions.

Parameters:

nodeId - The id of the node the event came from

eventItems - The list of Item that were published

subscriptionIds - The list of subscriptionIds

publishedDate - date of publication.

Method Detail

getItems

public List<T> getItems()

Get the list of Item that were published.

Returns:

The list of published Item

isDelayed

public boolean isDelayed()

Indicates whether this event was delayed. That is, the items were published to the node at some time in the past. This will typically happen if there is an item already published to the node before a user subscribes to it. In this case, when the user subscribes, the server may send the last item published to the node with a delay date showing its time of original publication.

Returns:

true if the items are delayed, false otherwise.

getPublishedDate

public Date getPublishedDate()

Gets the original date the items were published. This is only valid if isDelayed() is true.

Returns:

date of publication.

toString

public String toString()

Overrides:

toString in class Object