org.jivesoftware.smackx.pubsub

Class NodeExtension

java.lang.Object

org.jivesoftware.smackx.pubsub.NodeExtension

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

Direct Known Subclasses:

AffiliationsExtension, ConfigurationEvent, FormNode, GetItemsRequest, Item, ItemsExtension, OptionsExtension, PublishItem, SubscribeExtension, Subscription, SubscriptionsExtension, UnsubscribeExtension

public class NodeExtension
extends Object
implements ExtensionElement

A class which represents a common element within the pubsub defined schemas. One which has a node as an attribute. This class is used on its own as well as a base class for many others, since the node is a central concept to most pubsub functionality.

Constructor Summary

Constructors

Constructor and Description
NodeExtension(PubSubElementType elem) Constructs a NodeExtension with an element name specified by PubSubElementType.
NodeExtension(PubSubElementType elem, String nodeId) Constructs a NodeExtension with an element name specified by PubSubElementType and the specified node id.

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
String	getNode() Gets the node id.
PubSubNamespace	getPubSubNamespace()
String	toString()
CharSequence	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeExtension

public NodeExtension(PubSubElementType elem,
                     String nodeId)

Constructs a NodeExtension with an element name specified by PubSubElementType and the specified node id.

Parameters:

elem - Defines the element name and namespace

nodeId - Specifies the id of the node

NodeExtension

public NodeExtension(PubSubElementType elem)

Constructs a NodeExtension with an element name specified by PubSubElementType.

Parameters:

elem - Defines the element name and namespace

Method Detail

getNode

public String getNode()

Gets the node id.

Returns:

The node id

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getPubSubNamespace

public PubSubNamespace getPubSubNamespace()

getNamespace

public final String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

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

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

toString

public String toString()

Overrides:

toString in class Object