bayou.file

Class FileByteSource

java.lang.Object

bayou.file.FileByteSource

All Implemented Interfaces:

ByteSource

public class FileByteSource
extends Object
implements ByteSource

A source of bytes from a file.

Example Usage:

     ByteSource src = new FileByteSource("/tmp/data.bin");

     AsyncIterator.forEach( src::read, System.out::println )
         .finally_( src::close );
 

Each FileByteSource depends on an AsynchronousFileChannel, obtained from a FileByteSource.ChannelProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileByteSource.ChannelProvider Provider of AsynchronousFileChannel for FileByteSource.

Constructor Summary

Constructors

Constructor and Description
FileByteSource(Path filePath) Create a FileByteSource.
FileByteSource(String filePath) Create a FileByteSource.
FileByteSource(FileByteSource.ChannelProvider channelProvider) Create a FileByteSource.

Method Summary

Instance Methods
long	skip(long n) Try to skip forward `n` bytes.
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, toSink

Constructor Detail

FileByteSource

public FileByteSource(Path filePath)

Create a FileByteSource.

FileByteSource

public FileByteSource(String filePath)

Create a FileByteSource.

FileByteSource

public FileByteSource(FileByteSource.ChannelProvider channelProvider)

Create a FileByteSource.

The `channelProvider` will provide an `AsynchronousFileChannel` for this source.

Method Detail

skip

public long skip(long n)
          throws IllegalArgumentException,
                 IllegalStateException

Try to skip forward `n` bytes.

Specified by:

skip in interface ByteSource

Parameters:

n - number of bytes to skip; n >= 0.

Returns:

number of bytes (m) actually skipped. 0 <= m <= n.

Throws:

IllegalStateException - if this source is closed.

IllegalArgumentException - if n < 0.

read

public Async<ByteBuffer> read()
                       throws IllegalStateException

Read the next chunk of bytes.

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