net.sf.joafip.file.service

Interface IRandomAccessFile

All Known Implementing Classes:

AbstractRandomAccessFile, RandomAccessFileDirect, RandomAccessFileDirectMapped, RandomAccessFileDirectNio, RandomAccessFileReadWriteCache

public interface IRandomAccessFile

interface for random access in file
cache is maintained in memory independently to file opened state or closed state. useful when closing and reopening the file to ensure the data are write, then data in cache reflecting file content is not loose

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
void	close() close the file
void	copy(String fileName) make copy of this file in other file
long	currentPositionInFile()
void	deleteIfExists() delete file if exist
void	deleteIfExistsRenaming()
boolean	differs(String fileName, SortedMap<Integer,Integer> diffMap)
void	flush() flush all modification on disk
File	getFile()
boolean	isClose()
boolean	isOpen()
long	length()
void	open() open the file
int	read(byte[] data)
int	read(byte[] data, int offset, int length)
void	seek(long positionInFile)
void	setLength(long newSize)
void	write(byte[] data)
void	write(byte[] data, int length)
void	write(byte[] data, int offset, int length)

Method Detail

getFile

File getFile()

open

void open()
          throws FileIOException

open the file

Throws:

FileIOException

close

void close()
           throws FileIOException

close the file

Throws:

FileIOException

isOpen

boolean isOpen()
               throws FileIOException

Throws:

FileIOException

isClose

boolean isClose()
                throws FileIOException

Throws:

FileIOException

flush

void flush()
           throws FileIOException

flush all modification on disk

Throws:

FileIOException

deleteIfExists

void deleteIfExists()
                    throws FileIOException

delete file if exist

Throws:

FileIOException

deleteIfExistsRenaming

void deleteIfExistsRenaming()
                            throws FileIOException

Throws:

FileIOException

seek

void seek(long positionInFile)
          throws FileIOException

Throws:

FileIOException

read

int read(byte[] data)
         throws FileIOException

Throws:

FileIOException

read

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

Throws:

FileIOException

write

void write(byte[] data)
           throws FileIOException

Throws:

FileIOException

write

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

Throws:

FileIOException

write

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

Throws:

FileIOException

currentPositionInFile

long currentPositionInFile()
                           throws FileIOException

Throws:

FileIOException

length

long length()
            throws FileIOException

Throws:

FileIOException

setLength

void setLength(long newSize)
               throws FileIOException

Throws:

FileIOException

copy

void copy(String fileName)
          throws FileIOException

make copy of this file in other file

Parameters:

fileName - the copy file name

Throws:

FileIOException

differs

boolean differs(String fileName,
              SortedMap<Integer,Integer> diffMap)
                throws FileIOException

Parameters:

fileName -

diffMap -

Returns:

true if files differs

Throws:

FileIOException