public class InputStreamContentProvider extends Object implements ContentProvider, Callback, Closeable
ContentProvider
for an InputStream
.
The input stream is read once and therefore fully consumed.
Invocations to the iterator()
method after the first will return an "empty" iterator
because the stream has been consumed on the first invocation.
However, it is possible for subclasses to override onRead(byte[], int, int)
to copy
the content read from the stream to another location (for example a file), and be able to
support multiple invocations of iterator()
, returning the iterator provided by this
class on the first invocation, and an iterator on the bytes copied to the other location
for subsequent invocations.
It is possible to specify, at the constructor, a buffer size used to read content from the
stream, by default 4096 bytes.
The InputStream
passed to the constructor is by default closed when is it fully
consumed (or when an exception is thrown while reading it), unless otherwise specified
to the constructor
.ContentProvider.Typed
Callback.Adapter
Constructor and Description |
---|
InputStreamContentProvider(InputStream stream) |
InputStreamContentProvider(InputStream stream,
int bufferSize) |
InputStreamContentProvider(InputStream stream,
int bufferSize,
boolean autoClose) |
Modifier and Type | Method and Description |
---|---|
void |
close() |
void |
failed(Throwable failure)
Callback invoked when the operation fails.
|
long |
getLength() |
Iterator<ByteBuffer> |
iterator() |
protected ByteBuffer |
onRead(byte[] buffer,
int offset,
int length)
Callback method invoked just after having read from the stream,
but before returning the iteration element (a
ByteBuffer
to the caller. |
protected void |
onReadFailure(Throwable failure)
Callback method invoked when an exception is thrown while reading
from the stream.
|
void |
succeeded()
Callback invoked when the operation completes.
|
public InputStreamContentProvider(InputStream stream)
public InputStreamContentProvider(InputStream stream, int bufferSize)
public InputStreamContentProvider(InputStream stream, int bufferSize, boolean autoClose)
public long getLength()
getLength
in interface ContentProvider
protected ByteBuffer onRead(byte[] buffer, int offset, int length)
ByteBuffer
to the caller.
Subclasses may override this method to copy the content read from
the stream to another location (a file, or in memory if the content
is known to fit).buffer
- the byte array containing the bytes readoffset
- the offset from where bytes should be readlength
- the length of the bytes readByteBuffer
wrapping the byte arrayprotected void onReadFailure(Throwable failure)
failure
- the exception thrown while reading from the stream.public Iterator<ByteBuffer> iterator()
iterator
in interface Iterable<ByteBuffer>
public void close()
close
in interface Closeable
close
in interface AutoCloseable
public void succeeded()
Callback
Callback invoked when the operation completes.
succeeded
in interface Callback
Callback.failed(Throwable)
Copyright © 1995-2015 Webtide. All Rights Reserved.