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