001/**
002 *
003 * Copyright © 2014 Florian Schmaus
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.SmackException;
023import org.jivesoftware.smack.packet.Element;
024import org.jivesoftware.smack.util.ParserUtils;
025import org.xmlpull.v1.XmlPullParser;
026import org.xmlpull.v1.XmlPullParserException;
027
028public abstract class Provider<E extends Element> {
029
030    public final E parse(XmlPullParser parser) throws XmlPullParserException, IOException, SmackException {
031        // XPP3 calling convention assert: Parser should be at start tag
032        ParserUtils.assertAtStartTag(parser);
033
034        final int initialDepth = parser.getDepth();
035        E e = parse(parser, initialDepth);
036
037        // XPP3 calling convention assert: Parser should be at end tag of the consumed/parsed element
038        ParserUtils.forwardToEndTagOfDepth(parser, initialDepth);
039        return e;
040    }
041
042    public abstract E parse(XmlPullParser parser, int initialDepth) throws XmlPullParserException, IOException, SmackException;
043}