Package com.google.appengine.api.blobstore

Class BlobstoreInputStream

java.lang.Object

java.io.InputStream

com.google.appengine.api.blobstore.BlobstoreInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class BlobstoreInputStream
extends InputStream

BlobstoreInputStream provides an InputStream view of a blob in Blobstore. It is thread compatible but not thread safe: there is no static state, but any multithreaded use must be externally synchronized.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BlobstoreInputStream.BlobstoreIOException	A subclass of IOException that indicates that there was a problem interacting with Blobstore.
static final class	BlobstoreInputStream.ClosedStreamException	A subclass of IOException that indicates operations on a stream after it is closed.

Constructor Summary

Constructors

Constructor	Description
BlobstoreInputStream(BlobKey blobKey)	Creates a BlobstoreInputStream that reads data from the blob indicated by blobKey, starting at the beginning of the blob.
BlobstoreInputStream(BlobKey blobKey, long offset)	Creates a BlobstoreInputStream that reads data from the blob indicated by blobKey, starting at offset.

Method Summary

Modifier and Type	Method	Description
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()

Methods inherited from class java.io.InputStream

available, nullInputStream, read, readAllBytes, readNBytes, readNBytes, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

BlobstoreInputStream

public BlobstoreInputStream(BlobKey blobKey,
 long offset)
                     throws IOException

Creates a BlobstoreInputStream that reads data from the blob indicated by blobKey, starting at offset.

Parameters:

blobKey - A valid BlobKey indicating the blob to read from.

offset - An offset to start from.

Throws:

BlobstoreInputStream.BlobstoreIOException - If the blobKey given is invalid.

IllegalArgumentException - If offset < 0.

IOException

BlobstoreInputStream

public BlobstoreInputStream(BlobKey blobKey)
                     throws IOException

Creates a BlobstoreInputStream that reads data from the blob indicated by blobKey, starting at the beginning of the blob.

Parameters:

blobKey - A valid BlobKey indicating the blob to read from.

Throws:

BlobstoreInputStream.BlobstoreIOException - If the blobKey given is invalid.

IllegalArgumentException - If offset < 0.

IOException

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException - - does not actually throw but as it's part of our public API and removing it can cause compilation errors, leaving it in (and documenting to quiet Eclipse warning).

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException