com.marklogic.client.io

Class ReaderHandle

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<InputStream,OutputStreamSender>

com.marklogic.client.io.ReaderHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableHandle, ContentHandle<Reader>, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, JSONReadHandle, JSONWriteHandle, QuadsWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TextReadHandle, TextWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender, Closeable, AutoCloseable

public class ReaderHandle
extends BaseHandle<InputStream,OutputStreamSender>
implements OutputStreamSender, BufferableHandle, ContentHandle<Reader>, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, QuadsWriteHandle, TriplesReadHandle, TriplesWriteHandle, Closeable

A Reader Handle represents a character content as a reader for reading to or writing from the database.

Either call close() or get().close() when finished with this handle to release the resources.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
ReaderHandle() Zero-argument constructor.
ReaderHandle(Reader content) Initializes the handle with a character reader for the content.

Method Summary

Modifier and Type	Method and Description
void	close() Either call close() or get().close() when finished with this handle to close the underlying Reader.
void	fromBuffer(byte[] buffer) Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
Reader	get() Returns a character reader for reading content.
static ContentHandleFactory	newFactory() Creates a factory to create a ReaderHandle instance for a Reader.
void	set(Reader content) Assigns an character reader as the content.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
String	toString() Buffers the character stream and returns the buffer as a string.
ReaderHandle	with(Reader content) Assigns a character reader as the content and returns the handle as a fluent convenience.
ReaderHandle	withFormat(Format format) Specifies the format of the content and returns the handle as a fluent convenience.
ReaderHandle	withMimetype(String mimetype) Specifies the mime type of the content and returns the handle as a fluent convenience.
void	write(OutputStream out) Implements a callback to write content to the provided output stream for sending to the database server.

Methods inherited from class com.marklogic.client.io.BaseHandle

getByteLength, getFormat, getMimetype, setByteLength, setFormat, setMimetype

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReaderHandle

public ReaderHandle()

Zero-argument constructor.

ReaderHandle

public ReaderHandle(Reader content)

Initializes the handle with a character reader for the content.

Parameters:

content - a character reader

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a ReaderHandle instance for a Reader.

Returns:

the factory

get

public Reader get()

Returns a character reader for reading content. When finished with the reader, close the reader to release the resource.

Specified by:

get in interface ContentHandle<Reader>

Returns:

the character reader

set

public void set(Reader content)

Assigns an character reader as the content.

Specified by:

set in interface ContentHandle<Reader>

Parameters:

content - a reader

with

public ReaderHandle with(Reader content)

Assigns a character reader as the content and returns the handle as a fluent convenience.

Parameters:

content - a reader

Returns:

this handle

withFormat

public ReaderHandle withFormat(Format format)

Specifies the format of the content and returns the handle as a fluent convenience.

Parameters:

format - the format of the content

Returns:

this handle

withMimetype

public ReaderHandle withMimetype(String mimetype)

Specifies the mime type of the content and returns the handle as a fluent convenience.

Parameters:

mimetype - the mime type of the content

Returns:

this handle

fromBuffer

public void fromBuffer(byte[] buffer)

Description copied from interface: BufferableHandle

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

Specified by:

fromBuffer in interface BufferableHandle

Parameters:

buffer - the byte array

toBuffer

public byte[] toBuffer()

Description copied from interface: BufferableHandle

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

Specified by:

toBuffer in interface BufferableHandle

Returns:

the byte array

toString

public String toString()

Buffers the character stream and returns the buffer as a string.

Overrides:

toString in class Object

write

public void write(OutputStream out)
           throws IOException

Description copied from interface: OutputStreamSender

Implements a callback to write content to the provided output stream for sending to the database server.

Specified by:

write in interface OutputStreamSender

Parameters:

out - the output stream receiving the content

Throws:

IOException - if io problems arise

close

public void close()

Either call close() or get().close() when finished with this handle to close the underlying Reader.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable