org.apache.axiom.om

## Interface OMSerializable

- All Superinterfaces:
    OMInformationItem
  All Known Subinterfaces:
    OMComment, OMContainer, OMContainerEx, OMDocType, OMDocument, OMElement, OMElementEx, OMEntityReference, OMNode, OMNodeEx, OMProcessingInstruction, OMSourcedElement, OMText, SOAPBody, SOAPEnvelope, SOAPFault, SOAPFaultClassifier, SOAPFaultCode, SOAPFaultDetail, SOAPFaultNode, SOAPFaultReason, SOAPFaultRole, SOAPFaultSubCode, SOAPFaultText, SOAPFaultValue, SOAPHeader, SOAPHeaderBlock, SOAPMessage

      public interface OMSerializable
      extends OMInformationItem

  Information item that can be serialized (written to an XML stream writer) and deserialized (retrieved from an XML parser) as a unit. This is the common super-interface for `OMDocument` and `OMNode`. Note that `OMAttribute` and `OMNamespace` are information items that don't match the definition of this interface because they can only be read from the parser as part of a larger unit, namely an element.

  In accordance with the definition given above, this interface declares two sets of methods:

  - Methods allowing to control whether the information item has been completely built, i.e. whether all events corresponding to the information item have been retrieved from the parser.
  - Methods to write the StAX events corresponding to the information item to an `XMLStreamWriter`.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `build()` Builds itself.
    `void` | `close(boolean build)` If a builder and parser is associated with the node, it is closed.
    `boolean` | `isComplete()` Indicates whether parser has parsed this information item completely or not.
    `void` | `serialize(javax.xml.stream.XMLStreamWriter xmlWriter)` Serializes the information item with caching.
    `void` | `serialize(javax.xml.stream.XMLStreamWriter xmlWriter, boolean cache)` Serializes the information item to the given `XMLStreamWriter`.
    `void` | `serializeAndConsume(javax.xml.stream.XMLStreamWriter xmlWriter)` Serializes the information item without caching.

    - ### Methods inherited from interface org.apache.axiom.om.OMInformationItem

      `clone, getOMFactory`

- - ### Method Detail

    - #### isComplete

          boolean isComplete()

      Indicates whether parser has parsed this information item completely or not. If some info are not available in the item, one has to check this attribute to make sure that, this item has been parsed completely or not.
      Returns:
        Returns boolean.

    - #### build

          void build()

      Builds itself.

    - #### close

          void close(boolean build)

      If a builder and parser is associated with the node, it is closed.
      Parameters:
        `build` - if true, the object is built first before closing the builder/parser

    - #### serialize

          void serialize(javax.xml.stream.XMLStreamWriter xmlWriter)
                  throws javax.xml.stream.XMLStreamException

      Serializes the information item with caching. This method has the same effect as `serialize(XMLStreamWriter, boolean)` with `cache` set to `true`.
      Parameters:
        `xmlWriter` -
      Throws:
        `javax.xml.stream.XMLStreamException`

    - #### serializeAndConsume

          void serializeAndConsume(javax.xml.stream.XMLStreamWriter xmlWriter)
                            throws javax.xml.stream.XMLStreamException

      Serializes the information item without caching. This method has the same effect as `serialize(XMLStreamWriter, boolean)` with `cache` set to `false`.
      Parameters:
        `xmlWriter` -
      Throws:
        `javax.xml.stream.XMLStreamException`

    - #### serialize

          void serialize(javax.xml.stream.XMLStreamWriter xmlWriter,
                         boolean cache)
                  throws javax.xml.stream.XMLStreamException

      Serializes the information item to the given `XMLStreamWriter`.

      The implementation of this method must satisfy the following requirements:

      - If the writer exposes the `DataHandlerWriter` extension, then base64 binary data MUST be written using one of the methods defined by that extension. This will occur if the information item is an `OMText` node for which `OMText.isBinary()` returns `true` or if it is an `OMContainer` that has such an `OMText` node as descendant. If the writer doesn't expose the `DataHandlerWriter` extension, then the implementation MUST use `XMLStreamWriter.writeCharacters(String)` or `XMLStreamWriter.writeCharacters(char[], int, int)` to write the base64 encoded data to the stream.
      - The implementation MUST ensure that the produced XML is well formed with respect to namespaces, i.e. it MUST generate the required namespace declarations using `XMLStreamWriter.writeNamespace(String, String)` and `XMLStreamWriter.writeDefaultNamespace(String)`. This requirement is always applicable, even if the method is used to serialize a subtree or if the object model is not well formed with respect to namespaces. This means that the implementation is expected to implement namespace repairing and that the implementation MUST NOT assume that the `XMLStreamWriter` supplied by the caller performs any kind of namespace repairing.
      - The implementation MUST take into account the pre-existing namespace context, so that the caller can use this method to serialize the information item as part of a larger document. The implementation uses `XMLStreamWriter.getPrefix(String)` and/or `XMLStreamWriter.getNamespaceContext()` to query the pre-existing namespace context.

      On the other hand, the caller of this method must ensure that the following requirements are satisfied:

      - The namespace context information provided by `XMLStreamWriter.getPrefix(String)` and `XMLStreamWriter.getNamespaceContext()` MUST accurately reflect the actual namespace context at the location in the output document where the information item is serialized. In practice this requirement means that if the caller writes content to the `XMLStreamWriter` before calling this method, then it must use `XMLStreamWriter.setPrefix(String, String)` and `XMLStreamWriter.setDefaultNamespace(String)` to update the namespace context. Note that this requirement may be relaxed if the caller implements some form of namespace repairing.
      Parameters:
        `xmlWriter` -
        `cache` - indicates if caching should be enabled
      Throws:
        `javax.xml.stream.XMLStreamException`

Copyright © The Apache Software Foundation. All Rights Reserved.