mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-11-26 14:02:06 +01:00
fdb4b017ff
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2408 b35dd754-fafc-0310-a699-88a17e54d16e
47 lines
No EOL
1.6 KiB
Java
47 lines
No EOL
1.6 KiB
Java
/**
|
|
* $RCSfile$
|
|
* $Revision$
|
|
* $Date$
|
|
*
|
|
* Copyright 2003-2004 Jive Software.
|
|
*
|
|
* All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package org.jivesoftware.smack.provider;
|
|
|
|
import org.jivesoftware.smack.packet.IQ;
|
|
import org.xmlpull.v1.XmlPullParser;
|
|
|
|
/**
|
|
* 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 <b>must</b> have a public, no-argument constructor.
|
|
*
|
|
* @author Matt Tucker
|
|
*/
|
|
public interface IQProvider {
|
|
|
|
/**
|
|
* 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 <b>must</b> be positioned on the closing tag
|
|
* of the child element.
|
|
*
|
|
* @param parser an XML parser.
|
|
* @return a new IQ instance.
|
|
* @throws Exception if an error occurs parsing the XML.
|
|
*/
|
|
public IQ parseIQ(XmlPullParser parser) throws Exception;
|
|
} |