com.terracottatech.offheapstore.filesystem

Interface File

All Known Implementing Classes:

OffheapFile

public interface File

This interface supports both reading and writing to a random access file. A random access file behaves like a large array of bytes stored in the OffHeap file system. There is a kind of cursor, or index into the implied array, called the file pointer; input operations read bytes starting at the file pointer and advance the file pointer past the bytes read. Output operations write bytes starting at the file pointer and advance the file pointer past the bytes written. Output operations that write past the current end of the implied array cause the array to be extended. The file pointer can be read by the getFilePointer method and set by the seek method.

Author:

dkumar

Method Summary

Modifier and Type	Method and Description
SeekableInputStream	getInputStream() Opens a stream for reading data from the file
String	getName() Returns the name of the file
SeekableOutputStream	getOutputStream() Opens a stream for writing data to a file.
long	getSizeInBytes() Returns the total size of the file in bytes
long	lastModifiedTime() Reports the last accessed or modified time for the file.
long	length() Reports the length of the file.
void	setLastModifiedTime(long time) Sets the last modified time for the file.
void	truncate() Erases the contents of the file and sets its length to 0

Method Detail

length

long length()
     throws IOException

Reports the length of the file.

Returns:

the length of this file, measured in bytes.

Throws:

IOException - if an I/O error occurs

lastModifiedTime

long lastModifiedTime()
               throws IOException

Reports the last accessed or modified time for the file.

Returns:

time when the file was last modified.

Throws:

IOException - if an I/O error occurs.

setLastModifiedTime

void setLastModifiedTime(long time)
                  throws IOException

Sets the last modified time for the file.

Parameters:

time - the time to set

Throws:

IOException - if an I/O error occurs.

getInputStream

SeekableInputStream getInputStream()
                            throws IOException

Opens a stream for reading data from the file

Returns:

a random access input stream.

Throws:

IOException - if an error occurs while processing the request.

getOutputStream

SeekableOutputStream getOutputStream()
                              throws IOException

Opens a stream for writing data to a file. Only one output stream can be associated with file at any time. Once an output stream is opened on a file, subsequent calls to this method will return the opened stream's cached reference.

Returns:

a random access output stream for writing data to a file.

Throws:

IOException - if an output stream is already open or if an I/O error occurs.

truncate

void truncate()
       throws IOException

Erases the contents of the file and sets its length to 0

Throws:

IOException - if an I/O error occurs.

getSizeInBytes

long getSizeInBytes()

Returns the total size of the file in bytes

Returns:

size in bytes

getName

String getName()

Returns the name of the file

Returns:

name of the file