org.apache.axiom.om.impl
Class MTOMXMLStreamWriter

java.lang.Object
  extended by org.apache.axiom.om.impl.MTOMXMLStreamWriter
All Implemented Interfaces:
javax.xml.stream.XMLStreamWriter

public class MTOMXMLStreamWriter
extends java.lang.Object
implements javax.xml.stream.XMLStreamWriter

MTOMXMLStreamWriter is an XML + Attachments stream writer. For the moment this assumes that transport takes the decision of whether to optimize or not by looking at whether the MTOM optimize is enabled & also looking at the OM tree whether it has any optimizable content.


Constructor Summary
MTOMXMLStreamWriter(java.io.OutputStream outStream, OMOutputFormat format)
          Creates a new MTOMXMLStreamWriter with specified encoding.
MTOMXMLStreamWriter(javax.xml.stream.XMLStreamWriter xmlWriter)
           
 
Method Summary
 void close()
           
 void flush()
          Flush is overridden to trigger the attachment serialization
 java.lang.String getCharSetEncoding()
          Returns the character set encoding scheme.
 java.lang.String getContentType()
           
 java.lang.String getMimeBoundary()
           
 javax.xml.namespace.NamespaceContext getNamespaceContext()
           
 java.lang.String getNextContentId()
           
 OMOutputFormat getOutputFormat()
          Get the output format used by this writer.
 java.io.OutputStream getOutputStream()
          If this XMLStreamWriter is connected to an OutputStream then the OutputStream is returned.
 java.lang.String getPrefix(java.lang.String string)
           
 java.lang.Object getProperty(java.lang.String string)
           
 java.lang.String getRootContentId()
           
 javax.xml.stream.XMLStreamWriter getXmlStreamWriter()
           
 java.lang.String getXmlVersion()
           
 boolean isIgnoreXMLDeclaration()
           
 boolean isOptimized()
           
 boolean isOptimizedThreshold(OMText node)
           
 void setCharSetEncoding(java.lang.String charSetEncoding)
           
 void setDefaultNamespace(java.lang.String string)
           
 void setDoOptimize(boolean b)
           
 void setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration)
           
 void setNamespaceContext(javax.xml.namespace.NamespaceContext namespaceContext)
           
 void setOutputFormat(OMOutputFormat format)
           
 void setPrefix(java.lang.String string, java.lang.String string1)
           
 void setSoap11(boolean b)
           
 void setXmlStreamWriter(javax.xml.stream.XMLStreamWriter xmlWriter)
           
 void setXmlVersion(java.lang.String xmlVersion)
           
 void writeAttribute(java.lang.String string, java.lang.String string1)
           
 void writeAttribute(java.lang.String string, java.lang.String string1, java.lang.String string2)
           
 void writeAttribute(java.lang.String string, java.lang.String string1, java.lang.String string2, java.lang.String string3)
           
 void writeCData(java.lang.String string)
           
 void writeCharacters(char[] chars, int i, int i1)
           
 void writeCharacters(java.lang.String string)
           
 void writeComment(java.lang.String string)
           
 void writeDefaultNamespace(java.lang.String string)
           
 void writeDTD(java.lang.String string)
           
 void writeEmptyElement(java.lang.String string)
           
 void writeEmptyElement(java.lang.String string, java.lang.String string1)
           
 void writeEmptyElement(java.lang.String string, java.lang.String string1, java.lang.String string2)
           
 void writeEndDocument()
           
 void writeEndElement()
           
 void writeEntityRef(java.lang.String string)
           
 void writeNamespace(java.lang.String string, java.lang.String string1)
           
 void writeOptimized(OMText node)
           
 void writeProcessingInstruction(java.lang.String string)
           
 void writeProcessingInstruction(java.lang.String string, java.lang.String string1)
           
 void writeStartDocument()
           
 void writeStartDocument(java.lang.String string)
           
 void writeStartDocument(java.lang.String string, java.lang.String string1)
           
 void writeStartElement(java.lang.String string)
           
 void writeStartElement(java.lang.String string, java.lang.String string1)
           
 void writeStartElement(java.lang.String string, java.lang.String string1, java.lang.String string2)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MTOMXMLStreamWriter

