net.lecousin.framework.io

Class SubIO.ReadWrite

java.lang.Object

net.lecousin.framework.util.ConcurrentCloseable<IOException>

net.lecousin.framework.io.SubIO

net.lecousin.framework.io.SubIO.ReadWrite

All Implemented Interfaces:

AutoCloseable, IO, IO.KnownSize, IO.PositionKnown, IO.Readable, IO.Readable.Seekable, IO.Seekable, IO.Writable, IO.Writable.Seekable, IO.WriterAsync, AsyncCloseable<IOException>, CloseableListenable, IConcurrentCloseable<IOException>

Enclosing class:

SubIO

public static class SubIO.ReadWrite
extends SubIO
implements IO.Readable.Seekable, IO.Writable.Seekable

Sub-part of a Seekable Readable and Writable IO.

Nested Class Summary

Nested classes/interfaces inherited from class net.lecousin.framework.io.SubIO

SubIO.Readable, SubIO.ReadWrite, SubIO.Writable

Nested classes/interfaces inherited from interface net.lecousin.framework.io.IO.Readable

IO.Readable.Buffered, IO.Readable.Seekable

Nested classes/interfaces inherited from interface net.lecousin.framework.io.IO.Writable

IO.Writable.Buffered, IO.Writable.Seekable

Nested classes/interfaces inherited from interface net.lecousin.framework.io.IO.Seekable

IO.Seekable.SeekType

Field Summary

Fields inherited from class net.lecousin.framework.io.SubIO

closeContainer, description, io, pos, size, start

Constructor Summary

Constructors

Constructor and Description
ReadWrite(T src, long start, long size, String description, boolean closeSrcOnClose) Constructor.

Method Summary

