bayou.bytes

Class SimpleByteSource

java.lang.Object

bayou.bytes.SimpleByteSource

All Implemented Interfaces:

ByteSource

public class SimpleByteSource
extends Object
implements ByteSource

A simple ByteSource based on some ByteBuffers.

Each SimpleByteSource is associated with a `Stream<ByteBuffer>`. The read() method simply serves the ByteBuffers from the stream.

Actually, read() serves a readonly view of the original ByteBuffer from the stream. The original ByteBuffer is not modified, therefore can be shared by multiple SimpleByteSources.

Constructor Summary

Constructors

Constructor and Description
SimpleByteSource(Stream<ByteBuffer> bbStream) Create a SimpleByteSource based on the stream of ByteBuffers.
SimpleByteSource(ByteBuffer bb) Create a SimpleByteSource based on a single ByteBuffer.
SimpleByteSource(byte[] bytes) Create a SimpleByteSource of the bytes.

Method Summary

Instance Methods
Async<ByteBuffer>	read() Read the next chunk of bytes.
Async<Void>	close() Close this source.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.bytes.ByteSource

asString, asString, readAll, skip, toSink

Constructor Detail

SimpleByteSource

public SimpleByteSource(Stream<ByteBuffer> bbStream)

Create a SimpleByteSource based on the stream of ByteBuffers.

CAUTION: the stream must be non-blocking in yielding its elements, i.e. the tryAdvance() method of its spliterator must be non-blocking.

SimpleByteSource

public SimpleByteSource(ByteBuffer bb)

Create a SimpleByteSource based on a single ByteBuffer.

Calling this constructor is equivalent to `new SimpleByteSource( Stream.of(bb) )`.

SimpleByteSource

public SimpleByteSource(byte[] bytes)

Create a SimpleByteSource of the bytes.

Calling this constructor is equivalent to `new SimpleByteSource( ByteBuffer.wrap(bytes) )`.

Method Detail

read

public Async<ByteBuffer> read()
                       throws IllegalStateException

Read the next chunk of bytes.

This method will serve the next ByteBuffer from the stream. Actually, a readonly view is served, so that the original ByteBuffer will not be touched.

Specified by:

read in interface ByteSource

Throws:

IllegalStateException - if this source is closed.

close

public Async<Void> close()

Close this source.

Specified by:

close in interface ByteSource