View Javadoc
1   /*
2    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3    *
4    * This code is free software; you can redistribute it and/or modify it
5    * under the terms of the GNU General Public License version 2 only, as
6    * published by the Free Software Foundation.  Oracle designates this
7    * particular file as subject to the "Classpath" exception as provided
8    * by Oracle in the LICENSE file that accompanied this code.
9    *
10   * This code is distributed in the hope that it will be useful, but WITHOUT
11   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13   * version 2 for more details (a copy is included in the LICENSE file that
14   * accompanied this code).
15   *
16   * You should have received a copy of the GNU General Public License version
17   * 2 along with this work; if not, write to the Free Software Foundation,
18   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19   *
20   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21   * or visit www.oracle.com if you need additional information or have any
22   * questions.
23   */
24  
25  /*
26   * Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
27   */
28  
29  package javax.xml.stream;
30  
31  /**
32   * This interface declares a simple filter interface that one can
33   * create to filter XMLStreamReaders
34   * @version 1.0
35   * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
36   * @since 1.6
37   */
38  public interface StreamFilter {
39  
40    /**
41     * Tests whether the current state is part of this stream.  This method
42     * will return true if this filter accepts this event and false otherwise.
43     *
44     * The method should not change the state of the reader when accepting
45     * a state.
46     *
47     * @param reader the event to test
48     * @return true if this filter accepts this event, false otherwise
49     */
50    public boolean accept(XMLStreamReader reader);
51  }