Class StreamProvider

java.lang.Object
org.simpleframework.xml.stream.StreamProvider
All Implemented Interfaces:
Provider
class StreamProvider extends 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:

  • Field Details

    • factory

      private final XMLInputFactory factory
      This is the factory that is used to create StAX parsers.

  • Constructor Details

    • StreamProvider

      public StreamProvider()
      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 EventReader provide(InputStream source) throws 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:
      Exception

    • provide

      public EventReader provide(Reader source) throws 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:
      Exception

    • provide

      private EventReader provide(XMLEventReader source) throws Exception
      This provides an EventReader that will read from the specified reader. The returned event reader is basically a wrapper for the provided StAX implementation.
      Parameters:
      source - this is the reader to read the document with
      Returns:
      this is used to return the event reader implementation
      Throws:
      Exception