Smack

org.jivesoftware.smackx.pubsub
Class EventElement

java.lang.Object
  extended by org.jivesoftware.smackx.pubsub.EventElement
All Implemented Interfaces:
PacketExtension, EmbeddedPacketExtension

public class EventElement
extends java.lang.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.

Author:
Robin Collier

Constructor Summary
EventElement(EventElementType eventType, NodeExtension eventExt)
           
 
Method Summary
 java.lang.String getElementName()
          Returns the root element name.
 NodeExtension getEvent()
           
 EventElementType getEventType()
           
 java.util.List<PacketExtension> getExtensions()
          Get the list of embedded PacketExtension objects.
 java.lang.String getNamespace()
          Returns the root element XML namespace.
 java.lang.String toXML()
          Returns the XML representation of the PacketExtension.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EventElement

public EventElement(EventElementType eventType,
                    NodeExtension eventExt)
Method Detail

getEventType

public EventElementType getEventType()

getExtensions

public java.util.List<PacketExtension> getExtensions()
Description copied from interface: EmbeddedPacketExtension
Get the list of embedded PacketExtension objects.

Specified by:
getExtensions in interface EmbeddedPacketExtension
Returns:
List of embedded PacketExtension

getEvent

public NodeExtension getEvent()

getElementName

public java.lang.String getElementName()
Description copied from interface: PacketExtension
Returns the root element name.

Specified by:
getElementName in interface PacketExtension
Returns:
the element name.

getNamespace

public java.lang.String getNamespace()
Description copied from interface: PacketExtension
Returns the root element XML namespace.

Specified by:
getNamespace in interface PacketExtension
Returns:
the namespace.

toXML

public java.lang.String toXML()
Description copied from interface: PacketExtension
Returns the XML representation of the PacketExtension.

Specified by:
toXML in interface PacketExtension
Returns:
the packet extension as XML.

Smack

Copyright © 2003-2007 Jive Software.