com.marklogic.client.io

Class InputStreamHandle

java.lang.Object

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

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

com.marklogic.client.io.InputStreamHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BinaryReadHandle, BinaryWriteHandle, BufferableHandle, ContentHandle<InputStream>, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, GenericReadHandle, GenericWriteHandle, JSONReadHandle, JSONWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, StructureReadHandle, StructureWriteHandle, TextReadHandle, TextWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle

public class InputStreamHandle
extends BaseHandle<InputStream,InputStream>
implements BufferableHandle, ContentHandle<InputStream>, BinaryReadHandle, BinaryWriteHandle, GenericReadHandle, GenericWriteHandle, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle

An Input Stream Handle represents a resource as an input stream for reading or writing. When finished with the input stream, close the input stream to release the response. When writing JSON, text, or XML content, you should use an InputStream only if the stream is encoded in UTF-8. If the characters have a different encoding, use a ReaderHandle and specify the correct character encoding for the stream when creating the Reader.

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
InputStreamHandle() Zero-argument constructor.
InputStreamHandle(InputStream content) Initializes the handle with an input stream for the content.

Method Summary

Methods

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.
InputStream	get() Returns an input stream for a resource read from the database.
static ContentHandleFactory	newFactory() Creates a factory to create an InputStreamHandle instance for an input stream.
void	set(InputStream content) Assigns an input stream as the content.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
String	toString() Buffers the input stream and returns the buffer as a string with the assumption that the stream is encoded in UTF-8.
InputStreamHandle	with(InputStream content) Assigns an input stream as the content and returns the handle as a fluent convenience.
InputStreamHandle	withFormat(Format format) Specifies the format of the content and returns the handle as a fluent convenience.
InputStreamHandle	withMimetype(String mimetype) Specifies the mime type of the content and returns the handle as a fluent convenience.

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

InputStreamHandle

public InputStreamHandle()

Zero-argument constructor.

InputStreamHandle

public InputStreamHandle(InputStream content)

Initializes the handle with an input stream for the content.

Parameters:

content - an input stream

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create an InputStreamHandle instance for an input stream.

Returns:

the factory

get

public InputStream get()

Returns an input stream for a resource read from the database. When finished with the input stream, close the input stream to release the response.

Specified by:

get in interface ContentHandle<InputStream>

Returns:

the input stream

set

public void set(InputStream content)

Assigns an input stream as the content.

Specified by:

set in interface ContentHandle<InputStream>

Parameters:

content - an input stream

with

public InputStreamHandle with(InputStream content)

Assigns an input stream as the content and returns the handle as a fluent convenience.

Parameters:

content - an input stream

Returns:

this handle

withFormat

public InputStreamHandle 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 InputStreamHandle 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 input stream and returns the buffer as a string with the assumption that the stream is encoded in UTF-8. If the stream has a different encoding, use InputStreamReader instead of calling this method.

Overrides:

toString in class Object