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.smackx.provider; 22 23 import org.xmlpull.v1.XmlPullParser; 24 import org.jivesoftware.smackx.packet.PrivateData; 25 26 /** 27 * An interface for parsing custom private data. Each PrivateDataProvider must 28 * be registered with the PrivateDataManager class for it to be used. Every implementation 29 * of this interface <b>must</b> have a public, no-argument constructor. 30 * 31 * @author Matt Tucker 32 */ 33 public interface PrivateDataProvider { 34 35 /** 36 * Parse the private data sub-document and create a PrivateData instance. At the 37 * beginning of the method call, the xml parser will be positioned at the opening 38 * tag of the private data child element. At the end of the method call, the parser 39 * <b>must</b> be positioned on the closing tag of the child element. 40 * 41 * @param parser an XML parser. 42 * @return a new PrivateData instance. 43 * @throws Exception if an error occurs parsing the XML. 44 */ parsePrivateData(XmlPullParser parser)45 public PrivateData parsePrivateData(XmlPullParser parser) throws Exception; 46 } 47