Package one.microstream.afs.types

Interface AReadableFile

All Superinterfaces:

AFile, AFile.Wrapper, AItem, AItem.Wrapper

All Known Subinterfaces:

AWritableFile, NioReadableFile, NioWritableFile, SqlReadableFile, SqlWritableFile

All Known Implementing Classes:

NioReadableFile.Default, NioWritableFile.Default, SqlReadableFile.Default, SqlWritableFile.Default

public interface AReadableFile
extends AFile.Wrapper

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.afs.types.AFile

AFile.Default, AFile.Observer, AFile.Wrapper

Nested classes/interfaces inherited from interface one.microstream.afs.types.AFile.Wrapper

AFile.Wrapper.Abstract<U>

Nested classes/interfaces inherited from interface one.microstream.afs.types.AItem

AItem.Base, AItem.Wrapper

Method Summary

Modifier and Type	Method	Description
default boolean	close()
default long	copyTo(AWritableFile target)
default long	copyTo(AWritableFile target, long sourcePosition)
default long	copyTo(AWritableFile target, long sourcePosition, long length)
default boolean	isOpen()
boolean	isRetired()
default boolean	open()
default ByteBuffer	readBytes()
default ByteBuffer	readBytes(long position)
default ByteBuffer	readBytes(long position, long length)
default long	readBytes(ByteBuffer targetBuffer)
default long	readBytes(ByteBuffer targetBuffer, long position)
default long	readBytes(ByteBuffer targetBuffer, long position, long length)
default long	readBytes(BufferProvider bufferProvider)
default long	readBytes(BufferProvider bufferProvider, long position)
default long	readBytes(BufferProvider bufferProvider, long position, long length)
default boolean	release()
boolean	retire()
default long	size()	Returns the size in bytes of this file's content, without any space required for file metadata (name etc.).
void	validateIsNotRetired()

Methods inherited from interface one.microstream.afs.types.AFile

defaultUser, ensureExists, exists, isEmpty, isUsed, iterateObservers, name, registerObserver, removeObserver, toPath, toPathString, tryUseReading, tryUseReading, tryUseWriting, tryUseWriting, type, useReading, useReading, useWriting, useWriting

Methods inherited from interface one.microstream.afs.types.AFile.Wrapper

actual

Methods inherited from interface one.microstream.afs.types.AItem

fileSystem, identifier, parent

Methods inherited from interface one.microstream.afs.types.AItem.Wrapper

user

Method Details

open

default boolean open()

isOpen

default boolean isOpen()

close

default boolean close()

release

default boolean release()

size

default long size()

Description copied from interface: AFile

Returns the size in bytes of this file's content, without any space required for file metadata (name etc.).

Specified by:

size in interface AFile

Returns:

the size in bytes of this file's content.

readBytes

default ByteBuffer readBytes()

readBytes

default ByteBuffer readBytes(long position)

readBytes

default ByteBuffer readBytes(long position, long length)

readBytes

default long readBytes(ByteBuffer targetBuffer)

readBytes

default long readBytes(ByteBuffer targetBuffer, long position)

readBytes

default long readBytes(ByteBuffer targetBuffer, long position, long length)

readBytes

default long readBytes(BufferProvider bufferProvider)

readBytes

default long readBytes(BufferProvider bufferProvider, long position)

readBytes

default long readBytes(BufferProvider bufferProvider, long position, long length)

copyTo

default long copyTo(AWritableFile target)

copyTo

default long copyTo(AWritableFile target, long sourcePosition)

copyTo

default long copyTo(AWritableFile target, long sourcePosition, long length)

retire

boolean retire()

isRetired

boolean isRetired()

validateIsNotRetired

void validateIsNotRetired()