Package org.simpleframework.xml.stream
Class DocumentProvider
java.lang.Object
org.simpleframework.xml.stream.DocumentProvider
- All Implemented Interfaces:
Provider
The
DocumentProvider
object is used to provide event
reader implementations for DOM. Wrapping the mechanics of the
DOM 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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final DocumentBuilderFactory
This is the factory that is used to create DOM parsers. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprovide
(InputStream source) This provides anEventReader
that will read from the specified input stream.This provides anEventReader
that will read from the specified reader.private EventReader
provide
(InputSource source) This provides anEventReader
that will read from the specified source.
-
Field Details
-
factory
This is the factory that is used to create DOM parsers.
-
-
Constructor Details
-
DocumentProvider
public DocumentProvider()Constructor for theDocumentProvider
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
This provides anEventReader
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
This provides anEventReader
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
This provides anEventReader
that will read from the specified source. When reading from a source the character encoding should be the same as the source XML document.- Parameters:
source
- this is the source to read the document with- Returns:
- this is used to return the event reader implementation
- Throws:
Exception
-