001/**
002 *
003 * Copyright 2013 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 */
017package org.jivesoftware.smack.parsing;
018
019/**
020 * Base class to receive parsing exceptions.
021 * 
022 * If this class is used as callback, then Smack will silently ignore the stanza that caused the parsing exception and
023 * place the parser after the faulty stanza.
024 * 
025 * Subclasses may or may not override certain methods of this class. Each of these methods will receive the exception
026 * that caused the parsing error and an instance of an Unparsed Packet type. The latter can be used to inspect the
027 * stanza that caused the parsing error by using the getContent() (for example {@link UnparsablePacket#getContent()})
028 * method.
029 * 
030 * Smack provides 2 predefined ParsingExceptionCallback's: {@link ExceptionLoggingCallback} and {@link ExceptionThrowingCallback}.
031 * 
032 * @author Florian Schmaus
033 * 
034 */
035public abstract class ParsingExceptionCallback {
036
037    /**
038     * Called when parsing an message stanza caused an exception.
039     * 
040     * @param stanzaData
041     * the raw message stanza data that caused the exception
042     * @throws Exception
043     */
044    public void handleUnparsablePacket(UnparsablePacket stanzaData) throws Exception {
045    }
046}