net.lecousin.framework.io

Class PositionKnownWrapper<IOType extends IO>

java.lang.Object

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

net.lecousin.framework.io.PositionKnownWrapper<IOType>

Type Parameters:

IOType - type of IO

All Implemented Interfaces:

AutoCloseable, IO, IO.PositionKnown, AsyncCloseable<IOException>, CloseableListenable, IConcurrentCloseable<IOException>

Direct Known Subclasses:

PositionKnownWrapper.Readable, PositionKnownWrapper.Readable.Buffered

public abstract class PositionKnownWrapper<IOType extends IO>
extends ConcurrentCloseable<IOException>
implements IO.PositionKnown

Add the capability to known on which position we are on an IO.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PositionKnownWrapper.Readable Add the capability to known on which position we are on a Readable.

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

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

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

CloseableListenable.Impl

Field Summary

Fields

Modifier and Type	Field and Description
protected IOType	io
protected ListenableLongProperty	position

Constructor Summary

Constructors

Constructor and Description
PositionKnownWrapper(IOType io, long position) Constructor with initial position.

Method Summary

Modifier and Type	Method and Description
void	addPositionChangedListener(Consumer<Long> listener) Register a listener to be called when position is changing.
void	addPositionChangedListener(Runnable listener) Register a listener to be called when position is changing.
protected IAsync<IOException>	canStartReading()
protected void	closeResources(Async<IOException> ondone)
protected IAsync<IOException>	closeUnderlyingResources()
long	getPosition() Return the current position.
byte	getPriority() Return the priority.
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.
protected int	read()
protected int	read(byte[] buffer, int offset, int len)
protected int	readAsync()
protected AsyncSupplier<Integer,IOException>	readAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected int	readFully(byte[] buffer)
protected AsyncSupplier<Integer,IOException>	readFullyAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected int	readFullySync(ByteBuffer buffer)
protected AsyncSupplier<Integer,IOException>	readFullySyncIfPossible(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected ByteBuffer	readNextBuffer()
protected AsyncSupplier<ByteBuffer,IOException>	readNextBufferAsync(Consumer<Pair<ByteBuffer,IOException>> ondone)
protected int	readSync(ByteBuffer buffer)
void	removePositionChangedListener(Consumer<Long> listener) Remove the given listener.
void	removePositionChangedListener(Runnable listener) Remove the given listener.
void	setPriority(byte priority) Set the priority of asynchronous operations.
protected int	skip(int skip)
protected AsyncSupplier<Long,IOException>	skipAsync(long n, Consumer<Pair<Long,IOException>> ondone)
protected long	skipSync(long n)

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

cancelClosed, error, errorCancelled

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

Field Detail

io

protected IOType extends IO io

position

protected ListenableLongProperty position

Constructor Detail

PositionKnownWrapper

public PositionKnownWrapper(IOType io,
                            long position)

Constructor with initial position.

Method Detail

addPositionChangedListener

public void addPositionChangedListener(Consumer<Long> listener)

Register a listener to be called when position is changing.

addPositionChangedListener

public void addPositionChangedListener(Runnable listener)

Register a listener to be called when position is changing.

removePositionChangedListener

public void removePositionChangedListener(Consumer<Long> listener)

Remove the given listener.

removePositionChangedListener

public void removePositionChangedListener(Runnable listener)

Remove the given listener.

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

getPriority

public byte getPriority()

Description copied from class: ConcurrentCloseable

Return the priority.

Specified by:

getPriority in interface IO

Specified by:

getPriority in class ConcurrentCloseable<IOException>

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

getPosition

public long getPosition()

Description copied from interface: IO.PositionKnown

Return the current position.

Specified by:

getPosition in interface IO.PositionKnown

closeUnderlyingResources

protected IAsync<IOException> closeUnderlyingResources()

Specified by:

closeUnderlyingResources in class ConcurrentCloseable<IOException>

closeResources

protected void closeResources(Async<IOException> ondone)

Specified by:

closeResources in class ConcurrentCloseable<IOException>

canStartReading

protected IAsync<IOException> canStartReading()

readSync

protected int readSync(ByteBuffer buffer)
                throws IOException

Throws:

IOException

readAsync

protected int readAsync()
                 throws IOException

Throws:

IOException

readAsync

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

readFullySync

protected int readFullySync(ByteBuffer buffer)
                     throws IOException

Throws:

IOException

readFullyAsync

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

skipSync

protected long skipSync(long n)
                 throws IOException

Throws:

IOException

skipAsync

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

read

protected int read()
            throws IOException

Throws:

IOException

read

protected int read(byte[] buffer,
                   int offset,
                   int len)
            throws IOException

Throws:

IOException

readFully

protected int readFully(byte[] buffer)
                 throws IOException

Throws:

IOException

skip

protected int skip(int skip)
            throws IOException

Throws:

IOException

readNextBufferAsync

protected AsyncSupplier<ByteBuffer,IOException> readNextBufferAsync(Consumer<Pair<ByteBuffer,IOException>> ondone)

readNextBuffer

protected ByteBuffer readNextBuffer()
                             throws IOException

Throws:

IOException

readFullySyncIfPossible

protected AsyncSupplier<Integer,IOException> readFullySyncIfPossible(ByteBuffer buffer,
                                                                     Consumer<Pair<Integer,IOException>> ondone)