File Doc Category Size Date Package
XMLEventAllocator.java API Doc Java SE 6 API 2050 Tue Jun 10 00:27:12 BST 2008 javax.xml.stream.util

XMLEventAllocator

public interface XMLEventAllocator

This interface defines a class that allows a user to register a way to allocate events given an XMLStreamReader. An implementation is not required to use the XMLEventFactory implementation but this is recommended. The XMLEventAllocator can be set on an XMLInputFactory using the property "javax.xml.stream.allocator"

version: 1.0
see: javax.xml.stream.XMLInputFactory
see: javax.xml.stream.XMLEventFactory
since: 1.6

Fields Summary
Constructors Summary
Methods Summary
public javax.xml.stream.events.XMLEvent allocate(javax.xml.stream.XMLStreamReader reader)
This method allocates an event given the current state of the XMLStreamReader. If this XMLEventAllocator does not have a one-to-one mapping between reader states and events this method will return null. This method must not modify the state of the XMLStreamReader.
param
reader The XMLStreamReader to allocate from
return
the event corresponding to the current reader state
public void allocate(javax.xml.stream.XMLStreamReader reader, javax.xml.stream.util.XMLEventConsumer consumer)
This method allocates an event or set of events given the current state of the XMLStreamReader and adds the event or set of events to the consumer that was passed in. This method can be used to expand or contract reader states into event states. This method may modify the state of the XMLStreamReader.
param
reader The XMLStreamReader to allocate from
param
consumer The XMLEventConsumer to add to.
public javax.xml.stream.util.XMLEventAllocator newInstance()
This method creates an instance of the XMLEventAllocator. This allows the XMLInputFactory to allocate a new instance per reader.