net.sf.joafip.kvstore.service

Interface IFileForStorable

All Known Implementing Classes:

FileForStorable

public interface IFileForStorable

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
void	close() close heap file access operation
void	copy(FileForStorable fileForStorable) copy this file to an other file
void	copy(String fileName) copy this file to an other file
void	deleteFileIfExists() delete file if exists
void	deleteFileIfExistsRenaming() delete file if exists
void	flush() flush modification to disk
int	getCachePageSize()
File	getFile()
long	getFileSize() Returns the size of this file.
boolean	isUseCache()
void	open() open heap file for access operation
int	read(byte[] data) delegate to RandomAccessFile.read(byte[]) closing the file in case of I/O error Reads up to data.length bytes of data from this file into an array of bytes.
int	read(byte[] data, int offset, int length)
void	resetFileSize()
void	seek(long positionInFile) delegate to RandomAccessFile.seek(long) closing the file in case of I/O error
void	write(byte[] data) delegate to RandomAccessFile#write(byte[])) closing the file in case of I/O error
void	write(byte[] data, int offset, int length)
void	write(ToBackupRecord toBackupRecord)

Method Detail

getFileSize

long getFileSize()
                 throws HeapException

Returns the size of this file.

Returns:

the size of this file, measured in bytes.

Throws:

HeapException - if an I/O error occurs.

getFile

File getFile()

deleteFileIfExists

void deleteFileIfExists()
                        throws HeapException

delete file if exists

Throws:

HeapException

deleteFileIfExistsRenaming

void deleteFileIfExistsRenaming()
                                throws HeapException

delete file if exists

Throws:

HeapException

open

void open()
          throws HeapException

open heap file for access operation

Throws:

HeapException - if an I/O error occurs while opening file

flush

void flush()
           throws HeapException

flush modification to disk

Throws:

HeapException

resetFileSize

void resetFileSize()
                   throws HeapException

Throws:

HeapException

close

void close()
           throws HeapException

close heap file access operation

Throws:

HeapException - if an I/O error occurs while closing the the file

FileForStorableRuntimeException - file already closed

seek

void seek(long positionInFile)
          throws HeapException

delegate to RandomAccessFile.seek(long) closing the file in case of I/O error

Parameters:

positionInFile -

Throws:

HeapException - if an I/O error occurs

HeapRuntimeException - file closed

read

int read(byte[] data)
         throws HeapException

delegate to RandomAccessFile.read(byte[]) closing the file in case of I/O error
Reads up to data.length bytes of data from this file into an array of bytes.

Parameters:

data - where store data read

Returns:

number of bytes read

Throws:

HeapException - if an I/O error occurs

HeapRuntimeException - file closed

read

int read(byte[] data,
       int offset,
       int length)
         throws HeapException

Throws:

HeapException

write

void write(byte[] data)
           throws HeapException

delegate to RandomAccessFile#write(byte[])) closing the file in case of I/O error

Parameters:

data -

Throws:

HeapException - if an I/O error occurs

HeapRuntimeException - file closed

write

void write(byte[] data,
         int offset,
         int length)
           throws HeapException

Throws:

HeapException

write

void write(ToBackupRecord toBackupRecord)
           throws HeapException

Throws:

HeapException

copy

void copy(FileForStorable fileForStorable)
          throws HeapException

copy this file to an other file

Parameters:

fileForStorable -

Throws:

HeapException

copy

void copy(String fileName)
          throws FileIOException

copy this file to an other file

Parameters:

fileName -

Throws:

FileIOException

isUseCache

boolean isUseCache()

getCachePageSize

int getCachePageSize()