org.simpleframework.xml.stream

Class DocumentProvider

java.lang.Object

org.simpleframework.xml.stream.DocumentProvider

All Implemented Interfaces:

Provider

public class DocumentProvider
extends java.lang.Object
implements 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:

DocumentProvider

Constructor Summary

Constructors

Constructor and Description
DocumentProvider() Constructor for the DocumentProvider object.
DocumentProvider(javax.xml.parsers.DocumentBuilderFactory factory) Constructor for the DocumentProvider object using an externally configured 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.
static javax.xml.parsers.DocumentBuilderFactory	safeDocumentBuilderFactory()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentProvider

public DocumentProvider()

Constructor for the DocumentProvider object. This uses the default DocumentBuilderFactory.newInstance() and preconfigures the factory with "safe" defaults.

DocumentProvider

public DocumentProvider(javax.xml.parsers.DocumentBuilderFactory factory)

Constructor for the DocumentProvider object using an externally configured factory.

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

safeDocumentBuilderFactory

public static javax.xml.parsers.DocumentBuilderFactory safeDocumentBuilderFactory()

Returns:

Returns a "safe" DocumentBuilderFactory preconfigured to disable entity expansion and external DTD resolution.