bayou.file

Class FileByteSink

java.lang.Object

bayou.file.FileByteSink

All Implemented Interfaces:

ByteSink

public class FileByteSink
extends Object
implements ByteSink

A ByteSink that writes bytes to a file.

Constructor Summary

Constructors

Constructor and Description
FileByteSink(Path filePath) Create a FileByteSink.
FileByteSink(String filePath) Create a FileByteSink.

Method Summary

Instance Methods
Async<Void>	write(ByteBuffer bb) Write the bytes to this sink.
Async<Void>	error(Exception error) Set this sink to an error state.
Async<Void>	close() Close this sink.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileByteSink

public FileByteSink(Path filePath)

Create a FileByteSink.

FileByteSink

public FileByteSink(String filePath)

Create a FileByteSink.

Method Detail

write

public Async<Void> write(ByteBuffer bb)

Description copied from interface: ByteSink

Write the bytes to this sink.

If this action fails, the sink should be considered in an error state, and it should be closed immediately.

The ownership of `bb` is transferred to the sink. The sink should treat the content of `bb` as read-only.

CAUTION: since ByteBuffer is stateful (even for methods like ByteBuffer.get()), a new ByteBuffer must be created for each write() action. The caller may create a view of a shared ByteBuffer through ByteBuffer.asReadOnlyBuffer().

The app should wait for this write() action to complete before it calls another method on this sink.

Specified by:

write in interface ByteSink

error

public Async<Void> error(Exception error)

Description copied from interface: ByteSink

Set this sink to an error state.

If the data producer encounters an error, it should set the sink to an error state, so that the situation is not confused with a graceful termination of writing.

For example, a server app calculates data and writes them to an http response sink. If an exception occurs in the calculation, the app should call sink.error(), so that the client can know that the response body is corrupt.

If the sink is in an error state, it should be closed immediately.

This method can be called multiple times; only the first call is effective.

Specified by:

error in interface ByteSink

close

public Async<Void> close()

Description copied from interface: ByteSink

Close this sink.

If the sink is not in an error state, close() should flush all previously written data, and wait for the flushing to complete.

The close() action is important to finalize the writing process. If the close() action fails, it may indicate that the data are not reliably delivered to the destination.

This method can be called multiple times; only the first call is effective.

Specified by:

close in interface ByteSink