org.jivesoftware.smackx.pubsub

Class EventElement

java.lang.Object

org.jivesoftware.smackx.pubsub.EventElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement, EmbeddedPacketExtension

public class EventElement
extends Object
implements EmbeddedPacketExtension

Represents the top level element of a PubSub event extension. All types of PubSub events are represented by this class. The specific type can be found by getEventType(). The embedded event information, which is specific to the event type, can be retrieved by the getEvent() method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT The constant String "event".
static String	NAMESPACE The constant String "http://jabber.org/protocol/pubsub#event".

Constructor Summary

Constructors

Constructor and Description
EventElement(EventElementType eventType, NodeExtension eventExt)

Method Summary

Modifier and Type	Method and Description
static EventElement	from(Stanza stanza)
String	getElementName() Returns the root element name.
NodeExtension	getEvent()
EventElementType	getEventType()
List<ExtensionElement>	getExtensions() Get the list of embedded ExtensionElement objects.
String	getNamespace() Returns the root element XML namespace.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

The constant String "event".

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

The constant String "http://jabber.org/protocol/pubsub#event".

Constructor Detail

EventElement

public EventElement(EventElementType eventType,
                    NodeExtension eventExt)

Method Detail

getEventType

public EventElementType getEventType()

getExtensions

public List<ExtensionElement> getExtensions()

Description copied from interface: EmbeddedPacketExtension

Get the list of embedded ExtensionElement objects.

Specified by:

getExtensions in interface EmbeddedPacketExtension

Returns:

List of embedded ExtensionElement

getEvent

public NodeExtension getEvent()

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public XmlStringBuilder 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.

from

public static EventElement from(Stanza stanza)