net.lecousin.framework.io

Class FileIO

java.lang.Object

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

net.lecousin.framework.io.FileIO

All Implemented Interfaces:

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

Direct Known Subclasses:

FileIO.ReadOnly, FileIO.ReadWrite, FileIO.WriteOnly

public abstract class FileIO
extends ConcurrentCloseable<IOException>
implements IO.KnownSize

IO on a file, using one of the 3 sub-classes: FileIO.ReadOnly, FileIO.WriteOnly, FileIO.ReadWrite.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileIO.ReadOnly FileIO in read-only mode.
static class	FileIO.ReadWrite FileIO with read and write operations.
static class	FileIO.WriteOnly FileIO in write-only mode.

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.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 FileAccess	file
protected long	position

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileIO(File file, String mode, byte priority)

Method Summary

Modifier and Type	Method and Description
IAsync<IOException>	canStart() Can start reading or writing.
protected void	closeResources(Async<IOException> ondone)
protected IAsync<IOException>	closeUnderlyingResources()
File	getFile()
protected long	getPosition()
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<Void,IOException>	setSizeAsync(long size)
protected void	setSizeSync(long size)
protected AsyncSupplier<Long,IOException>	skipAsync(long n, Consumer<Pair<Long,IOException>> ondone)
protected long	skipSync(long n)
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

file

protected FileAccess file

position

protected long position

Constructor Detail

FileIO

protected FileIO(File file,
                 String mode,
                 byte priority)

Method Detail

canStart

public IAsync<IOException> canStart()

Can start reading or writing.

getFile

public File getFile()

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

protected long getPosition()

seekSync

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

Throws:

IOException

seekAsync

protected AsyncSupplier<Long,IOException> seekAsync(IO.Seekable.SeekType type,
                                                    long move,
                                                    Consumer<Pair<Long,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)

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

setSizeSync

protected void setSizeSync(long size)
                    throws IOException

Throws:

IOException

setSizeAsync

protected AsyncSupplier<Void,IOException> setSizeAsync(long size)

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>

readSync

protected int readSync(ByteBuffer buffer)
                throws IOException

Throws:

IOException

readSync

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

Throws:

IOException

readAsync

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

readAsync

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

readFullySync

protected int readFullySync(ByteBuffer buffer)
                     throws IOException

Throws:

IOException

readFullySync

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

Throws:

IOException

readFullyAsync

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

readFullyAsync

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

writeSync

protected int writeSync(ByteBuffer buffer)
                 throws IOException

Throws:

IOException

writeSync

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

Throws:

IOException

writeAsync

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

writeAsync

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