Package com.marklogic.client.io

Class ReaderHandle

java.lang.Object

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

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

com.marklogic.client.io.ReaderHandle

All Implemented Interfaces:

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

public class ReaderHandle
extends BaseHandle<java.io.InputStream,OutputStreamSender>
implements OutputStreamSender, StreamingContentHandle<java.io.Reader,java.io.InputStream>, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, CtsQueryWriteHandle, QuadsWriteHandle, TriplesReadHandle, TriplesWriteHandle, java.io.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	Description
ReaderHandle()	Zero-argument constructor.
ReaderHandle(java.io.Reader content)	Initializes the handle with a character reader for the content.

Method Summary

Modifier and Type	Method	Description
java.io.Reader	bytesToContent(byte[] buffer)	Converts a byte serialization to the content representation.
void	close()	Either call close() or get().close() when finished with this handle to close the underlying Reader.
byte[]	contentToBytes(java.io.Reader content)	Converts the content representation to bytes.
void	fromBuffer(byte[] buffer)	Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
java.io.Reader	get()	Returns a character reader for reading content.
java.lang.Class<java.io.Reader>	getContentClass()	Returns the class of the handled content, which may be a base class of the actual class of a content object.
java.io.Reader[]	newArray(int length)	Constructs an array for the handled content representation
static ContentHandleFactory	newFactory()	Creates a factory to create a ReaderHandle instance for a Reader.
ReaderHandle	newHandle()	Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
ReaderHandle[]	newHandleArray(int length)	Constructs an uninitialized array with the specified length with items of the same content representation.
protected java.lang.Class<java.io.InputStream>	receiveAs()
protected void	receiveContent(java.io.InputStream content)
protected ReaderHandle	sendContent()
void	set(java.io.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.
java.io.Reader	toContent(java.io.InputStream serialization)	Converts the serialization to the content representation.
java.lang.String	toString()	Buffers the character stream and returns the buffer as a string.
ReaderHandle	with(java.io.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(java.lang.String mimetype)	Specifies the mime type of the content and returns the handle as a fluent convenience.
void	write(java.io.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, getServerTimestamp, setByteLength, setFormat, setMimetype, setServerTimestamp

Methods inherited from interface com.marklogic.client.io.marker.BufferableContentHandle

newHandle, resendableHandleFor

Methods inherited from class com.marklogic.client.impl.HandleImplementation

getPointInTimeQueryTimestamp, isResendable, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.marklogic.client.io.marker.StreamingContentHandle

resendableHandleFor

Constructor Detail

ReaderHandle

public ReaderHandle()

Zero-argument constructor.

ReaderHandle

public ReaderHandle(java.io.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 java.io.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<java.io.Reader>

Returns:

the character reader

set

public void set(java.io.Reader content)

Assigns an character reader as the content.

Specified by:

set in interface ContentHandle<java.io.Reader>

Parameters:

content - a reader

with

public ReaderHandle with(java.io.Reader content)

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

Parameters:

content - a reader

Returns:

this handle

getContentClass

public java.lang.Class<java.io.Reader> getContentClass()

Description copied from interface: ContentHandle

Returns the class of the handled content, which may be a base class of the actual class of a content object. Note that implementations should override the default method, which returns null if the handle doesn't have any content.

Specified by:

getContentClass in interface ContentHandle<java.io.Reader>

Returns:

the class for the handled content

newHandle

public ReaderHandle newHandle()

Description copied from interface: ContentHandle

Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

Specified by:

newHandle in interface BufferableContentHandle<java.io.Reader,java.io.InputStream>

Specified by:

newHandle in interface ContentHandle<java.io.Reader>

Returns:

the new handle

newHandleArray

public ReaderHandle[] newHandleArray(int length)

Description copied from interface: BufferableContentHandle

Constructs an uninitialized array with the specified length with items of the same content representation.

Specified by:

newHandleArray in interface BufferableContentHandle<java.io.Reader,java.io.InputStream>

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

newArray

public java.io.Reader[] newArray(int length)

Description copied from interface: ContentHandle

Constructs an array for the handled content representation

Specified by:

newArray in interface ContentHandle<java.io.Reader>

Parameters:

length - the size of the array (zero or more)

Returns:

the constructed array

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(java.lang.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

toContent

public java.io.Reader toContent(java.io.InputStream serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

toContent in interface BufferableContentHandle<java.io.Reader,java.io.InputStream>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

bytesToContent

public java.io.Reader bytesToContent(byte[] buffer)

Description copied from interface: BufferableContentHandle

Converts a byte serialization to the content representation.

Specified by:

bytesToContent in interface BufferableContentHandle<java.io.Reader,java.io.InputStream>

Parameters:

buffer - the byte serialization

Returns:

the content representation

contentToBytes

public byte[] contentToBytes(java.io.Reader content)

Description copied from interface: BufferableContentHandle

Converts the content representation to bytes.

Specified by:

contentToBytes in interface BufferableContentHandle<java.io.Reader,java.io.InputStream>

Parameters:

content - the content

Returns:

the byte serialization of the content

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

receiveAs

protected java.lang.Class<java.io.InputStream> receiveAs()

Overrides:

receiveAs in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

receiveContent

protected void receiveContent(java.io.InputStream content)

Overrides:

receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

sendContent

protected ReaderHandle sendContent()

Overrides:

sendContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

write

public void write(java.io.OutputStream out)
           throws java.io.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:

java.io.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 java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable