org.apache.axiom.util.stax.xop
Class XOPEncodingStreamWriter
java.lang.Object
org.apache.axiom.util.stax.xop.XOPEncodingStreamWrapper
org.apache.axiom.util.stax.xop.XOPEncodingStreamWriter
- All Implemented Interfaces:
- XMLStreamWriter, DataHandlerWriter, MimePartProvider
public class XOPEncodingStreamWriter
- extends XOPEncodingStreamWrapper
- implements XMLStreamWriter, DataHandlerWriter
XMLStreamWriter
wrapper that encodes XOP. It implements the extension
defined by DataHandlerWriter
. The DataHandler
objects for the parts referenced by xop:Include element information items produced by
an instance of this class can be retrieved using the XOPEncodingStreamWrapper.getDataHandler(String)
method.
Method Summary |
void |
close()
|
void |
flush()
|
NamespaceContext |
getNamespaceContext()
|
String |
getPrefix(String uri)
|
Object |
getProperty(String name)
|
void |
setDefaultNamespace(String uri)
|
void |
setNamespaceContext(NamespaceContext context)
|
void |
setPrefix(String prefix,
String uri)
|
void |
writeAttribute(String localName,
String value)
|
void |
writeAttribute(String namespaceURI,
String localName,
String value)
|
void |
writeAttribute(String prefix,
String namespaceURI,
String localName,
String value)
|
void |
writeCData(String data)
|
void |
writeCharacters(char[] text,
int start,
int len)
|
void |
writeCharacters(String text)
|
void |
writeComment(String data)
|
void |
writeDataHandler(DataHandlerProvider dataHandlerProvider,
String contentID,
boolean optimize)
Write binary content to the stream. |
void |
writeDataHandler(DataHandler dataHandler,
String contentID,
boolean optimize)
Write binary content to the stream. |
void |
writeDefaultNamespace(String namespaceURI)
|
void |
writeDTD(String dtd)
|
void |
writeEmptyElement(String localName)
|
void |
writeEmptyElement(String namespaceURI,
String localName)
|
void |
writeEmptyElement(String prefix,
String localName,
String namespaceURI)
|
void |
writeEndDocument()
|
void |
writeEndElement()
|
void |
writeEntityRef(String name)
|
void |
writeNamespace(String prefix,
String namespaceURI)
|
void |
writeProcessingInstruction(String target)
|
void |
writeProcessingInstruction(String target,
String data)
|
void |
writeStartDocument()
|
void |
writeStartDocument(String version)
|
void |
writeStartDocument(String encoding,
String version)
|
void |
writeStartElement(String localName)
|
void |
writeStartElement(String namespaceURI,
String localName)
|
void |
writeStartElement(String prefix,
String localName,
String namespaceURI)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
XOPEncodingStreamWriter
public XOPEncodingStreamWriter(XMLStreamWriter parent,
ContentIDGenerator contentIDGenerator,
OptimizationPolicy optimizationPolicy)
- Constructor.
- Parameters:
parent
- the XML stream to write the encoded infoset tocontentIDGenerator
- used to generate content IDs for the binary content encoded as
xop:Include element information itemsoptimizationPolicy
- the policy to apply to decide which binary content to optimize
getProperty
public Object getProperty(String name)
throws IllegalArgumentException
- Specified by:
getProperty
in interface XMLStreamWriter
- Throws:
IllegalArgumentException
writeDataHandler
public void writeDataHandler(DataHandler dataHandler,
String contentID,
boolean optimize)
throws IOException,
XMLStreamException
- Description copied from interface:
DataHandlerWriter
- Write binary content to the stream. The implementation may choose to write the data as base64
encoded character data or using an optimization protocol such as XOP/MTOM.
- Specified by:
writeDataHandler
in interface DataHandlerWriter
- Parameters:
dataHandler
- the binary content to writecontentID
- an existing content ID for the binary data (see above)optimize
- indicates whether the content is eligible for optimization (see above)
- Throws:
IOException
- if an error occurs while reading from the data handler
XMLStreamException
- if an error occurs while writing to the underlying stream
writeDataHandler
public void writeDataHandler(DataHandlerProvider dataHandlerProvider,
String contentID,
boolean optimize)
throws IOException,
XMLStreamException
- Description copied from interface:
DataHandlerWriter
- Write binary content to the stream. This method allows the implementation to defer loading of
the content. More precisely, if the implementation decides to use an optimization scheme such
as XOP, then the content will not be written immediately to the underlying stream, but only
after the XML infoset is complete. If the caller uses this method, the implementation can
defer the actual loading of the binary content.
- Specified by:
writeDataHandler
in interface DataHandlerWriter
- Parameters:
dataHandlerProvider
- the binary content to writecontentID
- an existing content ID for the binary data (see above)optimize
- indicates whether the content is eligible for optimization (see above)
- Throws:
IOException
- If an error occurs while reading from the data handler. Since the implementation
is free to override the supplied optimize
argument, it may attempt
to load the binary data immediately. Because this operation may fail, the method
must declare this exception.
XMLStreamException
- if an error occurs while writing to the underlying stream
close
public void close()
throws XMLStreamException
- Specified by:
close
in interface XMLStreamWriter
- Throws:
XMLStreamException
flush
public void flush()
throws XMLStreamException
- Specified by:
flush
in interface XMLStreamWriter
- Throws:
XMLStreamException
getNamespaceContext
public NamespaceContext getNamespaceContext()
- Specified by:
getNamespaceContext
in interface XMLStreamWriter
getPrefix
public String getPrefix(String uri)
throws XMLStreamException
- Specified by:
getPrefix
in interface XMLStreamWriter
- Throws:
XMLStreamException
setDefaultNamespace
public void setDefaultNamespace(String uri)
throws XMLStreamException
- Specified by:
setDefaultNamespace
in interface XMLStreamWriter
- Throws:
XMLStreamException
setNamespaceContext
public void setNamespaceContext(NamespaceContext context)
throws XMLStreamException
- Specified by:
setNamespaceContext
in interface XMLStreamWriter
- Throws:
XMLStreamException
setPrefix
public void setPrefix(String prefix,
String uri)
throws XMLStreamException
- Specified by:
setPrefix
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeAttribute
public void writeAttribute(String prefix,
String namespaceURI,
String localName,
String value)
throws XMLStreamException
- Specified by:
writeAttribute
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeAttribute
public void writeAttribute(String namespaceURI,
String localName,
String value)
throws XMLStreamException
- Specified by:
writeAttribute
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeAttribute
public void writeAttribute(String localName,
String value)
throws XMLStreamException
- Specified by:
writeAttribute
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeCData
public void writeCData(String data)
throws XMLStreamException
- Specified by:
writeCData
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeCharacters
public void writeCharacters(char[] text,
int start,
int len)
throws XMLStreamException
- Specified by:
writeCharacters
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeCharacters
public void writeCharacters(String text)
throws XMLStreamException
- Specified by:
writeCharacters
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeComment
public void writeComment(String data)
throws XMLStreamException
- Specified by:
writeComment
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeDefaultNamespace
public void writeDefaultNamespace(String namespaceURI)
throws XMLStreamException
- Specified by:
writeDefaultNamespace
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeDTD
public void writeDTD(String dtd)
throws XMLStreamException
- Specified by:
writeDTD
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeEmptyElement
public void writeEmptyElement(String prefix,
String localName,
String namespaceURI)
throws XMLStreamException
- Specified by:
writeEmptyElement
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeEmptyElement
public void writeEmptyElement(String namespaceURI,
String localName)
throws XMLStreamException
- Specified by:
writeEmptyElement
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeEmptyElement
public void writeEmptyElement(String localName)
throws XMLStreamException
- Specified by:
writeEmptyElement
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeEndDocument
public void writeEndDocument()
throws XMLStreamException
- Specified by:
writeEndDocument
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeEndElement
public void writeEndElement()
throws XMLStreamException
- Specified by:
writeEndElement
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeEntityRef
public void writeEntityRef(String name)
throws XMLStreamException
- Specified by:
writeEntityRef
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeNamespace
public void writeNamespace(String prefix,
String namespaceURI)
throws XMLStreamException
- Specified by:
writeNamespace
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeProcessingInstruction
public void writeProcessingInstruction(String target,
String data)
throws XMLStreamException
- Specified by:
writeProcessingInstruction
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeProcessingInstruction
public void writeProcessingInstruction(String target)
throws XMLStreamException
- Specified by:
writeProcessingInstruction
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeStartDocument
public void writeStartDocument()
throws XMLStreamException
- Specified by:
writeStartDocument
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeStartDocument
public void writeStartDocument(String encoding,
String version)
throws XMLStreamException
- Specified by:
writeStartDocument
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeStartDocument
public void writeStartDocument(String version)
throws XMLStreamException
- Specified by:
writeStartDocument
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeStartElement
public void writeStartElement(String prefix,
String localName,
String namespaceURI)
throws XMLStreamException
- Specified by:
writeStartElement
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeStartElement
public void writeStartElement(String namespaceURI,
String localName)
throws XMLStreamException
- Specified by:
writeStartElement
in interface XMLStreamWriter
- Throws:
XMLStreamException
writeStartElement
public void writeStartElement(String localName)
throws XMLStreamException
- Specified by:
writeStartElement
in interface XMLStreamWriter
- Throws:
XMLStreamException
Copyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.