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 26 package javax.xml.stream.util; 27 28 import javax.xml.stream.events.XMLEvent; 29 import javax.xml.stream.XMLStreamException; 30 31 /** 32 * This interface defines an event consumer interface. The contract of the 33 * of a consumer is to accept the event. This interface can be used to 34 * mark an object as able to receive events. Add may be called several 35 * times in immediate succession so a consumer must be able to cache 36 * events it hasn't processed yet. 37 * 38 * @version 1.0 39 * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved. 40 * @since 1.6 41 */ 42 public interface XMLEventConsumer { 43 44 /** 45 * This method adds an event to the consumer. Calling this method 46 * invalidates the event parameter. The client application should 47 * discard all references to this event upon calling add. 48 * The behavior of an application that continues to use such references 49 * is undefined. 50 * 51 * @param event the event to add, may not be null 52 */ 53 public void add(XMLEvent event) 54 throws XMLStreamException; 55 }