com.marklogic.client.io

Class StringHandle

java.lang.Object

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

com.marklogic.client.io.BaseHandle<byte[],OutputStreamSender>

com.marklogic.client.io.StringHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<java.lang.String,byte[]>, BufferableHandle, ContentHandle<java.lang.String>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, JSONReadHandle, JSONWriteHandle, QuadsWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, ResendableContentHandle<java.lang.String,byte[]>, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TextReadHandle, TextWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender

public class StringHandle
extends BaseHandle<byte[],OutputStreamSender>
implements ResendableContentHandle<java.lang.String,byte[]>, OutputStreamSender, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, CtsQueryWriteHandle, QuadsWriteHandle, TriplesReadHandle, TriplesWriteHandle, SPARQLResultsReadHandle

A String Handle represents document content as a string for reading or writing.

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
StringHandle() Zero-argument constructor.
StringHandle(java.io.Reader content) Initializes the handle by constructing a string from the content of a reader.
StringHandle(java.lang.String content) Initializes the handle with a string for the content.

Method Summary

Modifier and Type	Method and Description
java.lang.String	bytesToContent(byte[] buffer) Converts a byte serialization to the content representation.
byte[]	contentToBytes(java.lang.String content) Converts the content representation to bytes.
StringHandle	from(java.io.Reader content) Assigns a string constructed from the content of a reader and returns the handle as a fluent convenience.
void	fromBuffer(byte[] buffer) Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
java.lang.String	get() Returns the string for the content.
java.lang.Class<java.lang.String>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
java.lang.String[]	newArray(int length) Constructs an array for the handled content representation
static ContentHandleFactory	newFactory() Creates a factory to create a StringHandle instance for a string.
StringHandle	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
StringHandle[]	newHandleArray(int length) Constructs an uninitialized array with the specified length with items of the same content representation.
protected java.lang.Class<byte[]>	receiveAs()
protected void	receiveContent(byte[] content)
protected OutputStreamSender	sendContent()
void	set(java.lang.String content) Assigns an string as the content.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
java.lang.String	toContent(byte[] serialization) Converts the serialization to the content representation.
java.lang.String	toString() Returns the content.
StringHandle	with(java.lang.String content) Assigns a string as the content and returns the handle as a fluent convenience.
StringHandle	withFormat(Format format) Specifies the format of the content and returns the handle as a fluent convenience.
StringHandle	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 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.ResendableContentHandle

newHandle, resendableHandleFor

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

resendableHandleFor

Constructor Detail

StringHandle

public StringHandle()

Zero-argument constructor.

StringHandle

public StringHandle(java.lang.String content)

Initializes the handle with a string for the content.

Parameters:

content - a content string

StringHandle

public StringHandle(java.io.Reader content)

Initializes the handle by constructing a string from the content of a reader.

Parameters:

content - the reader with the content

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a StringHandle instance for a string.

Returns:

the factory

get

public java.lang.String get()

Returns the string for the content.

Specified by:

get in interface ContentHandle<java.lang.String>

Returns:

the string

set

public void set(java.lang.String content)

Assigns an string as the content.

Specified by:

set in interface ContentHandle<java.lang.String>

Parameters:

content - a string

with

public StringHandle with(java.lang.String content)

Assigns a string as the content and returns the handle as a fluent convenience.

Parameters:

content - a string

Returns:

this handle

from

public StringHandle from(java.io.Reader content)

Assigns a string constructed from the content of a reader and returns the handle as a fluent convenience.

Parameters:

content - the reader with the content

Returns:

this handle

getContentClass

public java.lang.Class<java.lang.String> 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.lang.String>

Returns:

the class for the handled content

newHandle

public StringHandle 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.lang.String,byte[]>

Specified by:

newHandle in interface ContentHandle<java.lang.String>

Specified by:

newHandle in interface ResendableContentHandle<java.lang.String,byte[]>

Returns:

the new handle

newHandleArray

public StringHandle[] 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.lang.String,byte[]>

Specified by:

newHandleArray in interface ResendableContentHandle<java.lang.String,byte[]>

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

newArray

public java.lang.String[] newArray(int length)

Description copied from interface: ContentHandle

Constructs an array for the handled content representation

Specified by:

newArray in interface ContentHandle<java.lang.String>

Parameters:

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

Returns:

the constructed array

withFormat

public StringHandle 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 StringHandle 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

bytesToContent

public java.lang.String bytesToContent(byte[] buffer)

Description copied from interface: BufferableContentHandle

Converts a byte serialization to the content representation.

Specified by:

bytesToContent in interface BufferableContentHandle<java.lang.String,byte[]>

Parameters:

buffer - the byte serialization

Returns:

the content representation

contentToBytes

public byte[] contentToBytes(java.lang.String content)

Description copied from interface: BufferableContentHandle

Converts the content representation to bytes.

Specified by:

contentToBytes in interface BufferableContentHandle<java.lang.String,byte[]>

Parameters:

content - the content

Returns:

the byte serialization of the content

toString

public java.lang.String toString()

Returns the content.

Overrides:

toString in class java.lang.Object

toContent

public java.lang.String toContent(byte[] serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

toContent in interface BufferableContentHandle<java.lang.String,byte[]>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

receiveAs

protected java.lang.Class<byte[]> receiveAs()

Overrides:

receiveAs in class com.marklogic.client.impl.HandleImplementation<byte[],OutputStreamSender>

receiveContent

protected void receiveContent(byte[] content)

Overrides:

receiveContent in class com.marklogic.client.impl.HandleImplementation<byte[],OutputStreamSender>

sendContent

protected OutputStreamSender sendContent()

Overrides:

sendContent in class com.marklogic.client.impl.HandleImplementation<byte[],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