javax.xml.stream.StreamFilter Maven / Gradle / Ivy
/*
* Portions Copyright 2000-2008 Sun Microsystems, Inc. All Rights
* Reserved. Use is subject to license terms.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
*
* This program 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.
*
* This program 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 at /legal/license.txt).
*
* 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 Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 or visit www.sun.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
* @version 1.0
* @author Copyright (c) 2003 by BEA Systems. All Rights Reserved.
*/
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.
*
* @param reader the event to test
* @return true if this filter accepts this event, false otherwise
*/
public boolean accept(XMLStreamReader reader);
}