net.lecousin.framework.io

Class SubIO

java.lang.Object

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

net.lecousin.framework.io.SubIO

All Implemented Interfaces:

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

Direct Known Subclasses:

SubIO.Readable, SubIO.Readable.Seekable, SubIO.ReadWrite, SubIO.Writable, SubIO.Writable.Seekable

public abstract class SubIO
extends ConcurrentCloseable<IOException>
implements IO, IO.KnownSize, IO.PositionKnown

Sub-part of an IO.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubIO.Readable Sub-part of a Readable IO.
static class	SubIO.ReadWrite Sub-part of a Seekable Readable and Writable IO.
static class	SubIO.Writable Sub-part of a Writable IO.

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.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 boolean	closeContainer
protected String	description
protected IO	io
protected long	pos
protected long	size
protected long	start

Method Summary

Modifier and Type	Method and Description
protected IAsync<IOException>	canStartReading()
protected IAsync<IOException>	canStartWriting()
protected void	closeResources(Async<IOException> ondone)
protected IAsync<IOException>	closeUnderlyingResources()
long	getPosition() Return the current position.
byte	getPriority() Return the priority.
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.
protected AsyncSupplier<Integer,IOException>	readAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected AsyncSupplier<Integer,IOException>	readAsync(long pos, ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected AsyncSupplier<Integer,IOException>	readFullyAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected AsyncSupplier<Integer,IOException>	readFullyAsync(long pos, ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected int	readFullySync(ByteBuffer buffer)
protected int	readFullySync(long pos, ByteBuffer buffer)
protected int	readSync(ByteBuffer buffer)
protected int	readSync(long pos, ByteBuffer buffer)
protected AsyncSupplier<Long,IOException>	seekAsync(IO.Seekable.SeekType type, long move, Consumer<Pair<Long,IOException>> ondone)
protected long	seekSync(IO.Seekable.SeekType type, long move)
void	setPriority(byte priority) Set the priority of asynchronous operations.
protected AsyncSupplier<Integer,IOException>	writeAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected AsyncSupplier<Integer,IOException>	writeAsync(long pos, ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone)
protected int	writeSync(ByteBuffer buffer)
protected int	writeSync(long pos, ByteBuffer buffer)

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 IO io

pos

protected long pos

start

protected long start

size

protected long size

description

protected String description

closeContainer

protected boolean closeContainer

Method Detail

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

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

getTaskManager

public TaskManager getTaskManager()

Description copied from interface: IO

Return the TaskManager used for asynchronous operations.

Specified by:

getTaskManager 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

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>

getSizeSync

public long getSizeSync()

Description copied from interface: IO.KnownSize

Synchronous operation to get the size of the IO.

Specified by:

getSizeSync in interface IO.KnownSize

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

getPosition

public long getPosition()

Description copied from interface: IO.PositionKnown

Return the current position.

Specified by:

getPosition in interface IO.PositionKnown

canStartReading

protected IAsync<IOException> canStartReading()

readSync

protected int readSync(ByteBuffer buffer)
                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)

readSync

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

Throws:

IOException

readAsync

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

readFullySync

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

Throws:

IOException

readFullyAsync

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

seekSync

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

seekAsync

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

canStartWriting

protected IAsync<IOException> canStartWriting()

writeSync

protected int writeSync(ByteBuffer buffer)
                 throws IOException

Throws:

IOException

writeAsync

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

writeSync

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

Throws:

IOException

writeAsync

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