/*

 * Copyright (c) 2000, 2005, Oracle and/or its affiliates. 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.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

// XMLFilter.java - filter SAX2 events.

// http://www.saxproject.org

// Written by David Megginson

// NO WARRANTY!  This class is in the Public Domain.

// $Id: XMLFilter.java,v 1.2 2004/11/03 22:55:32 jsuttor Exp $

package org.xml.sax;

/**

 * Interface for an XML filter.

 *

 * <blockquote>

 * <em>This module, both source code and documentation, is in the

 * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>

 * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>

 * for further information.

 * </blockquote>

 *

 * <p>An XML filter is like an XML reader, except that it obtains its

 * events from another XML reader rather than a primary source like

 * an XML document or database.  Filters can modify a stream of

 * events as they pass on to the final application.</p>

 *

 * <p>The XMLFilterImpl helper class provides a convenient base

 * for creating SAX2 filters, by passing on all {@link org.xml.sax.EntityResolver

 * EntityResolver}, {@link org.xml.sax.DTDHandler DTDHandler},

 * {@link org.xml.sax.ContentHandler ContentHandler} and {@link org.xml.sax.ErrorHandler

 * ErrorHandler} events automatically.</p>

 *

 * @author David Megginson

 * @see org.xml.sax.helpers.XMLFilterImpl

 */

public interface XMLFilter extends XMLReader

{

    /**

     * Set the parent reader.

     *

     * <p>This method allows the application to link the filter to

     * a parent reader (which may be another filter).  The argument

     * may not be null.</p>

     *

     * @param parent The parent reader.

     */

    public abstract void setParent (XMLReader parent);

    /**

     * Get the parent reader.

     *

     * <p>This method allows the application to query the parent

     * reader (which may be another filter).  It is generally a

     * bad idea to perform any operations on the parent reader

     * directly: they should all pass through this filter.</p>

     *

     * @return The parent filter, or null if none has been set.

     */

    public abstract XMLReader getParent ();

}

// end of XMLFilter.java