net.sf.joafip.kvstore.service

Class FileForStorable

java.lang.Object

net.sf.joafip.kvstore.service.FileForStorable

All Implemented Interfaces:

IFileForStorable

@NotStorableClass
public class FileForStorable
extends Object
implements IFileForStorable

to read/write class implementing IFileStorable to/from file.
open() and close()

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FAILED_DELETE_FILE
protected static String	FILE_ALREADY_CLOSED
protected static String	FILE_NOT_OPENNED
protected JoafipLogger	logger
protected IRandomAccessFile	randomAccessFile for random read write file access

Constructor Summary

Constructors

Constructor and Description
FileForStorable(FileAccessParameter fileAccessParameter) create a file to read from and write to IFileStorable object

Method Summary

Methods

Modifier and Type	Method and Description
void	close() close heap file access operation
protected HeapException	closeAfterIOException(String message, FileIOException exception) close after io exception
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	isOpened()
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	setFileSize(long newSize) set the size of this file
String	toString()
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)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final JoafipLogger logger

FILE_ALREADY_CLOSED

protected static final String FILE_ALREADY_CLOSED

See Also:

Constant Field Values

FILE_NOT_OPENNED

protected static final String FILE_NOT_OPENNED

See Also:

Constant Field Values

FAILED_DELETE_FILE

protected static final String FAILED_DELETE_FILE

See Also:

Constant Field Values

randomAccessFile

protected IRandomAccessFile randomAccessFile

for random read write file access

Constructor Detail

FileForStorable

public FileForStorable(FileAccessParameter fileAccessParameter)
                throws HeapException

create a file to read from and write to IFileStorable object

Parameters:

fileAccessParameter -

Throws:

HeapException

Method Detail

isUseCache

public boolean isUseCache()

Specified by:

isUseCache in interface IFileForStorable

getCachePageSize

public int getCachePageSize()

Specified by:

getCachePageSize in interface IFileForStorable

open

public void open()
          throws HeapException

Description copied from interface: IFileForStorable

open heap file for access operation

Specified by:

open in interface IFileForStorable

Throws:

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

close

public void close()
           throws HeapException

Description copied from interface: IFileForStorable

close heap file access operation

Specified by:

close in interface IFileForStorable

Throws:

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

flush

public void flush()
           throws HeapException

Description copied from interface: IFileForStorable

flush modification to disk

Specified by:

flush in interface IFileForStorable

Throws:

HeapException

resetFileSize

public void resetFileSize()
                   throws HeapException

Specified by:

resetFileSize in interface IFileForStorable

Throws:

HeapException

deleteFileIfExists

public void deleteFileIfExists()
                        throws HeapException

Description copied from interface: IFileForStorable

delete file if exists

Specified by:

deleteFileIfExists in interface IFileForStorable

Throws:

HeapException

deleteFileIfExistsRenaming

public void deleteFileIfExistsRenaming()
                                throws HeapException

Description copied from interface: IFileForStorable

delete file if exists

Specified by:

deleteFileIfExistsRenaming in interface IFileForStorable

Throws:

HeapException

isOpened

public boolean isOpened()

seek

public void seek(long positionInFile)
          throws HeapException

Description copied from interface: IFileForStorable

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

Specified by:

seek in interface IFileForStorable

Throws:

HeapException - if an I/O error occurs

read

public int read(byte[] data)
         throws HeapException

Description copied from interface: IFileForStorable

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.

Specified by:

read in interface IFileForStorable

Parameters:

data - where store data read

Returns:

number of bytes read

Throws:

HeapException - if an I/O error occurs

read

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

Specified by:

read in interface IFileForStorable

Throws:

HeapException

write

public void write(byte[] data)
           throws HeapException

Description copied from interface: IFileForStorable

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

Specified by:

write in interface IFileForStorable

Throws:

HeapException - if an I/O error occurs

write

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

Specified by:

write in interface IFileForStorable

Throws:

HeapException

write

public void write(ToBackupRecord toBackupRecord)
           throws HeapException

Specified by:

write in interface IFileForStorable

Throws:

HeapException

getFile

public File getFile()

Specified by:

getFile in interface IFileForStorable

getFileSize

public long getFileSize()
                 throws HeapException

Description copied from interface: IFileForStorable

Returns the size of this file.

Specified by:

getFileSize in interface IFileForStorable

Returns:

the size of this file, measured in bytes.

Throws:

HeapException - if an I/O error occurs.

setFileSize

public void setFileSize(long newSize)
                 throws HeapException

set the size of this file

Parameters:

newSize - the file new size

Throws:

HeapException - if an I/O error occurs.

copy

public void copy(FileForStorable fileForStorable)
          throws HeapException

Description copied from interface: IFileForStorable

copy this file to an other file

Specified by:

copy in interface IFileForStorable

Throws:

HeapException

copy

public void copy(String fileName)
          throws FileIOException

Description copied from interface: IFileForStorable

copy this file to an other file

Specified by:

copy in interface IFileForStorable

Throws:

FileIOException

closeAfterIOException

protected HeapException closeAfterIOException(String message,
                                  FileIOException exception)
                                       throws HeapException

close after io exception

Throws:

HeapException

toString

public String toString()

Overrides:

toString in class Object