001/** 002 * 003 * Copyright © 2014-2019 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.packet.Element; 023import org.jivesoftware.smack.packet.XmlEnvironment; 024import org.jivesoftware.smack.parsing.SmackParsingException; 025import org.jivesoftware.smack.util.ParserUtils; 026import org.jivesoftware.smack.xml.XmlPullParser; 027import org.jivesoftware.smack.xml.XmlPullParserException; 028 029/** 030 * Smack provider are the parsers used to deserialize raw XMPP into the according Java {@link Element}s. 031 * <p> 032 * At any time when {@link #parse(XmlPullParser, int, XmlEnvironment)} is invoked any type of exception can be thrown. If the parsed 033 * element does not follow the specification, for example by putting a string where only integers are allowed, then a 034 * {@link org.jivesoftware.smack.SmackException} should be thrown. 035 * </p> 036 * 037 * @author Florian Schmaus 038 * @param <E> the type of the resulting element. 039 */ 040public abstract class Provider<E extends Element> extends AbstractProvider<E> { 041 042 public final E parse(XmlPullParser parser) throws IOException, XmlPullParserException, SmackParsingException { 043 return parse(parser, null); 044 } 045 046 public final E 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 E 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 public abstract E parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException; 061}