1/*
2 * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.xml.stream;
27
28/**
29 * This interface declares a simple filter interface that one can
30 * create to filter XMLStreamReaders
31 * @version 1.0
32 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
33 * @since 1.6
34 */
35public interface StreamFilter {
36
37  /**
38   * Tests whether the current state is part of this stream.  This method
39   * will return true if this filter accepts this event and false otherwise.
40   *
41   * The method should not change the state of the reader when accepting
42   * a state.
43   *
44   * @param reader the event to test
45   * @return true if this filter accepts this event, false otherwise
46   */
47  public boolean accept(XMLStreamReader reader);
48}
49