com.marklogic.client.io.marker

Interface BufferableHandle

All Known Implementing Classes:

BytesHandle, DocumentMetadataHandle, DOM4JHandle, DOMHandle, GSONHandle, InputSourceHandle, InputStreamHandle, JacksonDatabindHandle, JacksonHandle, JacksonParserHandle, JAXBHandle, JDOMHandle, QueryOptionsHandle, ReaderHandle, SourceHandle, StringHandle, XMLEventReaderHandle, XMLStreamReaderHandle, XOMHandle

public interface BufferableHandle

A Bufferable Handle can read content from a byte[] buffer or write content as a byte[] buffer without changing the state of an external resource. Handles that modify an external resource, such as FileHandle, cannot implement BufferableHandle. For JSON, text, or XML content, the byte array must be encoded in UTF-8. Where possible, the handle uses the byte array directly as a backing store. Otherwise, the handle makes a copy into its own store from the byte array.

Method Summary

Modifier and Type	Method and Description
void	fromBuffer(byte[] buffer) Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.

Method Detail

fromBuffer

void fromBuffer(byte[] buffer)

Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.

Parameters:

buffer - the byte array

toBuffer

byte[] toBuffer()

Copies the content of the handle to a byte array buffer encoded in UTF-8.

Returns:

the byte array