com.pivotal.gemfirexd.internal.client.am

Class BlobLocatorInputStream

java.lang.Object

java.io.InputStream

com.pivotal.gemfirexd.internal.client.am.BlobLocatorInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BlobLocatorInputStream
extends InputStream

An InputStream that will use an locator to fetch the Blob value from the server.

Closing a ByteArrayInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

This InputStream implementation is pretty basic. No buffering of data is done. Hence, for efficieny #read(byte[]) should be used instead of #read(). Marks are not supported, but it should be pretty simple to extend the implementation to support this. A more efficient skip implementation should also be straight-forward.

Constructor Summary

Constructors

Constructor and Description
BlobLocatorInputStream(Connection connection, Blob blob) Create an InputStream for reading the Blob value represented by the given locator based Blob object.
BlobLocatorInputStream(Connection connection, Blob blob, long position, long length) Create an InputStream for reading the Blob value represented by the given locator based Blob object.

Method Summary

Methods

Modifier and Type	Method and Description
int	read()
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobLocatorInputStream

public BlobLocatorInputStream(Connection connection,
                      Blob blob)
                       throws SqlException

Create an InputStream for reading the Blob value represented by the given locator based Blob object.

Parameters:

connection - connection to be used to read the Blob value from the server

blob - Blob object that contains locator for the Blob value on the server.

Throws:

SqlException - if an error occurs when obtaining the length of the Blob.

BlobLocatorInputStream

public BlobLocatorInputStream(Connection connection,
                      Blob blob,
                      long position,
                      long length)
                       throws SqlException

Create an InputStream for reading the Blob value represented by the given locator based Blob object.

Parameters:

connection - connection to be used to read the Blob value from the server

blob - Blob object that contains locator for the Blob value on the server.

position - the position in the Blob of the first byte to read.

length - the maximum number of bytes to read from the Blob.

Throws:

SqlException - if an error occurs when obtaining the length of the Blob.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

See Also:

This method fetches one byte at a time from the server. For more efficient retrieval, use #read(byte[]).

read

public int read(byte[] b,
       int off,
       int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

See Also:

InputStream.read(byte[], int, int)