1 /** 2 * $RCSfile$ 3 * $Revision$ 4 * $Date$ 5 * 6 * Copyright 2003-2007 Jive Software. 7 * 8 * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); 9 * you may not use this file except in compliance with the License. 10 * You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, software 15 * distributed under the License is distributed on an "AS IS" BASIS, 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17 * See the License for the specific language governing permissions and 18 * limitations under the License. 19 */ 20 21 package org.jivesoftware.smack.provider; 22 23 import org.jivesoftware.smack.packet.IQ; 24 import org.xmlpull.v1.XmlPullParser; 25 26 /** 27 * An interface for parsing custom IQ packets. Each IQProvider must be registered with 28 * the ProviderManager class for it to be used. Every implementation of this 29 * interface <b>must</b> have a public, no-argument constructor. 30 * 31 * @author Matt Tucker 32 */ 33 public interface IQProvider { 34 35 /** 36 * Parse the IQ sub-document and create an IQ instance. Each IQ must have a 37 * single child element. At the beginning of the method call, the xml parser 38 * will be positioned at the opening tag of the IQ child element. At the end 39 * of the method call, the parser <b>must</b> be positioned on the closing tag 40 * of the child element. 41 * 42 * @param parser an XML parser. 43 * @return a new IQ instance. 44 * @throws Exception if an error occurs parsing the XML. 45 */ 46 public IQ parseIQ(XmlPullParser parser) throws Exception; 47 }
