/*
 * @(#)ParserListener.java	1.11 06/10/30
 * 
 * Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 * 
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 * 
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

package com.sun.java.help.impl;

/**
 * ParserListener defines the interface for an object that listens to 
 * parsing events in a Parser.
 *
 * @author Roger D. Brinkley
 * @version	1.11	10/30/06
 */

public interface ParserListener extends java.util.EventListener {
    /**
     * This tells the listener that a Tag was parsed
     *
     * @param e The event
     */
    public void tagFound(ParserEvent e);

    /**
     * This tells the listener that a PI was parsed
     *
     * @param e The event
     */
    public void piFound(ParserEvent e);

    /**
     * This tells the listener that a DOCTYPE was parsed
     *
     * @param e The event
     */
    public void doctypeFound(ParserEvent e);

    /**
     * This tells the listener that a continous block of text was parsed
     *
     * @param e The event
     */
    public void textFound(ParserEvent e);

    /**
     * This tells the listener that a comment was parsed
     *
     * @param e The event
     */
    public void commentFound(ParserEvent e);

    /**
     * This tells the listener that a error was parsed
     *
     * @param e The event
     */
    public void errorFound(ParserEvent e);

}
