C# Class SimpleFramework.Xml.Stream.StreamProvider

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.

Inheritance: Provider

Mostra file Open project: ngallagher/simplexml

Public Methods

Method	Description
Provide ( Stream source ) : EventReader	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.
Provide ( TextReader source ) : EventReader	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.
Provide ( XmlReader source ) : EventReader	This provides an `EventReader` that will read from the specified reader. The returned event reader is basically a wrapper for the provided StAX implementation.
StreamProvider ( ) : System.IO	Constructor for the `StreamProvider` object. This is used to instantiate a parser factory that will be used to create parsers when requested. Instantiating the factory up front also checks that the framework is fully supported.

Method Details

Provide() public method

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.

public Provide ( Stream source ) : EventReader
source	System.IO.Stream	/// this is the stream to read the document with ///
return	EventReader

Provide() public method

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.

public Provide ( TextReader source ) : EventReader
source	System.IO.TextReader	/// this is the reader to read the document with ///
return	EventReader

Provide() public method

This provides an EventReader that will read from the specified reader. The returned event reader is basically a wrapper for the provided StAX implementation.

public Provide ( XmlReader source ) : EventReader
source	XmlReader	/// this is the reader to read the document with ///
return	EventReader

StreamProvider() public method

Constructor for the StreamProvider object. This is used to instantiate a parser factory that will be used to create parsers when requested. Instantiating the factory up front also checks that the framework is fully supported.

public StreamProvider ( ) : System.IO
return	System.IO