Modifier and Type	Method and Description
IAsync<IOException>	canStartReading() Return a synchronization point that is unblocked when data is ready to be read.
IAsync<IOException>	canStartWriting() Return a synchronization point that is unblocked when data is ready to be written.
AsyncSupplier<Integer,IOException>	readAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Asynchronous read operation.
AsyncSupplier<Integer,IOException>	readAsync(long pos, ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Same as IO.Readable.readAsync(ByteBuffer, Consumer) but read at the given position.
AsyncSupplier<Integer,IOException>	readFullyAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Asynchronous read operation to fully fill the given buffer.
AsyncSupplier<Integer,IOException>	readFullyAsync(long pos, ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Same as IO.Readable.readFullyAsync(ByteBuffer, Consumer) but read at the given position.
int	readFullySync(ByteBuffer buffer) Synchronous read operation to fully fill the given buffer.
int	readFullySync(long pos, ByteBuffer buffer) Same as IO.Readable.readFullySync(ByteBuffer) but read at the given position.
int	readSync(ByteBuffer buffer) Read synchronously into the given buffer.
int	readSync(long pos, ByteBuffer buffer) Same as IO.Readable.readSync(ByteBuffer) but read at the given position.
AsyncSupplier<Long,IOException>	seekAsync(IO.Seekable.SeekType type, long move, Consumer<Pair<Long,IOException>> ondone) Returns the new position.
long	seekSync(IO.Seekable.SeekType type, long move) Returns the new position.
AsyncSupplier<Long,IOException>	skipAsync(long n, Consumer<Pair<Long,IOException>> ondone) Returns the number of bytes skipped.
long	skipSync(long n) Returns the number of bytes skipped.
AsyncSupplier<Integer,IOException>	writeAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Write asynchronously all bytes available in the given buffer at the current position.
AsyncSupplier<Integer,IOException>	writeAsync(long pos, ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Same as IO.Writable.writeAsync(ByteBuffer, Consumer) but at the given position.
int	writeSync(ByteBuffer buffer) Write synchronously all bytes available in the given buffer at the current position.
int	writeSync(long pos, ByteBuffer buffer) Same as IO.Writable.writeSync(ByteBuffer) but at the given position.

Methods inherited from class net.lecousin.framework.io.SubIO

closeResources, closeUnderlyingResources, getPosition, getPriority, getSizeAsync, getSizeSync, getSourceDescription, getTaskManager, getWrappedIO, setPriority

Methods inherited from class net.lecousin.framework.util.ConcurrentCloseable

addCloseListener, addCloseListener, close, closeAsync, isClosed, isClosing, lockClose, operation, operation, removeCloseListener, removeCloseListener, unlockClose

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lecousin.framework.io.IO.Readable.Seekable

readAsync, readFullyAsync

Methods inherited from interface net.lecousin.framework.io.IO.Readable

readAsync, readFullyAsync, skipAsync

Methods inherited from interface net.lecousin.framework.io.IO.Writable.Seekable

writeAsync

Methods inherited from interface net.lecousin.framework.io.IO.Writable

writeAsync

Methods inherited from interface net.lecousin.framework.io.IO.Seekable

seekAsync

Methods inherited from interface net.lecousin.framework.io.IO.PositionKnown

getPosition

Constructor Detail

ReadWrite

public ReadWrite(T src,
                 long start,
                 long size,
                 String description,
                 boolean closeSrcOnClose)

Constructor.

Method Detail

canStartReading

public IAsync<IOException> canStartReading()

Description copied from interface: IO.Readable

Return a synchronization point that is unblocked when data is ready to be read. This allows to start reading operations only when we know it won't block.

Specified by:

canStartReading in interface IO.Readable

Overrides:

canStartReading in class SubIO

readSync

public int readSync(long pos,
                    ByteBuffer buffer)
             throws IOException

Description copied from interface: IO.Readable.Seekable

Same as IO.Readable.readSync(ByteBuffer) but read at the given position. The current position is changed to the given position plus the number of bytes read.

Specified by:

readSync in interface IO.Readable.Seekable

Overrides:

readSync in class SubIO

Throws:

IOException

readSync

public int readSync(ByteBuffer buffer)
             throws IOException

Description copied from interface: IO.Readable

Read synchronously into the given buffer. The buffer may not be filled, but at least one byte is read. If there is no available byte, this method is blocking.

Specified by:

readSync in interface IO.Readable

Overrides:

readSync in class SubIO

Parameters:

buffer - buffer to fill

Returns:

the number of bytes read, or 0 or -1 if the end of the IO is reached.

Throws:

IOException

readAsync

public AsyncSupplier<Integer,IOException> readAsync(long pos,
                                                    ByteBuffer buffer,
                                                    Consumer<Pair<Integer,IOException>> ondone)

Description copied from interface: IO.Readable.Seekable

Same as IO.Readable.readAsync(ByteBuffer, Consumer) but read at the given position. The current position is changed to the given position plus the number of bytes read upon completion.

Specified by:

readAsync in interface IO.Readable.Seekable

Overrides:

readAsync in class SubIO

readAsync

public AsyncSupplier<Integer,IOException> readAsync(ByteBuffer buffer,
                                                    Consumer<Pair<Integer,IOException>> ondone)

Description copied from interface: IO.Readable

Asynchronous read operation. The buffer may not be filled, but at least one byte is read. If there is no available byte, the returned AsyncWork won't be unblocked until at least one byte is available, or we know that the end of the IO has been reached.

Specified by:

readAsync in interface IO.Readable

Overrides:

readAsync in class SubIO

Parameters:

buffer - buffer to fill

ondone - called before the returned AsyncWork is unblocked and its listeners are called.

Returns:

the Integer contains the number of bytes read, or 0 or -1 if the end of the IO is reached.

readFullySync

public int readFullySync(long pos,
                         ByteBuffer buffer)
                  throws IOException

Description copied from interface: IO.Readable.Seekable

Same as IO.Readable.readFullySync(ByteBuffer) but read at the given position. The current position is changed to the given position plus the number of bytes read.

Specified by:

readFullySync in interface IO.Readable.Seekable

Overrides:

readFullySync in class SubIO

Throws:

IOException

readFullySync

public int readFullySync(ByteBuffer buffer)
                  throws IOException

Description copied from interface: IO.Readable

Synchronous read operation to fully fill the given buffer. This method does not return until the buffer has been fully filled, or the end of the IO has been reached.

Specified by:

readFullySync in interface IO.Readable

Overrides:

readFullySync in class SubIO

Parameters:

buffer - the buffer to fill

Returns:

the number of bytes read, possibly 0 if the end of the IO has been reached.

Throws:

IOException

readFullyAsync

public AsyncSupplier<Integer,IOException> readFullyAsync(long pos,
                                                         ByteBuffer buffer,
                                                         Consumer<Pair<Integer,IOException>> ondone)

Description copied from interface: IO.Readable.Seekable

Same as IO.Readable.readFullyAsync(ByteBuffer, Consumer) but read at the given position. The current position is changed to the given position plus the number of bytes read upon completion.

Specified by:

readFullyAsync in interface IO.Readable.Seekable

Overrides:

readFullyAsync in class SubIO

readFullyAsync

public AsyncSupplier<Integer,IOException> readFullyAsync(ByteBuffer buffer,
                                                         Consumer<Pair<Integer,IOException>> ondone)

Description copied from interface: IO.Readable

Asynchronous read operation to fully fill the given buffer. The returned AsyncWork is not unblocked until the buffer has been fully filled, or the end of the IO has been reached.

Specified by:

readFullyAsync in interface IO.Readable

Overrides:

readFullyAsync in class SubIO

Parameters:

buffer - the buffer to fill

ondone - called before the returned AsyncWork is unblocked and its listeners are called.

Returns:

the Integer contains the number of bytes read, possibly 0 if the end of the IO has been reached.

seekSync

public long seekSync(IO.Seekable.SeekType type,
                     long move)

Description copied from interface: IO.Seekable

Returns the new position. The implementation must not allow to seek after the end of the file, the method setSize should be used instead. It must accept seeking beyond the end, but position at the end, and accept seeking before the beginning, but position at the beginning.

Specified by:

seekSync in interface IO.Seekable

Overrides:

seekSync in class SubIO

seekAsync

public AsyncSupplier<Long,IOException> seekAsync(IO.Seekable.SeekType type,
                                                 long move,
                                                 Consumer<Pair<Long,IOException>> ondone)

Description copied from interface: IO.Seekable

Returns the new position. The implementation must not allow to seek after the end of the file, the method setSize should be used instead. It must accept seeking beyond the end, but position at the end, and accept seeking before the beginning, but position at the beginning.

Specified by:

seekAsync in interface IO.Seekable

Overrides:

seekAsync in class SubIO

skipSync

public long skipSync(long n)

Description copied from interface: IO.Readable

Returns the number of bytes skipped.

Specified by:

skipSync in interface IO.Readable

skipAsync

public AsyncSupplier<Long,IOException> skipAsync(long n,
                                                 Consumer<Pair<Long,IOException>> ondone)

Description copied from interface: IO.Readable

Returns the number of bytes skipped.

Specified by:

skipAsync in interface IO.Readable

canStartWriting

public IAsync<IOException> canStartWriting()

Description copied from interface: IO.Writable

Return a synchronization point that is unblocked when data is ready to be written. This allows to start writing operations only when we know it won't block.

Specified by:

canStartWriting in interface IO.Writable

Overrides:

canStartWriting in class SubIO

writeSync

public int writeSync(long pos,
                     ByteBuffer buffer)
              throws IOException

Description copied from interface: IO.Writable.Seekable

Same as IO.Writable.writeSync(ByteBuffer) but at the given position. Note that if the IO implements Resizable, the behaviour is different when writing at the end or beyond the end of the IO: if not resizable, it must throw an exception, while a resizable IO should accept it except if the resize operation fails.

Specified by:

writeSync in interface IO.Writable.Seekable

Overrides:

writeSync in class SubIO

Throws:

IOException

writeSync

public int writeSync(ByteBuffer buffer)
              throws IOException

Description copied from interface: IO.Writable

Write synchronously all bytes available in the given buffer at the current position. If not all bytes can be written, an error must be thrown. Return the number of bytes written.

Specified by:

writeSync in interface IO.Writable

Overrides:

writeSync in class SubIO

Throws:

IOException

writeAsync

public AsyncSupplier<Integer,IOException> writeAsync(long pos,
                                                     ByteBuffer buffer,
                                                     Consumer<Pair<Integer,IOException>> ondone)

Description copied from interface: IO.Writable.Seekable

Same as IO.Writable.writeAsync(ByteBuffer, Consumer) but at the given position. Note that if the IO implements Resizable, the behaviour is different when writing at the end or beyond the end of the IO: if not resizable, it must throw an exception, while a resizable IO should accept it except if the resize operation fails.

Specified by:

writeAsync in interface IO.Writable.Seekable

Overrides:

writeAsync in class SubIO

writeAsync

public AsyncSupplier<Integer,IOException> writeAsync(ByteBuffer buffer,
                                                     Consumer<Pair<Integer,IOException>> ondone)

Description copied from interface: IO.Writable

Write asynchronously all bytes available in the given buffer at the current position. If not all bytes can be written, an error must be returned. Return the number of bytes written.

Specified by:

writeAsync in interface IO.Writable

Overrides:

writeAsync in class SubIO