com.sun.xml.fastinfoset.stax.events

Class StAXEventAllocatorBase

java.lang.Object

com.sun.xml.fastinfoset.stax.events.StAXEventAllocatorBase

All Implemented Interfaces:

XMLEventAllocator

public class StAXEventAllocatorBase
extends Object
implements XMLEventAllocator

allows a user to register a way to allocate events given an XMLStreamReader. The XMLEventAllocator can be set on an XMLInputFactory using the property "javax.xml.stream.allocator" This base class uses EventFactory to create events as recommended in the JavaDoc of XMLEventAllocator. However, creating new object per each event reduces performance. The implementation of EventReader therefore will set the Allocator to StAXEventAllocator which implements the Allocate methods without creating new objects. The spec for the first Allocate method states that it must NOT modify the state of the Reader while the second MAY. For consistency, both Allocate methods in this implementation will NOT modify the state.

Constructor Summary

Constructors

Constructor and Description
StAXEventAllocatorBase() Creates a new instance of XMLEventAllocator

Method Summary

Modifier and Type	Method and Description
protected void	addAttributes(StartElementEvent event, XMLStreamReader streamReader)
protected void	addNamespaces(EndElementEvent event, XMLStreamReader streamReader)
protected void	addNamespaces(StartElementEvent event, XMLStreamReader streamReader)
XMLEvent	allocate(XMLStreamReader streamReader) This method allocates an event given the current state of the XMLStreamReader.
void	allocate(XMLStreamReader streamReader, 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.
XMLEventAllocator	newInstance() This method creates an instance of the XMLEventAllocator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StAXEventAllocatorBase

public StAXEventAllocatorBase()

Creates a new instance of XMLEventAllocator

Method Detail

newInstance

public XMLEventAllocator newInstance()

This method creates an instance of the XMLEventAllocator. This allows the XMLInputFactory to allocate a new instance per reader.

Specified by:

newInstance in interface XMLEventAllocator

allocate

public XMLEvent allocate(XMLStreamReader streamReader)
                  throws XMLStreamException

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 state and events this method will return null.

Specified by:

allocate in interface XMLEventAllocator

Parameters:

streamReader - The XMLStreamReader to allocate from

Returns:

the event corresponding to the current reader state

Throws:

XMLStreamException

allocate

public void allocate(XMLStreamReader streamReader,
                     XMLEventConsumer consumer)
              throws XMLStreamException

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.

Specified by:

allocate in interface XMLEventAllocator

Parameters:

streamReader - The XMLStreamReader to allocate from

consumer - The XMLEventConsumer to add to.

Throws:

XMLStreamException

addAttributes

protected void addAttributes(StartElementEvent event,
                             XMLStreamReader streamReader)

addNamespaces

protected void addNamespaces(StartElementEvent event,
                             XMLStreamReader streamReader)

addNamespaces

protected void addNamespaces(EndElementEvent event,
                             XMLStreamReader streamReader)