001/** 002 * 003 * Copyright 2003-2007 Jive Software. 004 * 005 * Licensed under the Apache License, Version 2.0 (the "License"); 006 * you may not use this file except in compliance with the License. 007 * You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 018package org.jivesoftware.smack.provider; 019 020import org.jivesoftware.smack.packet.IQ; 021import org.xmlpull.v1.XmlPullParser; 022 023/** 024 * An interface for parsing custom IQ packets. Each IQProvider must be registered with 025 * the ProviderManager class for it to be used. Every implementation of this 026 * interface <b>must</b> have a public, no-argument constructor. 027 * 028 * @author Matt Tucker 029 */ 030public interface IQProvider { 031 032 /** 033 * Parse the IQ sub-document and create an IQ instance. Each IQ must have a 034 * single child element. At the beginning of the method call, the xml parser 035 * will be positioned at the opening tag of the IQ child element. At the end 036 * of the method call, the parser <b>must</b> be positioned on the closing tag 037 * of the child element. 038 * 039 * @param parser an XML parser. 040 * @return a new IQ instance. 041 * @throws Exception if an error occurs parsing the XML. 042 */ 043 public IQ parseIQ(XmlPullParser parser) throws Exception; 044}