/*
 * Copyright (c) 2009, 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.
 */

package javax.xml.stream;

This interface declares a simple filter interface that one can create to filter XMLStreamReaders
Author:Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
Version:1.0
Since:1.6
/** * This interface declares a simple filter interface that one can * create to filter XMLStreamReaders * @version 1.0 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved. * @since 1.6 */
public interface StreamFilter {
Tests whether the current state is part of this stream. This method will return true if this filter accepts this event and false otherwise. The method should not change the state of the reader when accepting a state.
Params:
  • reader – the event to test
Returns:true if this filter accepts this event, false otherwise
/** * Tests whether the current state is part of this stream. This method * will return true if this filter accepts this event and false otherwise. * * The method should not change the state of the reader when accepting * a state. * * @param reader the event to test * @return true if this filter accepts this event, false otherwise */
public boolean accept(XMLStreamReader reader); }