Package net.sf.saxon.stax

## Class ReceiverToXMLStreamWriter

- java.lang.Object
- - net.sf.saxon.stax.ReceiverToXMLStreamWriter

- All Implemented Interfaces:
    `javax.xml.transform.Result`, `Receiver`

      public class ReceiverToXMLStreamWriter
      extends java.lang.Object
      implements Receiver

  ReceiverToXMLStreamWriter is a Receiver writes XML by using the XMLStreamWriter

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected java.lang.String` | `baseURI` |
    `protected Configuration` | `config` |
    `protected PipelineConfiguration` | `pipe` |
    `protected java.lang.String` | `systemId` |

    - ### Fields inherited from interface javax.xml.transform.Result

      `PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `ReceiverToXMLStreamWriter​(javax.xml.stream.XMLStreamWriter writer)` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | `characters​(java.lang.CharSequence chars, Location locationId, int properties)` | Notify character data.
    `void` | `close()` | Notify the end of the event stream
    `void` | `comment​(java.lang.CharSequence content, Location locationId, int properties)` | Notify a comment.
    `void` | `endDocument()` | Notify the end of a document node
    `void` | `endElement()` | Notify the end of an element.
    `PipelineConfiguration` | `getPipelineConfiguration()` | Get the pipeline configuration
    `java.lang.String` | `getSystemId()` |
    `javax.xml.stream.XMLStreamWriter` | `getXMLStreamWriter()` | Get the XMLStreamWriter to which this Receiver is writing events
    `void` | `open()` | Notify the start of the event stream
    `void` | `processingInstruction​(java.lang.String name, java.lang.CharSequence data, Location locationId, int properties)` | Output a processing instruction
    `void` | `setPipelineConfiguration​(PipelineConfiguration pipe)` | Set the pipeline configuration
    `void` | `setSystemId​(java.lang.String systemId)` | Set the System ID of the tree represented by this event stream
    `void` | `setUnparsedEntity​(java.lang.String name, java.lang.String systemID, java.lang.String publicID)` | Notify an unparsed entity URI.
    `void` | `startDocument​(int properties)` | Notify the start of a document node
    `void` | `startElement​(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)` | Notify the start of an element
    `boolean` | `usesTypeAnnotations()` | Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events.

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

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

    - ### Methods inherited from interface net.sf.saxon.event.Receiver

      `append, append, handlesAppend`

