Interface StreamingPayload


public interface StreamingPayload
Defines the contract for payloads that can be written directly to a XMLStreamWriter.
Since:
2.0
Author:
Arjen Poutsma
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the qualified name of the payload.
    void
    writeTo(XMLStreamWriter streamWriter)
    Writes this payload to the given XMLStreamWriter.
  • Method Details

    • getName

      QName getName()
      Returns the qualified name of the payload. Only the namespace URI and local part of the returned qualified name are significant; they must match the name of the root element produced by writeTo(XMLStreamWriter).
      Returns:
      the qualified name
    • writeTo

      void writeTo(XMLStreamWriter streamWriter) throws XMLStreamException
      Writes this payload to the given XMLStreamWriter.
      Parameters:
      streamWriter - the stream writer to write to
      Throws:
      XMLStreamException - in case of errors