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