public class XOPEncodingStreamWriter extends XOPEncodingStreamWrapper implements javax.xml.stream.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.PROPERTY| Constructor and Description |
|---|
XOPEncodingStreamWriter(javax.xml.stream.XMLStreamWriter parent,
ContentIDGenerator contentIDGenerator,
OptimizationPolicy optimizationPolicy)
Constructor.
|
| Modifier and Type | Method and 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(DataHandlerProvider dataHandlerProvider,
String contentID,
boolean optimize)
Write binary content to the stream.
|
void |
writeDataHandler(javax.activation.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) |
getContentIDs, getDataHandler, isLoaded, processDataHandler, processDataHandlerpublic XOPEncodingStreamWriter(javax.xml.stream.XMLStreamWriter parent, ContentIDGenerator contentIDGenerator, OptimizationPolicy optimizationPolicy)
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 optimizepublic Object getProperty(String name) throws IllegalArgumentException
getProperty in interface javax.xml.stream.XMLStreamWriterIllegalArgumentExceptionpublic void writeDataHandler(javax.activation.DataHandler dataHandler,
String contentID,
boolean optimize)
throws IOException,
javax.xml.stream.XMLStreamException
DataHandlerWriterwriteDataHandler in interface DataHandlerWriterdataHandler - 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)IOException - if an error occurs while reading from the data handlerjavax.xml.stream.XMLStreamException - if an error occurs while writing to the underlying streampublic void writeDataHandler(DataHandlerProvider dataHandlerProvider, String contentID, boolean optimize) throws IOException, javax.xml.stream.XMLStreamException
DataHandlerWriterwriteDataHandler in interface DataHandlerWriterdataHandlerProvider - 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)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.javax.xml.stream.XMLStreamException - if an error occurs while writing to the underlying streampublic void close()
throws javax.xml.stream.XMLStreamException
close in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void flush()
throws javax.xml.stream.XMLStreamException
flush in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic NamespaceContext getNamespaceContext()
getNamespaceContext in interface javax.xml.stream.XMLStreamWriterpublic String getPrefix(String uri) throws javax.xml.stream.XMLStreamException
getPrefix in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void setDefaultNamespace(String uri) throws javax.xml.stream.XMLStreamException
setDefaultNamespace in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void setNamespaceContext(NamespaceContext context) throws javax.xml.stream.XMLStreamException
setNamespaceContext in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void setPrefix(String prefix, String uri) throws javax.xml.stream.XMLStreamException
setPrefix in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws javax.xml.stream.XMLStreamException
writeAttribute in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeAttribute(String namespaceURI, String localName, String value) throws javax.xml.stream.XMLStreamException
writeAttribute in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeAttribute(String localName, String value) throws javax.xml.stream.XMLStreamException
writeAttribute in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeCData(String data) throws javax.xml.stream.XMLStreamException
writeCData in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeCharacters(char[] text,
int start,
int len)
throws javax.xml.stream.XMLStreamException
writeCharacters in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeCharacters(String text) throws javax.xml.stream.XMLStreamException
writeCharacters in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeComment(String data) throws javax.xml.stream.XMLStreamException
writeComment in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeDefaultNamespace(String namespaceURI) throws javax.xml.stream.XMLStreamException
writeDefaultNamespace in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeDTD(String dtd) throws javax.xml.stream.XMLStreamException
writeDTD in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEmptyElement(String prefix, String localName, String namespaceURI) throws javax.xml.stream.XMLStreamException
writeEmptyElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEmptyElement(String namespaceURI, String localName) throws javax.xml.stream.XMLStreamException
writeEmptyElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEmptyElement(String localName) throws javax.xml.stream.XMLStreamException
writeEmptyElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEndDocument()
throws javax.xml.stream.XMLStreamException
writeEndDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEndElement()
throws javax.xml.stream.XMLStreamException
writeEndElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEntityRef(String name) throws javax.xml.stream.XMLStreamException
writeEntityRef in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeNamespace(String prefix, String namespaceURI) throws javax.xml.stream.XMLStreamException
writeNamespace in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeProcessingInstruction(String target, String data) throws javax.xml.stream.XMLStreamException
writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeProcessingInstruction(String target) throws javax.xml.stream.XMLStreamException
writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument()
throws javax.xml.stream.XMLStreamException
writeStartDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument(String encoding, String version) throws javax.xml.stream.XMLStreamException
writeStartDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument(String version) throws javax.xml.stream.XMLStreamException
writeStartDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartElement(String prefix, String localName, String namespaceURI) throws javax.xml.stream.XMLStreamException
writeStartElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartElement(String namespaceURI, String localName) throws javax.xml.stream.XMLStreamException
writeStartElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartElement(String localName) throws javax.xml.stream.XMLStreamException
writeStartElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionCopyright © The Apache Software Foundation. All Rights Reserved.