net.lecousin.framework.io

Interface IO.Seekable

All Superinterfaces:

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

All Known Subinterfaces:

IO.Readable.Seekable, IO.Writable.Seekable

All Known Implementing Classes:

BufferedIO, BufferedIO.ReadWrite, ByteArrayIO, ByteBuffersIO, EmptyReadable, FileIO.ReadOnly, FileIO.ReadWrite, FileIO.WriteOnly, FragmentedSubIO, FragmentedSubIO.Readable, FragmentedSubIO.ReadWrite, IOInMemoryOrFile, LinkedIO.Readable.Seekable, LinkedIO.Readable.Seekable.Buffered, LinkedIO.Readable.Seekable.Buffered.DeterminedSize, LinkedIO.Readable.Seekable.DeterminedSize, LinkedIO.ReadWrite, MemoryIO, OutputToInput, ReadableSeekableToDeterminedSize, ReadableToSeekable, SubIO.Readable.Seekable, SubIO.Readable.Seekable.Buffered, SubIO.ReadWrite, SubIO.Writable.Seekable, TwoBuffersIO, TwoBuffersIO.DeterminedSize

Enclosing interface:

IO

public static interface IO.Seekable
extends IO.PositionKnown

Capability to set the position on an IO.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IO.Seekable.SeekType List of possible seek operations.

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

Method Summary

Modifier and Type	Method and Description
default AsyncSupplier<Long,IOException>	seekAsync(IO.Seekable.SeekType type, long move) Returns the new 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.

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

getPosition

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

Method Detail

seekSync

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

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.

Throws:

IOException

seekAsync

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

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.

seekAsync

default AsyncSupplier<Long,IOException> seekAsync(IO.Seekable.SeekType type,
                                                  long move)

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.