Package org.jivesoftware.smackx.pubsub

Class EventElement

java.lang.Object

org.jivesoftware.smackx.pubsub.EventElement

All Implemented Interfaces:

Element, ExtensionElement, FullyQualifiedElement, NamedElement, XmlLangElement, 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	Description
static String	ELEMENT	The constant String "event".
static String	NAMESPACE	The constant String "http://jabber.org/protocol/pubsub#event".
static QName	QNAME

Constructor Summary

Constructors

Constructor	Description
EventElement(EventElementType eventType, NodeExtension eventExt)

Method Summary

Modifier and Type	Method	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(XmlEnvironment enclosingNamespace)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

getLanguage, getQName

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".

QNAME

public static final QName QNAME

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: FullyQualifiedElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface FullyQualifiedElement

Returns:

the namespace.

toXML

public XmlStringBuilder toXML(XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface Element

from

public static EventElement from(Stanza stanza)