InputStreamHandle (MarkLogic Java Client API 7.2.0)

java.lang.Object
- com.marklogic.client.impl.HandleImplementation<R,W>
- - com.marklogic.client.io.BaseHandle<java.io.InputStream,java.io.InputStream>
  - - com.marklogic.client.io.InputStreamHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BinaryReadHandle, BinaryWriteHandle, BufferableContentHandle<java.io.InputStream,java.io.InputStream>, BufferableHandle, ContentHandle<java.io.InputStream>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, GenericReadHandle, GenericWriteHandle, JSONReadHandle, JSONWriteHandle, QuadsWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StreamingContentHandle<java.io.InputStream,java.io.InputStream>, StructureReadHandle, StructureWriteHandle, TextReadHandle, TextWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, java.io.Closeable, java.lang.AutoCloseable
```
public class InputStreamHandle
extends BaseHandle<java.io.InputStream,java.io.InputStream>
implements StreamingContentHandle<java.io.InputStream,java.io.InputStream>, BinaryReadHandle, BinaryWriteHandle, GenericReadHandle, GenericWriteHandle, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, CtsQueryWriteHandle, TriplesReadHandle, TriplesWriteHandle, QuadsWriteHandle, SPARQLResultsReadHandle, java.io.Closeable
```
An InputStreamHandle represents a resource as an InputStream for reading or writing.

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.

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
`InputStreamHandle()` Zero-argument constructor.
`InputStreamHandle(java.io.InputStream content)` Initializes the handle with an input stream for the content.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.io.InputStream`	`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 InputStream.
`byte[]`	`contentToBytes(java.io.InputStream 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.InputStream`	`get()` Returns an input stream for a resource read from the database.
`java.lang.Class<java.io.InputStream>`	`getContentClass()` Returns the class of the handled content, which may be a base class of the actual class of a content object.
`java.io.InputStream[]`	`newArray(int length)` Constructs an array for the handled content representation
`static ContentHandleFactory`	`newFactory()` Creates a factory to create an InputStreamHandle instance for an input stream.
`InputStreamHandle`	`newHandle()` Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
`InputStreamHandle[]`	`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 java.io.InputStream`	`sendContent()`
`void`	`set(java.io.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.
`java.io.InputStream`	`toContent(java.io.InputStream serialization)` Converts the serialization to the content representation.
`java.lang.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(java.io.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(java.lang.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, 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.StreamingContentHandle
resendableHandleFor

Methods inherited from interface com.marklogic.client.io.marker.BufferableContentHandle
newHandle, resendableHandleFor

- Constructor Detail
  - InputStreamHandle
```
public InputStreamHandle()
```
    Zero-argument constructor.
  - InputStreamHandle
```
public InputStreamHandle(java.io.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 java.io.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<java.io.InputStream>
    
    Returns:
    
    the input stream
  - set
```
public void set(java.io.InputStream content)
```
    Assigns an input stream as the content.
    
    Specified by:
    
    set in interface ContentHandle<java.io.InputStream>
    
    Parameters:
    
    content - an input stream
  - with
```
public InputStreamHandle with(java.io.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
  - getContentClass
```
public java.lang.Class<java.io.InputStream> 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.InputStream>
    
    Returns:
    
    the class for the handled content
  - newHandle
```
public InputStreamHandle 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.InputStream,java.io.InputStream>
    
    Specified by:
    
    newHandle in interface ContentHandle<java.io.InputStream>
    
    Returns:
    
    the new handle
  - newHandleArray
```
public InputStreamHandle[] 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.InputStream,java.io.InputStream>
    
    Parameters:
    
    length - the number of positions in the array
    
    Returns:
    
    the uninitialized array
  - newArray
```
public java.io.InputStream[] newArray(int length)
```
    Description copied from interface: ContentHandle
    
    Constructs an array for the handled content representation
    
    Specified by:
    
    newArray in interface ContentHandle<java.io.InputStream>
    
    Parameters:
    
    length - the size of the array (zero or more)
    
    Returns:
    
    the constructed array
  - 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(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.io.InputStream bytesToContent(byte[] buffer)
```
    Description copied from interface: BufferableContentHandle
    
    Converts a byte serialization to the content representation.
    
    Specified by:
    
    bytesToContent in interface BufferableContentHandle<java.io.InputStream,java.io.InputStream>
    
    Parameters:
    
    buffer - the byte serialization
    
    Returns:
    
    the content representation
  - contentToBytes
```
public byte[] contentToBytes(java.io.InputStream content)
```
    Description copied from interface: BufferableContentHandle
    
    Converts the content representation to bytes.
    
    Specified by:
    
    contentToBytes in interface BufferableContentHandle<java.io.InputStream,java.io.InputStream>
    
    Parameters:
    
    content - the content
    
    Returns:
    
    the byte serialization of the content
  - toContent
```
public java.io.InputStream 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.InputStream,java.io.InputStream>
    
    Parameters:
    
    serialization - a serialization of the content
    
    Returns:
    
    the content representation
  - toString
```
public java.lang.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 java.lang.Object
  - receiveAs
```
protected java.lang.Class<java.io.InputStream> receiveAs()
```
    Overrides:
    
    receiveAs in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,java.io.InputStream>
  - receiveContent
```
protected void receiveContent(java.io.InputStream content)
```
    Overrides:
    
    receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,java.io.InputStream>
  - sendContent
```
protected java.io.InputStream sendContent()
```
    Overrides:
    
    sendContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,java.io.InputStream>
  - close
```
public void close()
```
    Either call close() or get().close() when finished with this handle to close the underlying InputStream.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable

Class InputStreamHandle

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

InputStreamHandle

InputStreamHandle

Method Detail

newFactory

get

set

with

getContentClass

newHandle

newHandleArray

newArray

withFormat

withMimetype

fromBuffer

toBuffer

bytesToContent

contentToBytes

toContent

toString

receiveAs

receiveContent

sendContent

close