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.smackx.iqprivate.provider;
019
020import java.io.IOException;
021
022import org.jivesoftware.smack.xml.XmlPullParser;
023import org.jivesoftware.smack.xml.XmlPullParserException;
024
025import org.jivesoftware.smackx.iqprivate.packet.PrivateData;
026
027/**
028 * An interface for parsing custom private data. Each PrivateDataProvider must
029 * be registered with the PrivateDataManager class for it to be used. Every implementation
030 * of this interface <b>must</b> have a public, no-argument constructor.
031 *
032 * @author Matt Tucker
033 */
034public interface PrivateDataProvider {
035
036    /**
037     * Parse the private data sub-document and create a PrivateData instance. At the
038     * beginning of the method call, the xml parser will be positioned at the opening
039     * tag of the private data child element. At the end of the method call, the parser
040     * <b>must</b> be positioned on the closing tag of the child element.
041     *
042     * @param parser an XML parser.
043     * @return a new PrivateData instance.
044     * @throws XmlPullParserException if an error in the XML parser occurred.
045     * @throws IOException if an I/O error occurred.
046     */
047    PrivateData parsePrivateData(XmlPullParser parser) throws XmlPullParserException, IOException;
048}