com.terracottatech.offheapstore.filesystem

Interface FileSystem

All Known Implementing Classes:

OffheapFileSystem

public interface FileSystem

This interface provides top-level access to the OffHeap file system. It contains methods to create/delete directories, check for their existence etc.

It is generally true for the methods in this interface that an IOException will be thrown if the processing can not complete due to an I/O error caused due to events beyond programmers control.

Author:

dkumar

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the off heap file system with its directories and files and frees up the memory.
void	deleteDirectory(String name) Deletes a particular directory.
boolean	directoryExists(String name) Checks if a directory exists in the file system
Directory	getOrCreateDirectory(String name) Creates a new, empty directory or returns a reference to the named directory if it already exists.
Set<String>	listDirectories() Returns a listing of all directory names present in the system.

Method Detail

getOrCreateDirectory

Directory getOrCreateDirectory(String name)
                        throws IOException

Creates a new, empty directory or returns a reference to the named directory if it already exists. Nested directories are not allowed, hence a directory name of "foo/bar" will result in the creation of a directory named "foo/bar".

Parameters:

name - name of the directory to be created.

Returns:

a reference to the new or existing directory

Throws:

IOException - if an I/O error occurs.

listDirectories

Set<String> listDirectories()
                     throws IOException

Returns a listing of all directory names present in the system.

Returns:

a list containing names of the directories.

Throws:

IOException - if an I/O error occurs.

deleteDirectory

void deleteDirectory(String name)
              throws IOException,
                     FileNotFoundException

Deletes a particular directory.

Parameters:

name - of the directory to be deleted

Throws:

IOException - if an I/O error occurs.

FileNotFoundException - if the directory does not exist.

delete

void delete()
     throws IOException

Deletes the off heap file system with its directories and files and frees up the memory. If a directory creation operation is interleaved with this method, then the new directory may or may not be deleted.

Throws:

IOException - if an I/O error occurs.

directoryExists

boolean directoryExists(String name)
                 throws IOException

Checks if a directory exists in the file system

Parameters:

name - of the directory to check for existence

Returns:

true if the directory exists, false otherwise.

Throws:

IOException - if an I/O error occurs.