01 /*
02 * Copyright 2000-2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 // XMLFilter.java - filter SAX2 events.
27 // http://www.saxproject.org
28 // Written by David Megginson
29 // NO WARRANTY! This class is in the Public Domain.
30 // $Id: XMLFilter.java,v 1.2 2004/11/03 22:55:32 jsuttor Exp $
31 package org.xml.sax;
32
33 /**
34 * Interface for an XML filter.
35 *
36 * <blockquote>
37 * <em>This module, both source code and documentation, is in the
38 * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
39 * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
40 * for further information.
41 * </blockquote>
42 *
43 * <p>An XML filter is like an XML reader, except that it obtains its
44 * events from another XML reader rather than a primary source like
45 * an XML document or database. Filters can modify a stream of
46 * events as they pass on to the final application.</p>
47 *
48 * <p>The XMLFilterImpl helper class provides a convenient base
49 * for creating SAX2 filters, by passing on all {@link org.xml.sax.EntityResolver
50 * EntityResolver}, {@link org.xml.sax.DTDHandler DTDHandler},
51 * {@link org.xml.sax.ContentHandler ContentHandler} and {@link org.xml.sax.ErrorHandler
52 * ErrorHandler} events automatically.</p>
53 *
54 * @since SAX 2.0
55 * @author David Megginson
56 * @version 2.0.1 (sax2r2)
57 * @see org.xml.sax.helpers.XMLFilterImpl
58 */
59 public interface XMLFilter extends XMLReader {
60
61 /**
62 * Set the parent reader.
63 *
64 * <p>This method allows the application to link the filter to
65 * a parent reader (which may be another filter). The argument
66 * may not be null.</p>
67 *
68 * @param parent The parent reader.
69 */
70 public abstract void setParent(XMLReader parent);
71
72 /**
73 * Get the parent reader.
74 *
75 * <p>This method allows the application to query the parent
76 * reader (which may be another filter). It is generally a
77 * bad idea to perform any operations on the parent reader
78 * directly: they should all pass through this filter.</p>
79 *
80 * @return The parent filter, or null if none has been set.
81 */
82 public abstract XMLReader getParent();
83
84 }
85
86 // end of XMLFilter.java
|