/*
 *
 * This file is part of the iText (R) project.
    Copyright (c) 1998-2017 iText Group NV
 * Authors: Balder Van Camp, Emiel Ackermann, et al.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
 * OF THIRD PARTY RIGHTS
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details.
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
 * http://itextpdf.com/terms-of-use/
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License,
 * a covered work must retain the producer line in every PDF that is created
 * or manipulated using iText.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the iText software without
 * disclosing the source code of your own applications.
 * These activities include: offering paid services to customers as an ASP,
 * serving PDFs on the fly in a web application, shipping iText with a closed
 * source product.
 *
 * For more information, please contact iText Software Corp. at this
 * address: sales@itextpdf.com
 */
package com.itextpdf.tool.xml.parser;

import java.util.Map;

/**
 * Can be added to the {@link XMLParser} to receive events.
 *
 * @author redlab_b
 *
 */
public interface XMLParserListener {

	/**
	 * Triggered on an opening tag.
	 * @param tag the tag of the element
	 * @param attributes the attributes found on the tag
	 * @param ns the namespace or empty String
	 */
	void startElement(String tag, Map<String, String> attributes, String ns);

	/**
	 * Triggered on a closing tag.
	 * @param tag the tag
	 * @param ns the namespace or empty String
	 */
	void endElement(String tag, String ns);

	/**
	 * Triggered for text found outside root tag.
	 * @param text the text
	 */
	void unknownText(String text);

	/**
	 * Triggered for comments that are found.
	 * @param comment the comment
	 */
	void comment(String comment);

	/**
	 * Triggered when parsing has started.
	 */
	void init();

	/**
	 * Triggered when parsing is finished and the stream will be closed.
	 */
	void close();

	/**
	 * Called when text is encountered.
	 * @param text the text
	 */
	void text(String text);

}