org.apache.axiom.util.stax.xop

## Class XOPEncodedStream

- java.lang.Object
- - org.apache.axiom.util.stax.xop.XOPEncodedStream

-     public class XOPEncodedStream
      extends Object

  Represents an XOP encoded stream. Since an XOP message is a MIME package with a root part in XML and a set of additional (binary) parts referenced from the main part, this class encapsulates an `XMLStreamReader` representing the main part and a `MimePartProvider` giving access to the attachments. Instances of this class can be obtained from `XOPUtils.getXOPEncodedStream(XMLStreamReader)`.

- - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `MimePartProvider` | `getMimePartProvider()` Get the provider object for the additional MIME parts referenced by the main part.
    `javax.xml.stream.XMLStreamReader` | `getReader()` Get the stream reader for the main part of the XOP message.

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

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

- - ### Method Detail

    - #### getReader

          public javax.xml.stream.XMLStreamReader getReader()

      Get the stream reader for the main part of the XOP message.
      Returns:
        the stream reader for the main part

    - #### getMimePartProvider

          public MimePartProvider getMimePartProvider()

      Get the provider object for the additional MIME parts referenced by the main part.
      Returns:
        the MIME part provider

Copyright © The Apache Software Foundation. All Rights Reserved.