Package 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
,org.apache.axiom.ext.stax.datahandler.DataHandlerWriter
,MimePartProvider
public class XOPEncodingStreamWriter extends XOPEncodingStreamWrapper implements XMLStreamWriter, org.apache.axiom.ext.stax.datahandler.DataHandlerWriter
XMLStreamWriter
wrapper that encodes XOP. It implements the extension defined byDataHandlerWriter
. TheDataHandler
objects for the parts referenced byxop:Include
element information items produced by an instance of this class can be retrieved using theXOPEncodingStreamWrapper.getDataHandler(String)
method.
-
-
Constructor Summary
Constructors Constructor Description XOPEncodingStreamWriter(XMLStreamWriter parent, ContentIDGenerator contentIDGenerator, OptimizationPolicy optimizationPolicy)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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(DataHandler dataHandler, String contentID, boolean optimize)
void
writeDataHandler(org.apache.axiom.ext.stax.datahandler.DataHandlerProvider dataHandlerProvider, String contentID, boolean optimize)
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 org.apache.axiom.util.stax.xop.XOPEncodingStreamWrapper
getContentIDs, getDataHandler, processDataHandler, processDataHandler
-
-
-
-
Constructor Detail
-
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 asxop:Include
element information itemsoptimizationPolicy
- the policy to apply to decide which binary content to optimize
-
-
Method Detail
-
getProperty
public Object getProperty(String name) throws IllegalArgumentException
- Specified by:
getProperty
in interfaceXMLStreamWriter
- Throws:
IllegalArgumentException
-
writeDataHandler
public void writeDataHandler(DataHandler dataHandler, String contentID, boolean optimize) throws IOException, XMLStreamException
- Specified by:
writeDataHandler
in interfaceorg.apache.axiom.ext.stax.datahandler.DataHandlerWriter
- Throws:
IOException
XMLStreamException
-
writeDataHandler
public void writeDataHandler(org.apache.axiom.ext.stax.datahandler.DataHandlerProvider dataHandlerProvider, String contentID, boolean optimize) throws IOException, XMLStreamException
- Specified by:
writeDataHandler
in interfaceorg.apache.axiom.ext.stax.datahandler.DataHandlerWriter
- Throws:
IOException
XMLStreamException
-
close
public void close() throws XMLStreamException
- Specified by:
close
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
flush
public void flush() throws XMLStreamException
- Specified by:
flush
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
getNamespaceContext
public NamespaceContext getNamespaceContext()
- Specified by:
getNamespaceContext
in interfaceXMLStreamWriter
-
getPrefix
public String getPrefix(String uri) throws XMLStreamException
- Specified by:
getPrefix
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
setDefaultNamespace
public void setDefaultNamespace(String uri) throws XMLStreamException
- Specified by:
setDefaultNamespace
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
setNamespaceContext
public void setNamespaceContext(NamespaceContext context) throws XMLStreamException
- Specified by:
setNamespaceContext
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
setPrefix
public void setPrefix(String prefix, String uri) throws XMLStreamException
- Specified by:
setPrefix
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws XMLStreamException
- Specified by:
writeAttribute
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException
- Specified by:
writeAttribute
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String localName, String value) throws XMLStreamException
- Specified by:
writeAttribute
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeCData
public void writeCData(String data) throws XMLStreamException
- Specified by:
writeCData
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeCharacters
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException
- Specified by:
writeCharacters
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeCharacters
public void writeCharacters(String text) throws XMLStreamException
- Specified by:
writeCharacters
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeComment
public void writeComment(String data) throws XMLStreamException
- Specified by:
writeComment
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeDefaultNamespace
public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException
- Specified by:
writeDefaultNamespace
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeDTD
public void writeDTD(String dtd) throws XMLStreamException
- Specified by:
writeDTD
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException
- Specified by:
writeEmptyElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException
- Specified by:
writeEmptyElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String localName) throws XMLStreamException
- Specified by:
writeEmptyElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEndDocument
public void writeEndDocument() throws XMLStreamException
- Specified by:
writeEndDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEndElement
public void writeEndElement() throws XMLStreamException
- Specified by:
writeEndElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeEntityRef
public void writeEntityRef(String name) throws XMLStreamException
- Specified by:
writeEntityRef
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeNamespace
public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException
- Specified by:
writeNamespace
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeProcessingInstruction
public void writeProcessingInstruction(String target, String data) throws XMLStreamException
- Specified by:
writeProcessingInstruction
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeProcessingInstruction
public void writeProcessingInstruction(String target) throws XMLStreamException
- Specified by:
writeProcessingInstruction
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartDocument
public void writeStartDocument() throws XMLStreamException
- Specified by:
writeStartDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartDocument
public void writeStartDocument(String encoding, String version) throws XMLStreamException
- Specified by:
writeStartDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartDocument
public void writeStartDocument(String version) throws XMLStreamException
- Specified by:
writeStartDocument
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException
- Specified by:
writeStartElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException
- Specified by:
writeStartElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String localName) throws XMLStreamException
- Specified by:
writeStartElement
in interfaceXMLStreamWriter
- Throws:
XMLStreamException
-
-