- - ### Field Detail

    - #### pipe

          protected PipelineConfiguration pipe

    - #### config

          protected Configuration config

    - #### systemId

          protected java.lang.String systemId

    - #### baseURI

          protected java.lang.String baseURI

  - ### Constructor Detail

    - #### ReceiverToXMLStreamWriter

          public ReceiverToXMLStreamWriter​(javax.xml.stream.XMLStreamWriter writer)

  - ### Method Detail

    - #### getXMLStreamWriter

          public javax.xml.stream.XMLStreamWriter getXMLStreamWriter()

      Get the XMLStreamWriter to which this Receiver is writing events
      Returns:
        the destination of this ReceiverToXMLStreamWriter

    - #### setPipelineConfiguration

          public void setPipelineConfiguration​(PipelineConfiguration pipe)

      Description copied from interface: `Receiver`
      Set the pipeline configuration
      Specified by:
        `setPipelineConfiguration` in interface `Receiver`
      Parameters:
        `pipe` - the pipeline configuration

    - #### getPipelineConfiguration

          public PipelineConfiguration getPipelineConfiguration()

      Description copied from interface: `Receiver`
      Get the pipeline configuration
      Specified by:
        `getPipelineConfiguration` in interface `Receiver`
      Returns:
        the pipeline configuration

    - #### setSystemId

          public void setSystemId​(java.lang.String systemId)

      Description copied from interface: `Receiver`
      Set the System ID of the tree represented by this event stream
      Specified by:
        `setSystemId` in interface `Receiver`
      Specified by:
        `setSystemId` in interface `javax.xml.transform.Result`
      Parameters:
        `systemId` - the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)

    - #### getSystemId

          public java.lang.String getSystemId()

      Specified by:
        `getSystemId` in interface `javax.xml.transform.Result`

    - #### open

          public void open()
                    throws XPathException

      Description copied from interface: `Receiver`
      Notify the start of the event stream
      Specified by:
        `open` in interface `Receiver`
      Throws:
        `XPathException` - if an error occurs

    - #### startDocument

          public void startDocument​(int properties)
                             throws XPathException

      Description copied from interface: `Receiver`
      Notify the start of a document node
      Specified by:
        `startDocument` in interface `Receiver`
      Parameters:
        `properties` - bit-significant integer indicating properties of the document node. The definitions of the bits are in class `ReceiverOption`
      Throws:
        `XPathException` - if an error occurs

    - #### endDocument

          public void endDocument()
                           throws XPathException

      Description copied from interface: `Receiver`
      Notify the end of a document node
      Specified by:
        `endDocument` in interface `Receiver`
      Throws:
        `XPathException` - if an error occurs

    - #### setUnparsedEntity

          public void setUnparsedEntity​(java.lang.String name,
                                        java.lang.String systemID,
                                        java.lang.String publicID)
                                 throws XPathException

      Description copied from interface: `Receiver`
      Notify an unparsed entity URI.
      Specified by:
        `setUnparsedEntity` in interface `Receiver`
      Parameters:
        `name` - The name of the unparsed entity
        `systemID` - The system identifier of the unparsed entity
        `publicID` - The identifier of the unparsed entity
      Throws:
        `XPathException` - if an error occurs

    - #### startElement

          public void startElement​(NodeName elemName,
                                   SchemaType type,
                                   AttributeMap attributes,
                                   NamespaceMap namespaces,
                                   Location location,
                                   int properties)
                            throws XPathException

      Description copied from interface: `Receiver`
      Notify the start of an element
      Specified by:
        `startElement` in interface `Receiver`
      Parameters:
        `elemName` - the name of the element.
        `type` - the type annotation of the element.
        `attributes` - the attributes of this element
        `namespaces` - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
        `location` - an object providing information about the module, line, and column where the node originated
        `properties` - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class `ReceiverOption`
      Throws:
        `XPathException` - if an error occurs

    - #### endElement

          public void endElement()
                          throws XPathException

      Description copied from interface: `Receiver`
      Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.
      Specified by:
        `endElement` in interface `Receiver`
      Throws:
        `XPathException` - if an error occurs

    - #### characters

          public void characters​(java.lang.CharSequence chars,
                                 Location locationId,
                                 int properties)
                          throws XPathException

      Description copied from interface: `Receiver`
      Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.
      Specified by:
        `characters` in interface `Receiver`
      Parameters:
        `chars` - The characters
        `locationId` - provides information such as line number and system ID.
        `properties` - Bit significant value. The following bits are defined:
        DISABLE_ESCAPING
          Disable escaping for this text node
        USE_CDATA
          Output as a CDATA section
      Throws:
        `XPathException` - if an error occurs

    - #### processingInstruction

          public void processingInstruction​(java.lang.String name,
                                            java.lang.CharSequence data,
                                            Location locationId,
                                            int properties)
                                     throws XPathException

      Description copied from interface: `Receiver`
      Output a processing instruction
      Specified by:
        `processingInstruction` in interface `Receiver`
      Parameters:
        `name` - The PI name. This must be a legal name (it will not be checked).
        `data` - The data portion of the processing instruction
        `locationId` - provides information such as line number and system ID.
        `properties` - Additional information about the PI.
      Throws:
        `XPathException` - if an error occurs

    - #### comment

          public void comment​(java.lang.CharSequence content,
                              Location locationId,
                              int properties)
                       throws XPathException

      Description copied from interface: `Receiver`
      Notify a comment. Comments are only notified if they are outside the DTD.
      Specified by:
        `comment` in interface `Receiver`
      Parameters:
        `content` - The content of the comment
        `locationId` - provides information such as line number and system ID.
        `properties` - Additional information about the comment.
      Throws:
        `XPathException` - if an error occurs

    - #### close

          public void close()
                     throws XPathException

      Description copied from interface: `Receiver`
      Notify the end of the event stream
      Specified by:
        `close` in interface `Receiver`
      Throws:
        `XPathException` - if an error occurs

    - #### usesTypeAnnotations

          public boolean usesTypeAnnotations()

      Description copied from interface: `Receiver`
      Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events. The default implementation of this method returns false.
      Specified by:
        `usesTypeAnnotations` in interface `Receiver`
      Returns:
        true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation (or conversely, it may avoid stripping unwanted type annotations)