C# Class SimpleFramework.Xml.Stream.Provider

The Provider object is used to represent the provider of an XML parser. All XML parsers are represented as an event reader much like the StAX event reader. Providing a interface to the parser in this manner ensures that the core framework is not coupled to any specific implementation and also ensures that it should run in multiple environments that may support specific XML parsers.
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.

Method Details

Provide() public abstract 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 abstract Provide ( Stream source ) : EventReader
source System.IO.Stream /// this is the stream to read the document with ///
return EventReader

Provide() public abstract 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 abstract Provide ( TextReader source ) : EventReader
source System.IO.TextReader /// this is the reader to read the document with ///
return EventReader