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 java.io.IOException; 021import java.text.ParseException; 022 023import org.jivesoftware.smack.packet.IQ; 024import org.jivesoftware.smack.packet.IqData; 025import org.jivesoftware.smack.packet.XmlEnvironment; 026import org.jivesoftware.smack.parsing.SmackParsingException; 027import org.jivesoftware.smack.util.ParserUtils; 028import org.jivesoftware.smack.xml.XmlPullParser; 029import org.jivesoftware.smack.xml.XmlPullParserException; 030 031/** 032 * <p> 033 * <b>Deprecation Notice:</b> This class is deprecated, use {@link IqProvider} instead. 034 * </p> 035 * An abstract class for parsing custom IQ packets. Each IQProvider must be registered with 036 * the ProviderManager class for it to be used. Every implementation of this 037 * abstract class <b>must</b> have a public, no-argument constructor. 038 * 039 * @author Matt Tucker 040 * @deprecated Use {@link IqProvider} instead 041 */ 042@Deprecated 043// TODO: Remove in Smack 4.6. 044public abstract class LegacyIQProvider<I extends IQ> extends IqProvider<I> { 045 046 public final I parse(XmlPullParser parser) throws IOException, XmlPullParserException, SmackParsingException { 047 return parse(parser, (XmlEnvironment) null); 048 } 049 050 public final I parse(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws IOException, XmlPullParserException, SmackParsingException { 051 // XPP3 calling convention assert: Parser should be at start tag 052 ParserUtils.assertAtStartTag(parser); 053 054 final int initialDepth = parser.getDepth(); 055 final XmlEnvironment xmlEnvironment = XmlEnvironment.from(parser, outerXmlEnvironment); 056 057 I e = wrapExceptions(() -> parse(parser, initialDepth, xmlEnvironment)); 058 059 // XPP3 calling convention assert: Parser should be at end tag of the consumed/parsed element 060 ParserUtils.forwardToEndTagOfDepth(parser, initialDepth); 061 return e; 062 } 063 064 @Override 065 public final I parse(XmlPullParser parser, int initialDepth, IqData iqData, XmlEnvironment xmlEnvironment) 066 throws XmlPullParserException, IOException, SmackParsingException, ParseException { 067 // Old-style IQ parsers do not need IqData. 068 return parse(parser, initialDepth, xmlEnvironment); 069 } 070 071 public abstract I parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment) 072 throws XmlPullParserException, IOException, SmackParsingException, ParseException; 073 074}