org.codehaus.stax2.XMLEventReader2 Maven / Gradle / Ivy
Go to download
Stax2 API is an extension to basic Stax 1.0 API that adds significant new functionality, such as full-featured bi-direction validation interface and high-performance Typed Access API.
package org.codehaus.stax2;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLStreamException;
/**
* Extended interface that implements functionality that is missing
* from {@link XMLEventReader}, based on findings on trying to
* implement Stax API v1.0.
*/
public interface XMLEventReader2
extends XMLEventReader
{
/**
* Method that is similar to {@link #hasNext}, except that it can
* throw a {@link XMLStreamException}. This is important distinction,
* since the underlying stream reader is NOT allowed to throw such an
* exception when its
* hasNext() gets called; but the underlying parser
* may well need to advance the input stream and in doing so may
* encounter an exception. This exception should be propagated to
* the caller, as it may signal a problem with the input stream
* or xml content.
*/
public boolean hasNextEvent() throws XMLStreamException;
/*
///////////////////////////////////////////////////////////
// Configuration
///////////////////////////////////////////////////////////
*/
/**
* Method similar to {@link javax.xml.stream.XMLInputFactory#isPropertySupported}, used
* to determine whether a property is supported by the Reader
* instance. This means that this method may return false
* for some properties that the input factory does support: specifically,
* it should only return true if the value is mutable on per-instance
* basis. False means that either the property is not recognized, or
* is not mutable via reader instance.
*
* @since 3.0
*/
public boolean isPropertySupported(String name);
/**
* Method that can be used to set per-reader properties; a subset of
* properties one can set via matching
* {@link org.codehaus.stax2.XMLInputFactory2}
* instance. Exactly which methods are mutable is implementation
* specific.
*
* @param name Name of the property to set
* @param value Value to set property to.
*
* @return True, if the specified property was succesfully
* set to specified value; false if its value was not changed
*
* @throws InvalidArgumentException if the property is not supported
* (or recognized) by the stream reader implementation
*
* @since 3.0
*/
public boolean setProperty(String name, Object value);
}