Module org.cojen.tupl

Package org.cojen.tupl.io

Class FilePageArray

java.lang.Object

org.cojen.tupl.io.PageArray

org.cojen.tupl.io.FilePageArray

All Implemented Interfaces:

Closeable, AutoCloseable, CauseCloseable

public class FilePageArray
extends PageArray

Basic PageArray implementation which accesses a file.

Constructor Summary

Constructors

Constructor	Description
FilePageArray(int pageSize, File file, EnumSet<OpenOption> options)
FilePageArray(int pageSize, FileIO fio)

Method Summary

Modifier and Type	Method	Description
void	close(Throwable cause)
int	directPageSize()	Returns a positive page size if not using direct I/O, else negate to get the page size to allocate for direct I/O.
void	expandPageCount(long count)	Attempt to expand the total count of pages.
boolean	isEmpty()
boolean	isReadOnly()
long	pageCount()	Returns the total count of pages in the array, or Long.MAX_VALUE if not applicable.
void	readPage(long index, byte[] dst, int offset, int length)
void	readPage(long index, long dstPtr, int offset, int length)
void	sync(boolean metadata)	Durably flushes all writes to the underlying device.
void	truncatePageCount(long count)	Attempt to truncate the total count of pages.
void	writePage(long index, byte[] src, int offset)	Writes a page, which is lazily flushed.
void	writePage(long index, long srcPtr, int offset)	Writes a page, which is lazily flushed.

Methods inherited from class org.cojen.tupl.io.PageArray

close, copyPage, copyPageFromPointer, directPagePointer, dirtyPage, evictPage, evictPage, isDirectIO, isFullyMapped, open, pageCountLimit, pageSize, readPage, readPage, syncPage, writePage, writePage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FilePageArray

public FilePageArray(int pageSize,
 File file,
 EnumSet<OpenOption> options)
              throws IOException

Throws:

IOException

FilePageArray

public FilePageArray(int pageSize,
 FileIO fio)

Method Details

directPageSize

public int directPageSize()

Description copied from class: PageArray

Returns a positive page size if not using direct I/O, else negate to get the page size to allocate for direct I/O.

Overrides:

directPageSize in class PageArray

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in class PageArray

isEmpty

public boolean isEmpty()
                throws IOException

Specified by:

isEmpty in class PageArray

Throws:

IOException

pageCount

public long pageCount()
               throws IOException

Description copied from class: PageArray

Returns the total count of pages in the array, or Long.MAX_VALUE if not applicable.

Specified by:

pageCount in class PageArray

Throws:

IOException

truncatePageCount

public void truncatePageCount(long count)
                       throws IOException

Description copied from class: PageArray

Attempt to truncate the total count of pages. Array implementation might not support truncating the page count, in which case this method does nothing.

Specified by:

truncatePageCount in class PageArray

Throws:

IOException

expandPageCount

public void expandPageCount(long count)
                     throws IOException

Description copied from class: PageArray

Attempt to expand the total count of pages. Array implementation might not support expanding the page count, in which case this method does nothing.

Specified by:

expandPageCount in class PageArray

Throws:

IOException

readPage

public void readPage(long index,
 byte[] dst,
 int offset,
 int length)
              throws IOException

Specified by:

readPage in class PageArray

Parameters:

index - zero-based page index to read

dst - receives read data

offset - offset into data buffer

Throws:

IOException - if index is greater than or equal to page count

readPage

public void readPage(long index,
 long dstPtr,
 int offset,
 int length)
              throws IOException

Overrides:

readPage in class PageArray

Parameters:

index - zero-based page index to read

dstPtr - receives read data

offset - offset into data buffer

Throws:

IOException - if index is greater than or equal to page count

writePage

public void writePage(long index,
 byte[] src,
 int offset)
               throws IOException

Description copied from class: PageArray

Writes a page, which is lazily flushed. The array grows automatically if the index is greater than or equal to the current page count. If array supports caching, page must be immediately copied into it.

Specified by:

writePage in class PageArray

Parameters:

index - zero-based page index to write

src - data to write

offset - offset into data buffer

Throws:

IOException

writePage

public void writePage(long index,
 long srcPtr,
 int offset)
               throws IOException

Description copied from class: PageArray

Writes a page, which is lazily flushed. The array grows automatically if the index is greater than or equal to the current page count. If array supports caching, page must be immediately copied into it.

Overrides:

writePage in class PageArray

Parameters:

index - zero-based page index to write

srcPtr - data to write

offset - offset into data buffer

Throws:

IOException

sync

public void sync(boolean metadata)
          throws IOException

Description copied from class: PageArray

Durably flushes all writes to the underlying device.

Specified by:

sync in class PageArray

Parameters:

metadata - pass true to flush all file metadata

Throws:

IOException

close

public void close(Throwable cause)
           throws IOException

Specified by:

close in interface CauseCloseable

Specified by:

close in class PageArray

Parameters:

cause - null if close is not caused by a failure

Throws:

IOException