Java Doc for XMLStreamWriterEx.java in  » XML » stax-ex » org » jvnet » staxex » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Some infoset serializer (such as XOP encoder, FastInfoset) uses a format that can represent binary data more efficiently than base64 encoding. Such infoset serializer may choose to implement this interface, to allow the caller to pass in binary data more efficiently without first converting it to binary data.

Callers capable of using this interface can see if the serializer supports it by simply downcasting XMLStreamWriter to XMLStreamWriterEx .

TODO

1. Add methods to write other primitive types, such as hex and integers (and arrays of). A textual implementation would write characters in accordance to the canonical lexical definitions specified in W3C XML Schema: datatypes. A MTOM implementation would write characters except for the case where octets that would otherwise be base64 encoded when using the textual implementation. A Fast Infoset implementation would encoded binary data the primitive types in binary form.
2. Consider renaming writeBinary to writeBytesAsBase64 to be consistent with infoset abstraction.
3. Add the ability to writeStart and writeEnd on attributes so that the same methods for writing primitive types (and characters, which will require new methods) can be used for writing attribute values as well as element content.

Conceptually (infoset-wise), this produces the base64-encoded binary data on the output.

This method works like the XMLStreamWriterEx.writeBinary(byte[],int,int,String) method, except that it takes the binary data in the form of DataHandler , which contains a MIME type ( DataHandler.getContentType as well as the payload DataHandler.getInputStream .
Parameters:
  data - always non-null.

This version of the writeBinary method allows the caller to produce the binary data by writing it to OutputStream .

It is the caller's responsibility to write and close a stream before it invokes any other methods on XMLStreamWriter . TODO: experimental.

Conceptually (infoset-wise), this produces the base64-encoded binary data on the output. But this allows implementations like FastInfoset or XOP to do the smart thing.

The use of this method has some restriction to support XOP. Namely, this method must be invoked as a sole content of an element.

(data,start,len) triplet identifies the binary data to be written. After the method invocation, the callee owns the buffer.
Parameters:
  contentType - this mandatory parameter identifies the MIME type of the binary data.If the MIME type isn't known by the caller, "application/octet-stream" canbe always used to indicate "I don't know." Never null.

This method works like the XMLStreamWriterEx.writeBinary(byte[],int,int,String) method, except that it takes the binary data in the form of DataHandler , which contains a MIME type ( DataHandler.getContentType as well as the payload DataHandler.getInputStream .
Parameters:
  data - always non-null. After this method call, the callee owns the data handler.

This version of the writeBinary method allows the caller to produce the binary data by writing it to OutputStream .

It is the caller's responsibility to write and close a stream before it invokes any other methods on XMLStreamWriter . TODO: experimental. appreciate feedback
Parameters:
  contentType - See the content-type parameter ofXMLStreamWriterEx.writeBinary(byte[],int,int,String). Must not be null.always return a non-null OutputStream.

The CharSequence is normally a String,but can be any other CharSequence implementation.For binary data, however, use of Base64Data isrecommended (so that the consumer interested in seeing itas binary data may take advantage of mor efficientdata representation.)