public MTOMXMLStreamWriter(javax.xml.stream.XMLStreamWriter xmlWriter)

MTOMXMLStreamWriter

public MTOMXMLStreamWriter(java.io.OutputStream outStream,
                           OMOutputFormat format)
                    throws javax.xml.stream.XMLStreamException,
                           javax.xml.stream.FactoryConfigurationError
Creates a new MTOMXMLStreamWriter with specified encoding.

Parameters:
outStream -
format -
Throws:
javax.xml.stream.XMLStreamException
javax.xml.stream.FactoryConfigurationError
See Also:
OMOutputFormat.DEFAULT_CHAR_SET_ENCODING
Method Detail

writeStartElement

public void writeStartElement(java.lang.String string)
                       throws javax.xml.stream.XMLStreamException
Specified by:
writeStartElement in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String string,
                              java.lang.String string1)
                       throws javax.xml.stream.XMLStreamException
Specified by:
writeStartElement in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String string,
                              java.lang.String string1,
                              java.lang.String string2)
                       throws javax.xml.stream.XMLStreamException
Specified by:
writeStartElement in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String string,
                              java.lang.String string1)
                       throws javax.xml.stream.XMLStreamException
Specified by:
writeEmptyElement in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String string,
                              java.lang.String string1,
                              java.lang.String string2)
                       throws javax.xml.stream.XMLStreamException
Specified by:
writeEmptyElement in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String string)
                       throws javax.xml.stream.XMLStreamException
Specified by:
writeEmptyElement in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeEndElement

public void writeEndElement()
                     throws javax.xml.stream.XMLStreamException
Specified by:
writeEndElement in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws javax.xml.stream.XMLStreamException
Specified by:
writeEndDocument in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

close

public void close()
           throws javax.xml.stream.XMLStreamException
Specified by:
close in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

flush

public void flush()
           throws javax.xml.stream.XMLStreamException
Flush is overridden to trigger the attachment serialization

Specified by:
flush in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeAttribute

public void writeAttribute(java.lang.String string,
                           java.lang.String string1)
                    throws javax.xml.stream.XMLStreamException
Specified by:
writeAttribute in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeAttribute

public void writeAttribute(java.lang.String string,
                           java.lang.String string1,
                           java.lang.String string2,
                           java.lang.String string3)
                    throws javax.xml.stream.XMLStreamException
Specified by:
writeAttribute in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeAttribute

public void writeAttribute(java.lang.String string,
                           java.lang.String string1,
                           java.lang.String string2)
                    throws javax.xml.stream.XMLStreamException
Specified by:
writeAttribute in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeNamespace

public void writeNamespace(java.lang.String string,
                           java.lang.String string1)
                    throws javax.xml.stream.XMLStreamException
Specified by:
writeNamespace in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(java.lang.String string)
                           throws javax.xml.stream.XMLStreamException
Specified by:
writeDefaultNamespace in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeComment

public void writeComment(java.lang.String string)
                  throws javax.xml.stream.XMLStreamException
Specified by:
writeComment in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String string)
                                throws javax.xml.stream.XMLStreamException
Specified by:
writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String string,
                                       java.lang.String string1)
                                throws javax.xml.stream.XMLStreamException
Specified by:
writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeCData

public void writeCData(java.lang.String string)
                throws javax.xml.stream.XMLStreamException
Specified by:
writeCData in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeDTD

public void writeDTD(java.lang.String string)
              throws javax.xml.stream.XMLStreamException
Specified by:
writeDTD in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeEntityRef

public void writeEntityRef(java.lang.String string)
                    throws javax.xml.stream.XMLStreamException
