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.XMLStreamReader;
33  import javax.xml.stream.XMLStreamException;
34  
35  /**
36   * This interface defines a class that allows a user to register
37   * a way to allocate events given an XMLStreamReader.  An implementation
38   * is not required to use the XMLEventFactory implementation but this
39   * is recommended.  The XMLEventAllocator can be set on an XMLInputFactory
40   * using the property "javax.xml.stream.allocator"
41   *
42   * @version 1.0
43   * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
44   * @see javax.xml.stream.XMLInputFactory
45   * @see javax.xml.stream.XMLEventFactory
46   * @since 1.6
47   */
48  public interface XMLEventAllocator {
49  
50    /**
51     * This method creates an instance of the XMLEventAllocator. This
52     * allows the XMLInputFactory to allocate a new instance per reader.
53     */
54    public XMLEventAllocator newInstance();
55  
56    /**
57     * This method allocates an event given the current
58     * state of the XMLStreamReader.  If this XMLEventAllocator
59     * does not have a one-to-one mapping between reader states
60     * and events this method will return null.  This method
61     * must not modify the state of the XMLStreamReader.
62     * @param reader The XMLStreamReader to allocate from
63     * @return the event corresponding to the current reader state
64     */
65    public XMLEvent allocate(XMLStreamReader reader)
66      throws XMLStreamException;
67  
68    /**
69     * This method allocates an event or set of events
70     * given the current
71     * state of the XMLStreamReader and adds the event
72     * or set of events to the
73     * consumer that was passed in.  This method can be used
74     * to expand or contract reader states into event states.
75     * This method may modify the state of the XMLStreamReader.
76     * @param reader The XMLStreamReader to allocate from
77     * @param consumer The XMLEventConsumer to add to.
78     */
79    public void allocate(XMLStreamReader reader, XMLEventConsumer consumer)
80      throws XMLStreamException;
81  
82  }