org.jivesoftware.smack.provider

Interface IQProvider

All Known Implementing Classes:

AbstractHttpOverXmppProvider, AdHocCommandDataProvider, AgentChatHistory.InternalProvider, AgentInfo.Provider, AgentStatusRequest.Provider, AgentWorkgroups.Provider, BytestreamsProvider, ChatMetadata.Provider, ChatNotes.Provider, ChatSettings.InternalProvider, CloseIQProvider, DataPacketProvider, DiscoverInfoProvider, DiscoverItemsProvider, GenericSettings.InternalProvider, HttpOverXmppReqProvider, HttpOverXmppRespProvider, LastActivity.Provider, Macros.InternalProvider, MonitorPacket.InternalProvider, MUCAdminProvider, MUCOwnerProvider, OccupantsInfo.Provider, OfferConfirmation.Provider, OfferRequestProvider, OfferRevokeProvider, OfflineMessageRequest.Provider, OfflineSettings.InternalProvider, OpenIQProvider, PingProvider, PrivacyProvider, PrivateDataManager.PrivateDataIQProvider, PubSubProvider, SearchSettings.InternalProvider, SharedGroupsInfo.Provider, SoundSettings.InternalProvider, StreamInitiationProvider, TranscriptProvider, TranscriptSearch.Provider, TranscriptsProvider, UserSearch.Provider, VCardProvider, VersionProvider, WorkgroupForm.InternalProvider, WorkgroupProperties.InternalProvider

public interface IQProvider

An interface for parsing custom IQ packets. Each IQProvider 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

Modifier and Type	Method and Description
IQ	parseIQ(org.xmlpull.v1.XmlPullParser parser) Parse the IQ sub-document and create an IQ instance.

Method Detail

parseIQ

IQ parseIQ(org.xmlpull.v1.XmlPullParser parser)
    throws Exception

Parse the IQ sub-document and create an IQ instance. Each IQ must have a single child element. At the beginning of the method call, the xml parser will be positioned at the opening tag of the IQ child element. At the end of the method call, the parser must be positioned on the closing tag of the child element.

Parameters:

parser - an XML parser.

Returns:

a new IQ instance.

Throws:

Exception - if an error occurs parsing the XML.