Smack

org.jivesoftware.smack.provider
Interface PacketExtensionProvider

All Known Implementing Classes:
AdHocCommandDataProvider.BadActionError, AdHocCommandDataProvider.BadLocaleError, AdHocCommandDataProvider.BadPayloadError, AdHocCommandDataProvider.BadSessionIDError, AdHocCommandDataProvider.MalformedActionError, AdHocCommandDataProvider.SessionExpiredError, AffiliationProvider, AffiliationsProvider, AgentStatus.Provider, AttentionExtension.Provider, CapsExtensionProvider, ChatStateExtension.Provider, ConfigEventProvider, DataFormProvider, DataPacketProvider, DelayInfoProvider, DelayInformationProvider, DeliveryReceipt.Provider, DeliveryReceiptRequest.Provider, EmbeddedExtensionProvider, EmbeddedExtensionProvider, EventProvider, FormNodeProvider, GroupChatInvitation.Provider, HeaderProvider, HeadersProvider, ItemProvider, ItemsProvider, MessageEventProvider, MetaDataProvider, MUCUserProvider, MultipleAddressesProvider, Nick.Provider, OfflineMessageInfo.Provider, PEPProvider, QueueDetails.Provider, QueueOverview.Provider, QueueUpdate.Provider, RetractEventProvider, RoomInvitation.Provider, RoomTransfer.Provider, RosterExchangeProvider, SessionID.Provider, SimpleNodeProvider, SubscriptionProvider, SubscriptionsProvider, UserID.Provider, WorkgroupInformation.Provider, XHTMLExtensionProvider

public interface PacketExtensionProvider

An interface for parsing custom packets extensions. Each PacketExtensionProvider must be registered with the ProviderManager class for it to be used. Every implementation of this interface must have a public, no-argument constructor.

Author:
Matt Tucker

Method Summary
 PacketExtension parseExtension(org.xmlpull.v1.XmlPullParser parser)
          Parse an extension sub-packet and create a PacketExtension instance.
 

Method Detail

parseExtension

PacketExtension parseExtension(org.xmlpull.v1.XmlPullParser parser)
                               throws java.lang.Exception
Parse an extension sub-packet and create a PacketExtension instance. At the beginning of the method call, the xml parser will be positioned on the opening element of the packet extension. At the end of the method call, the parser must be positioned on the closing element of the packet extension.

Parameters:
parser - an XML parser.
Returns:
a new IQ instance.
Throws:
java.lang.Exception - if an error occurs parsing the XML.

Smack

Copyright © 2003-2007 Jive Software.