org.neo4j.io.fs

Interface FileSystemAbstraction

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DefaultFileSystemAbstraction, DelegateFileSystemAbstraction

public interface FileSystemAbstraction
extends Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FileSystemAbstraction.ThirdPartyFileSystem

Method Summary

Modifier and Type	Method and Description
void	copyFile(File from, File to)
void	copyRecursively(File fromDirectory, File toDirectory)
StoreChannel	create(File fileName)
boolean	deleteFile(File fileName)
void	deleteFileOrThrow(File file)
void	deleteRecursively(File directory)
boolean	fileExists(File fileName)
FileWatcher	fileWatcher() Create file watcher that provides possibilities to monitor directories on underlying file system abstraction
long	getFileSize(File fileName)
<K extends FileSystemAbstraction.ThirdPartyFileSystem> K	getOrCreateThirdPartyFileSystem(Class<K> clazz, Function<Class<K>,K> creator)
boolean	isDirectory(File file)
long	lastModifiedTime(File file)
File[]	listFiles(File directory)
File[]	listFiles(File directory, FilenameFilter filter)
boolean	mkdir(File fileName)
void	mkdirs(File fileName)
void	moveToDirectory(File file, File toDirectory)
StoreChannel	open(File fileName, String mode)
InputStream	openAsInputStream(File fileName)
OutputStream	openAsOutputStream(File fileName, boolean append)
Reader	openAsReader(File fileName, Charset charset)
Writer	openAsWriter(File fileName, Charset charset, boolean append)
void	renameFile(File from, File to, CopyOption... copyOptions)
Stream<FileHandle>	streamFilesRecursive(File directory) Return a stream of file handles for every file in the given directory, and its sub-directories.
void	truncate(File path, long size)

Methods inherited from interface java.io.Closeable

close

Method Detail

fileWatcher

FileWatcher fileWatcher()
                 throws IOException

Create file watcher that provides possibilities to monitor directories on underlying file system abstraction

Returns:

specific file system abstract watcher

Throws:

IOException - in case exception occur during file watcher creation

open

StoreChannel open(File fileName,
                  String mode)
           throws IOException

Throws:

IOException

openAsOutputStream

OutputStream openAsOutputStream(File fileName,
                                boolean append)
                         throws IOException

Throws:

IOException

openAsInputStream

InputStream openAsInputStream(File fileName)
                       throws IOException

Throws:

IOException

openAsReader

Reader openAsReader(File fileName,
                    Charset charset)
             throws IOException

Throws:

IOException

openAsWriter

Writer openAsWriter(File fileName,
                    Charset charset,
                    boolean append)
             throws IOException

Throws:

IOException

create

StoreChannel create(File fileName)
             throws IOException

Throws:

IOException

fileExists

boolean fileExists(File fileName)

mkdir

boolean mkdir(File fileName)

mkdirs

void mkdirs(File fileName)
     throws IOException

Throws:

IOException

getFileSize

long getFileSize(File fileName)

deleteFile

boolean deleteFile(File fileName)

deleteRecursively

void deleteRecursively(File directory)
                throws IOException

Throws:

IOException

renameFile

void renameFile(File from,
                File to,
                CopyOption... copyOptions)
         throws IOException

Throws:

IOException

listFiles

File[] listFiles(File directory)

listFiles

File[] listFiles(File directory,
                 FilenameFilter filter)

isDirectory

boolean isDirectory(File file)

moveToDirectory

void moveToDirectory(File file,
                     File toDirectory)
              throws IOException

Throws:

IOException

copyFile

void copyFile(File from,
              File to)
       throws IOException

Throws:

IOException

copyRecursively

void copyRecursively(File fromDirectory,
                     File toDirectory)
              throws IOException

Throws:

IOException

getOrCreateThirdPartyFileSystem

<K extends FileSystemAbstraction.ThirdPartyFileSystem> K getOrCreateThirdPartyFileSystem(Class<K> clazz,
                                                                                         Function<Class<K>,K> creator)

truncate

void truncate(File path,
              long size)
       throws IOException

Throws:

IOException

lastModifiedTime

long lastModifiedTime(File file)
               throws IOException

Throws:

IOException

deleteFileOrThrow

void deleteFileOrThrow(File file)
                throws IOException

Throws:

IOException

streamFilesRecursive

Stream<FileHandle> streamFilesRecursive(File directory)
                                 throws IOException

Return a stream of file handles for every file in the given directory, and its sub-directories.

Alternatively, if the File given as an argument refers to a file instead of a directory, then a stream will be returned with a file handle for just that file.

The stream is based on a snapshot of the file tree, so changes made to the tree using the returned file handles will not be reflected in the stream.

No directories will be returned. Only files. If a file handle ends up leaving a directory empty through a rename or a delete, then the empty directory will automatically be deleted as well. Likewise, if a file is moved to a path where not all of the directories in the path exists, then those missing directories will be created prior to the file rename.

Parameters:

directory - The base directory to start streaming files from, or the specific individual file to stream.

Returns:

A stream of all files in the tree.

Throws:

NoSuchFileException - If the given base directory or file does not exists.

IOException - If an I/O error occurs, possibly with the canonicalisation of the paths.