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 */
041public abstract class IQProvider<I extends IQ> extends IqProvider<I> {
042
043    public final I parse(XmlPullParser parser) throws IOException, XmlPullParserException, SmackParsingException {
044        return parse(parser, (XmlEnvironment) null);
045    }
046
047    public final I parse(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws IOException, XmlPullParserException, SmackParsingException {
048        // XPP3 calling convention assert: Parser should be at start tag
049        ParserUtils.assertAtStartTag(parser);
050
051        final int initialDepth = parser.getDepth();
052        final XmlEnvironment xmlEnvironment = XmlEnvironment.from(parser, outerXmlEnvironment);
053
054        I e = wrapExceptions(() -> parse(parser, initialDepth, xmlEnvironment));
055
056        // XPP3 calling convention assert: Parser should be at end tag of the consumed/parsed element
057        ParserUtils.forwardToEndTagOfDepth(parser, initialDepth);
058        return e;
059    }
060
061    @Override
062    public final I parse(XmlPullParser parser, int initialDepth, IqData iqData, XmlEnvironment xmlEnvironment)
063                    throws XmlPullParserException, IOException, SmackParsingException, ParseException {
064        // Old-style IQ parsers do not need IqData.
065        return parse(parser, initialDepth, xmlEnvironment);
066    }
067
068    public abstract I parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment)
069                    throws XmlPullParserException, IOException, SmackParsingException, ParseException;
070
071}