net.lecousin.framework.io.util

Class ReadableSeekableToDeterminedSize

java.lang.Object

net.lecousin.framework.io.util.ReadableSeekableToDeterminedSize

All Implemented Interfaces:

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

public class ReadableSeekableToDeterminedSize
extends Object
implements IO.Readable.Seekable, IO.KnownSize

Add the KnownSize capability: to determine the size, we can seek to the end and get the position.

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
ReadableSeekableToDeterminedSize(IO.Readable.Seekable io) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addCloseListener(Consumer<CloseableListenable> listener) Add a listener to be called once this resource is closed.
void	addCloseListener(Runnable listener) Add a listener to be called once this resource is closed.
IAsync<IOException>	canStartReading() Return a synchronization point that is unblocked when data is ready to be read.
void	close() Close.
IAsync<IOException>	closeAsync() Close asynchronously.
long	getPosition() Return the current position.
byte	getPriority() Return the priority of asynchronous operations.
AsyncSupplier<Long,IOException>	getSizeAsync() Asynchronous operation to get the size of the IO.
long	getSizeSync() Synchronous operation to get the size of the IO.
String	getSourceDescription() Describe the IO, which can be used for logging or debugging purposes.
TaskManager	getTaskManager() Return the TaskManager used for asynchronous operations.
IO	getWrappedIO() If this IO is wrapping another one (such as adding Buffered capabilities), this method returns it, or null if it does not wrap another IO.
boolean	isClosed() Return true if closed.
boolean	lockClose() Calling this method avoid this resource to be closed.
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.
void	removeCloseListener(Consumer<CloseableListenable> listener) Remove a listener.
void	removeCloseListener(Runnable listener) Remove a listener.
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.
void	setPriority(byte priority) Set the priority of asynchronous operations.
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.
void	unlockClose() Allow to close this resource, if this is the last lock on it.

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

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

closeAfter

Constructor Detail

ReadableSeekableToDeterminedSize

public ReadableSeekableToDeterminedSize(IO.Readable.Seekable io)

Constructor.

Method Detail

getSourceDescription

public String getSourceDescription()

Description copied from interface: IO

Describe the IO, which can be used for logging or debugging purposes.

Specified by:

getSourceDescription in interface IO

getWrappedIO

public IO getWrappedIO()

Description copied from interface: IO

If this IO is wrapping another one (such as adding Buffered capabilities), this method returns it, or null if it does not wrap another IO.

Specified by:

getWrappedIO in interface IO

close

public void close()
           throws Exception

Description copied from interface: CloseableListenable

Close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableListenable

Throws:

Exception

closeAsync

public IAsync<IOException> closeAsync()

Description copied from interface: AsyncCloseable

Close asynchronously.

Specified by:

closeAsync in interface AsyncCloseable<IOException>

isClosed

public boolean isClosed()

Description copied from interface: CloseableListenable

Return true if closed.

Specified by:

isClosed in interface CloseableListenable

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

addCloseListener

public void addCloseListener(Runnable listener)

Description copied from interface: CloseableListenable

Add a listener to be called once this resource is closed.

Specified by:

addCloseListener in interface CloseableListenable

addCloseListener

public void addCloseListener(Consumer<CloseableListenable> listener)

Description copied from interface: CloseableListenable

Add a listener to be called once this resource is closed.

Specified by:

addCloseListener in interface CloseableListenable

removeCloseListener

public void removeCloseListener(Runnable listener)

Description copied from interface: CloseableListenable

Remove a listener.

Specified by:

removeCloseListener in interface CloseableListenable

removeCloseListener

public void removeCloseListener(Consumer<CloseableListenable> listener)

Description copied from interface: CloseableListenable

Remove a listener.

Specified by:

removeCloseListener in interface CloseableListenable

lockClose

public boolean lockClose()

Description copied from interface: IConcurrentCloseable

Calling this method avoid this resource to be closed. For each call to this function, a call to the unlockClose method must be done.

Specified by:

lockClose in interface IConcurrentCloseable<IOException>

unlockClose

public void unlockClose()

Description copied from interface: IConcurrentCloseable

Allow to close this resource, if this is the last lock on it. If the close method was previously called but locked, the resource is closed.

Specified by:

unlockClose in interface IConcurrentCloseable<IOException>

getPriority

public byte getPriority()

Description copied from interface: IO

Return the priority of asynchronous operations.

Specified by:

getPriority in interface IO

setPriority

public void setPriority(byte priority)

Description copied from interface: IO

Set the priority of asynchronous operations.

Specified by:

setPriority in interface IO

getTaskManager

public TaskManager getTaskManager()

Description copied from interface: IO

Return the TaskManager used for asynchronous operations.

Specified by:

getTaskManager in interface IO

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

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

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

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

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

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

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

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

getPosition

public long getPosition()
                 throws IOException

Description copied from interface: IO.PositionKnown

Return the current position.

Specified by:

getPosition in interface IO.PositionKnown

Throws:

IOException

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

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

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

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

getSizeSync

public long getSizeSync()
                 throws IOException

Description copied from interface: IO.KnownSize

Synchronous operation to get the size of the IO.

Specified by:

getSizeSync in interface IO.KnownSize

Throws:

IOException

getSizeAsync

public AsyncSupplier<Long,IOException> getSizeAsync()

Description copied from interface: IO.KnownSize

Asynchronous operation to get the size of the IO.

Specified by:

getSizeAsync in interface IO.KnownSize