Specified by:
writeEntityRef in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument()
                        throws javax.xml.stream.XMLStreamException
Specified by:
writeStartDocument in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument(java.lang.String string)
                        throws javax.xml.stream.XMLStreamException
Specified by:
writeStartDocument in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument(java.lang.String string,
                               java.lang.String string1)
                        throws javax.xml.stream.XMLStreamException
Specified by:
writeStartDocument in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeCharacters

public void writeCharacters(java.lang.String string)
                     throws javax.xml.stream.XMLStreamException
Specified by:
writeCharacters in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

writeCharacters

public void writeCharacters(char[] chars,
                            int i,
                            int i1)
                     throws javax.xml.stream.XMLStreamException
Specified by:
writeCharacters in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

getPrefix

public java.lang.String getPrefix(java.lang.String string)
                           throws javax.xml.stream.XMLStreamException
Specified by:
getPrefix in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

setPrefix

public void setPrefix(java.lang.String string,
                      java.lang.String string1)
               throws javax.xml.stream.XMLStreamException
Specified by:
setPrefix in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

setDefaultNamespace

public void setDefaultNamespace(java.lang.String string)
                         throws javax.xml.stream.XMLStreamException
Specified by:
setDefaultNamespace in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

setNamespaceContext

public void setNamespaceContext(javax.xml.namespace.NamespaceContext namespaceContext)
                         throws javax.xml.stream.XMLStreamException
Specified by:
setNamespaceContext in interface javax.xml.stream.XMLStreamWriter
Throws:
javax.xml.stream.XMLStreamException

getNamespaceContext

public javax.xml.namespace.NamespaceContext getNamespaceContext()
Specified by:
getNamespaceContext in interface javax.xml.stream.XMLStreamWriter

getProperty

public java.lang.Object getProperty(java.lang.String string)
                             throws java.lang.IllegalArgumentException
Specified by:
getProperty in interface javax.xml.stream.XMLStreamWriter
Throws:
java.lang.IllegalArgumentException

isOptimized

public boolean isOptimized()

getContentType

public java.lang.String getContentType()

writeOptimized

public void writeOptimized(OMText node)

isOptimizedThreshold

public boolean isOptimizedThreshold(OMText node)

setXmlStreamWriter

public void setXmlStreamWriter(javax.xml.stream.XMLStreamWriter xmlWriter)

getXmlStreamWriter

public javax.xml.stream.XMLStreamWriter getXmlStreamWriter()

getMimeBoundary

public java.lang.String getMimeBoundary()

getRootContentId

public java.lang.String getRootContentId()

getNextContentId

public java.lang.String getNextContentId()

getCharSetEncoding

public java.lang.String getCharSetEncoding()
Returns the character set encoding scheme. If the value of the charSetEncoding is not set then the default will be returned.

Returns:
Returns encoding.

setCharSetEncoding

public void setCharSetEncoding(java.lang.String charSetEncoding)

getXmlVersion

public java.lang.String getXmlVersion()

setXmlVersion

public void setXmlVersion(java.lang.String xmlVersion)

setSoap11

public void setSoap11(boolean b)

isIgnoreXMLDeclaration

public boolean isIgnoreXMLDeclaration()

setIgnoreXMLDeclaration

public void setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration)

setDoOptimize

public void setDoOptimize(boolean b)

getOutputFormat

public OMOutputFormat getOutputFormat()
Get the output format used by this writer.

The caller should use the returned instance in a read-only way, i.e. he should not modify the settings of the output format. Any attempt to do so will lead to unpredictable results.

Returns:
the output format used by this writer

setOutputFormat

public void setOutputFormat(OMOutputFormat format)

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws javax.xml.stream.XMLStreamException
If this XMLStreamWriter is connected to an OutputStream then the OutputStream is returned. This allows a node (perhaps an OMSourcedElement) to write its content directly to the OutputStream.

Returns:
OutputStream or null
Throws:
javax.xml.stream.XMLStreamException


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.