You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
83 lines
2.2 KiB
83 lines
2.2 KiB
/*
|
|
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
|
|
*/
|
|
|
|
package javax.xml.stream.util;
|
|
|
|
import javax.xml.stream.events.XMLEvent;
|
|
import javax.xml.stream.XMLStreamReader;
|
|
import javax.xml.stream.XMLStreamException;
|
|
|
|
/**
|
|
* 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
|
|
* @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
|
|
* @see javax.xml.stream.XMLInputFactory
|
|
* @see javax.xml.stream.XMLEventFactory
|
|
* @since 1.6
|
|
*/
|
|
public interface XMLEventAllocator {
|
|
|
|
/**
|
|
* This method creates an instance of the XMLEventAllocator. This
|
|
* allows the XMLInputFactory to allocate a new instance per reader.
|
|
*/
|
|
public XMLEventAllocator newInstance();
|
|
|
|
/**
|
|
* 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 XMLEvent allocate(XMLStreamReader reader)
|
|
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. 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 void allocate(XMLStreamReader reader, XMLEventConsumer consumer)
|
|
throws XMLStreamException;
|
|
|
|
}
|