org.jivesoftware.smackx.pubsub

Class SubscriptionsExtension

java.lang.Object

org.jivesoftware.smackx.pubsub.NodeExtension

org.jivesoftware.smackx.pubsub.SubscriptionsExtension

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class SubscriptionsExtension
extends NodeExtension

Represents the element holding the list of subscription elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionsExtension.SubscriptionsNamespace

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Subscription>	items

Constructor Summary

Constructors

Constructor and Description
SubscriptionsExtension(List<Subscription> subList) Subscriptions to the root node.
SubscriptionsExtension(String nodeId, List<Subscription> subList) Subscriptions to the specified node.
SubscriptionsExtension(SubscriptionsExtension.SubscriptionsNamespace subscriptionsNamespace, String nodeId, List<Subscription> subList) Subscriptions to the specified node.

Method Summary

Modifier and Type	Method and Description
List<Subscription>	getSubscriptions() Gets the list of subscriptions.
CharSequence	toXML(String enclosingNamespace) Returns the XML representation of this Element.

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

getElementName, getNamespace, getNode, getPubSubNamespace, toString

Methods inherited from class java.lang.Object

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

Field Detail

items

protected List<Subscription> items

Constructor Detail

SubscriptionsExtension

public SubscriptionsExtension(List<Subscription> subList)

Subscriptions to the root node.

Parameters:

subList - The list of subscriptions

SubscriptionsExtension

public SubscriptionsExtension(String nodeId,
                              List<Subscription> subList)

Subscriptions to the specified node.

Parameters:

nodeId - The node subscribed to

subList - The list of subscriptions

SubscriptionsExtension

public SubscriptionsExtension(SubscriptionsExtension.SubscriptionsNamespace subscriptionsNamespace,
                              String nodeId,
                              List<Subscription> subList)

Subscriptions to the specified node.

Parameters:

subscriptionsNamespace - the namespace used by this element

nodeId - The node subscribed to

subList - The list of subscriptions

Since:

4.3

Method Detail

getSubscriptions

public List<Subscription> getSubscriptions()

Gets the list of subscriptions.

Returns:

List of subscriptions

toXML

public CharSequence toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Overrides:

toXML in class NodeExtension

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.