Constructor Detail

• Serializer

  public Serializer(org.apache.axiom.om.OMSerializable root,
            boolean namespaceRepairing,
            boolean preserveNamespaceContext)

  Constructor.

  Parameters:

  root - the root node of the object model subtree that is being serialized; this information is used by the serializer in scenarios that require access to the namespace context of the parent of the root node

  namespaceRepairing - indicates if the serializer should perform namespace repairing

  preserveNamespaceContext - indicates if the namespace context determined by the ancestors of the root node should be strictly preserved in the output

Method Detail

• serializeStartpart

  public final void serializeStartpart(org.apache.axiom.om.OMElement element)
                                throws OutputException

  Throws:

  OutputException

• copyEvent

  public final void copyEvent(javax.xml.stream.XMLStreamReader reader,
               org.apache.axiom.ext.stax.datahandler.DataHandlerReader dataHandlerReader)
                       throws OutputException

  Throws:

  OutputException

• serialize

  public final void serialize(org.apache.axiom.om.OMDataSource dataSource)
                       throws OutputException

  Serialize the given data source.

  Parameters:

  dataSource - the data source to serialize

  Throws:

  OutputException - if an error occurs while writing the data

  org.apache.axiom.om.DeferredParsingException - if an error occurs while reading from the data source

• isAssociated

  protected abstract boolean isAssociated(String prefix,
                     String namespace)
                                   throws OutputException

  Throws:

  OutputException

• writeStartDocument

  public abstract void writeStartDocument(String version)
                                   throws OutputException

  Throws:

  OutputException

• writeStartDocument

  public abstract void writeStartDocument(String encoding,
                        String version)
                                   throws OutputException

  Throws:

  OutputException

• writeDTD

  public abstract void writeDTD(String rootName,
              String publicId,
              String systemId,
              String internalSubset)
                         throws OutputException

  Throws:

  OutputException

• beginStartElement

  protected abstract void beginStartElement(String prefix,
                       String namespaceURI,
                       String localName)
                                     throws OutputException

  Prepare to write an element start tag. A call to this method will be followed by zero or more calls to addNamespace(String, String) and addAttribute(String, String, String, String, String) and a single call to finishStartElement().

  Parameters:

  prefix - the prefix of the element; never null

  namespaceURI - the namespace URI of the element; never null

  localName - the local name of the element; never null

  Throws:

  OutputException

• addNamespace

  protected abstract void addNamespace(String prefix,
                  String namespaceURI)
                                throws OutputException

  Add the given namespace to the element. The implementation of this method must take the appropriate actions such that the following two conditions are satisfied:

  • A namespace declaration is written to the output.
  • The namespace binding defined by the parameters is visible in the namespace context of the XMLStreamWriter that serializePushOMDataSource(OMDataSource) passes to OMDataSource.serialize(XMLStreamWriter) if an OMDataSource is serialized in the scope of the current element (and of course unless the namespace binding is hidden by a namespace defined on a nested element).

  Parameters:

  prefix - the namespace prefix; never null

  namespaceURI - the namespace URI; never null

  Throws:

  OutputException

• addAttribute

  protected abstract void addAttribute(String prefix,
                  String namespaceURI,
                  String localName,
                  String type,
                  String value)
                                throws OutputException

  Add the given attribute to the element.

  Parameters:

  prefix - the namespace prefix of the attribute; never null

  namespaceURI - the namespace URI or the attribute; never null

  localName - the local name of the attribute; never null

  type - the attribute type (e.g. CDATA); never null

  value - the value of the attribute; never null

  Throws:

  OutputException

• finishStartElement

  protected abstract void finishStartElement()
                                      throws OutputException

  Throws:

  OutputException

• writeEndElement

  public abstract void writeEndElement()
                                throws OutputException

  Throws:

  OutputException

• writeText

  public abstract void writeText(int type,
               String data)
                          throws OutputException

  Throws:

  OutputException

• writeComment

  public abstract void writeComment(String data)
                             throws OutputException

  Throws:

  OutputException

• writeProcessingInstruction

  public abstract void writeProcessingInstruction(String target,
                                String data)
                                           throws OutputException

  Throws:

  OutputException

• writeEntityRef

  public abstract void writeEntityRef(String name)
                               throws OutputException

  Throws:

  OutputException

• writeDataHandler

  public abstract void writeDataHandler(javax.activation.DataHandler dataHandler,
                      String contentID,
                      boolean optimize)
                                 throws OutputException

  Throws:

  OutputException

• writeDataHandler

  public abstract void writeDataHandler(org.apache.axiom.ext.stax.datahandler.DataHandlerProvider dataHandlerProvider,
                      String contentID,
                      boolean optimize)
                                 throws OutputException

  Throws:

  OutputException

• serializePushOMDataSource

  protected abstract void serializePushOMDataSource(org.apache.axiom.om.OMDataSource dataSource)
                                             throws OutputException

  Serialize the given data source using OMDataSource.serialize(XMLStreamWriter). The implementation must construct an appropriate XMLStreamWriter instance to pass to that method and wrap any XMLStreamException that may be thrown in an OutputException or DeferredParsingException.

  Parameters:

  dataSource - the data source to serialize

  Throws:

  OutputException - if an error occurs while writing the data

  org.apache.axiom.om.DeferredParsingException - if an error occurs while reading from the data source

• writeEndDocument

  public abstract void writeEndDocument()
                                 throws OutputException

  Throws:

  OutputException