com.terracottatech.offheapstore.filesystem

Interface Directory

All Known Implementing Classes:

OffheapDirectory

public interface Directory

This interface facilitates creation of random access files in the OffHeap file system. It provides methods for querying the properties of the files, checking for their existence, deleting them, getting their length etc.

Author:

dkumar

Method Summary

Modifier and Type	Method and Description
void	deleteAllFiles() Deletes all files present under this directory
void	deleteFile(String name) Deletes a File.
boolean	fileExists(String name) Checks if a File exists in the directory
File	getOrCreateFile(String name) Creates a new, empty file or returns a reference to the named file if it already exists.
long	getSizeInBytes() Reports the total size of the directory
Set<String>	listFiles() Retrieves the names of files present in the directory

Method Detail

getOrCreateFile

File getOrCreateFile(String name)
              throws IOException

Creates a new, empty file or returns a reference to the named file if it already exists.

Parameters:

name - name of the File to be created

Returns:

reference to the new or existing file

Throws:

IOException - if an error occurred while processing the request.

deleteFile

void deleteFile(String name)
         throws IOException,
                FileNotFoundException

Deletes a File. This method will block until all the streams associated with the file have been closed.

Parameters:

name - of the file to be deleted.

Throws:

IOException - if an I/O error occurs.

FileNotFoundException - if the file is not found.

fileExists

boolean fileExists(String name)

Checks if a File exists in the directory

Parameters:

name - name of the file to be checked for existence.

Returns:

true if the file exists in the directory, false otherwise.

listFiles

Set<String> listFiles()
               throws IOException

Retrieves the names of files present in the directory

Returns:

set containing names of the files.

Throws:

IOException - if an error occurs while processing the request.

getSizeInBytes

long getSizeInBytes()

Reports the total size of the directory

Returns:

sum of sizes of files in bytes.

deleteAllFiles

void deleteAllFiles()
             throws IOException

Deletes all files present under this directory

Throws:

IOException - if an I/O error occurs