org.simpleframework.xml.stream

Class StreamProvider

java.lang.Object

org.simpleframework.xml.stream.StreamProvider

All Implemented Interfaces:

Provider

public class StreamProvider
extends java.lang.Object
implements Provider

The StreamProvider object is used to provide event reader implementations for StAX. Wrapping the mechanics of the StAX framework within a Provider ensures that it can be plugged in without any dependencies. This allows other parsers to be swapped in should there be such a requirement.

See Also:

StreamProvider

Constructor Summary

Constructors

Constructor and Description
StreamProvider() Constructor for the StreamProvider object.
StreamProvider(javax.xml.stream.XMLInputFactory factory) Constructor for the StreamProvider object using an externally configured XML input factory.

Method Summary

Modifier and Type	Method and Description
EventReader	provide(java.io.InputStream source) This provides an EventReader that will read from the specified input stream.
EventReader	provide(java.io.Reader source) This provides an EventReader that will read from the specified reader.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamProvider

public StreamProvider(javax.xml.stream.XMLInputFactory factory)

Constructor for the StreamProvider object using an externally configured XML input factory.

StreamProvider

public StreamProvider()

Constructor for the StreamProvider object. This constructor uses the default XMLInputFactory.newInstance() and preconfigures the factory with safe defaults.

Method Detail

provide

public EventReader provide(java.io.InputStream source)
                    throws java.lang.Exception

This provides an EventReader that will read from the specified input stream. When reading from an input stream the character encoding should be taken from the XML prolog or it should default to the UTF-8 character encoding.

Specified by:

provide in interface Provider

Parameters:

source - this is the stream to read the document with

Returns:

this is used to return the event reader implementation

Throws:

java.lang.Exception

provide

public EventReader provide(java.io.Reader source)
                    throws java.lang.Exception

This provides an EventReader that will read from the specified reader. When reading from a reader the character encoding should be the same as the source XML document.

Specified by:

provide in interface Provider

Parameters:

source - this is the reader to read the document with

Returns:

this is used to return the event reader implementation

Throws:

java.lang.Exception