Package com.saxonica.xqj.pull

## Class DocumentWrappingPullProvider

- java.lang.Object
- - net.sf.saxon.pull.PullFilter
  - - com.saxonica.xqj.pull.DocumentWrappingPullProvider

- All Implemented Interfaces:
    `PullProvider`

      public class DocumentWrappingPullProvider
      extends PullFilter

  Returns the events provided by an underlying PullProvider, with the addition of a START_DOCUMENT event immediately after the START_OF_INPUT, and an END_DOCUMENT event immediately before the END_OF_INPUT

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface net.sf.saxon.pull.PullProvider

      `PullProvider.Event`

  - ### Field Summary

    - ### Fields inherited from class net.sf.saxon.pull.PullFilter

      `currentEvent`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `DocumentWrappingPullProvider​(PullProvider base)` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `PullProvider.Event` | `next()` | Get the next event.

    - ### Methods inherited from class net.sf.saxon.pull.PullFilter

      `close, current, getAtomicValue, getAttributes, getNamePool, getNamespaceDeclarations, getNodeName, getPipelineConfiguration, getSchemaType, getSourceLocator, getStringValue, getUnderlyingProvider, getUnparsedEntities, setPipelineConfiguration, skipToMatchingEnd`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### DocumentWrappingPullProvider

          public DocumentWrappingPullProvider​(PullProvider base)

  - ### Method Detail

    - #### next

          public PullProvider.Event next()
                                  throws XPathException

      Description copied from class: `PullFilter`
      Get the next event.

      Note that a subclass that overrides this method is responsible for ensuring that current() works properly. This can be achieved by setting the field currentEvent to the event returned by any call on next().

      Specified by:
        `next` in interface `PullProvider`
      Overrides:
        `next` in class `PullFilter`
      Returns:
        an integer code indicating the type of event. The code `PullProvider.Event.END_OF_INPUT` is returned at the end of the sequence.
      Throws:
        `XPathException` - if a dynamic error occurs