net.lecousin.framework.io

Class FileIO.ReadOnly

java.lang.Object

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

net.lecousin.framework.io.FileIO

net.lecousin.framework.io.FileIO.ReadOnly

All Implemented Interfaces:

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

Enclosing class:

FileIO

public static class FileIO.ReadOnly
extends FileIO
implements IO.Readable.Seekable

FileIO in read-only mode.

Nested Class Summary

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

FileIO.ReadOnly, FileIO.ReadWrite, FileIO.WriteOnly

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.Seekable

IO.Seekable.SeekType

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

IO.KnownSize, IO.OperationType, IO.OutputToInput, IO.PositionKnown, IO.Readable, IO.ReadableByteStream, IO.Resizable, IO.Writable, IO.WritableByteStream, IO.WriterAsync

Nested classes/interfaces inherited from interface net.lecousin.framework.util.CloseableListenable

CloseableListenable.Impl

Field Summary

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

file, position

Constructor Summary

Constructors

Constructor and Description
ReadOnly(File file, byte priority) 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.
long	getPosition() Return the current position.
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.

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

canStart, closeResources, closeUnderlyingResources, getFile, getPriority, getSizeAsync, getSizeSync, getSourceDescription, getTaskManager, getWrappedIO, setPriority, setSizeAsync, setSizeSync, writeAsync, writeAsync, writeSync, writeSync

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.Seekable

seekAsync

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

cancelClosed, error, errorCancelled, getPriority, getSourceDescription, getTaskManager, getWrappedIO, setPriority

Methods inherited from interface net.lecousin.framework.util.IConcurrentCloseable

lockClose, unlockClose

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface net.lecousin.framework.util.AsyncCloseable

closeAfter, closeAsync

Methods inherited from interface net.lecousin.framework.util.CloseableListenable

addCloseListener, addCloseListener, close, isClosed, removeCloseListener, removeCloseListener

Constructor Detail

ReadOnly

public ReadOnly(File file,
                byte priority)

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

getPosition

public long getPosition()

Description copied from interface: IO.PositionKnown

Return the current position.

Specified by:

getPosition in interface IO.PositionKnown

Overrides:

getPosition in class FileIO

seekSync

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

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 FileIO

Throws:

IOException

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 FileIO

skipSync

public long skipSync(long n)
              throws IOException

Description copied from interface: IO.Readable

Returns the number of bytes skipped.

Specified by:

skipSync in interface IO.Readable

Overrides:

skipSync in class FileIO

Throws:

IOException

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

Overrides:

skipAsync in class FileIO

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 FileIO

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

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 FileIO

Throws:

IOException

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 FileIO

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.

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 FileIO

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 FileIO

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

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 FileIO

Throws:

IOException

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 FileIO

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.

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 FileIO