org.neo4j.io.fs

Class FileUtils

java.lang.Object

org.neo4j.io.fs.FileUtils

public class FileUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileUtils.FileOperation
static interface	FileUtils.LineListener
static class	FileUtils.MaybeWindowsMemoryMappedFileReleaseProblem

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static OpenOption[]	convertOpenMode(String mode)
static void	copyFile(File srcFile, File dstFile)
static void	copyRecursively(File fromDirectory, File toDirectory)
static void	copyRecursively(File fromDirectory, File toDirectory, FileFilter filter)
static boolean	deleteFile(File file)
static void	deletePathRecursively(Path path)
static void	deleteRecursively(File directory)
static FileUtils.LineListener	echo(PrintStream target)
static String	fixSeparatorsInPath(String path)
static File	getMostCanonicalFile(File file)
static boolean	isEmptyDirectory(File directory) Check if directory is empty.
static void	moveFile(File toMove, File target) Utility method that moves a file from its current location to the new target location.
static File	moveFileToDirectory(File toMove, File targetDirectory) Utility method that moves a file from its current location to the provided target directory.
static BufferedReader	newBufferedFileReader(File file, Charset charset)
static PrintWriter	newFilePrintWriter(File file, Charset charset)
static FileChannel	open(Path path, String mode)
static InputStream	openAsInputStream(Path path)
static OutputStream	openAsOutputStream(Path path, boolean append)
static File	path(File root, String... path)
static File	path(String root, String... path)
static File	pathToFileAfterMove(File fromDir, File toDir, File fileToMove) Useful when you want to move a file from one directory to another by renaming the file and keep eventual sub directories.
static Path	pathToFileAfterMove(Path fromDir, Path toDir, Path fileToMove) Resolve toDir against fileToMove relativized against fromDir, resulting in a path denoting the location of fileToMove after being moved fromDir toDir.
static String	readTextFile(File file, Charset charset)
static void	readTextFile(File file, FileUtils.LineListener listener)
static String	relativePath(File baseDir, File storeFile) Given a directory and a path under it, return filename of the path relative to the directory.
static void	renameFile(File srcFile, File renameToFile, CopyOption... copyOptions)
static void	truncateFile(File file, long position)
static void	truncateFile(SeekableByteChannel fileChannel, long position)
static void	windowsSafeIOOperation(FileUtils.FileOperation operation)
static void	writeAll(FileChannel channel, ByteBuffer src)
static void	writeAll(FileChannel channel, ByteBuffer src, long position)
static void	writeToFile(File target, String text, boolean append)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileUtils

public FileUtils()

Method Detail

deleteRecursively

public static void deleteRecursively(File directory)
                              throws IOException

Throws:

IOException

deletePathRecursively

public static void deletePathRecursively(Path path)
                                  throws IOException

Throws:

IOException

deleteFile

public static boolean deleteFile(File file)

moveFile

public static void moveFile(File toMove,
                            File target)
                     throws IOException

Utility method that moves a file from its current location to the new target location. If rename fails (for example if the target is another disk) a copy/delete will be performed instead. This is not a rename, use renameFile(File, File, CopyOption...) instead.

Parameters:

toMove - The File object to move.

target - Target file to move to.

Throws:

IOException

moveFileToDirectory

public static File moveFileToDirectory(File toMove,
                                       File targetDirectory)
                                throws IOException

Utility method that moves a file from its current location to the provided target directory. If rename fails (for example if the target is another disk) a copy/delete will be performed instead. This is not a rename, use renameFile(File, File, CopyOption...) instead.

Parameters:

toMove - The File object to move.

targetDirectory - the destination directory

Returns:

the new file, null iff the move was unsuccessful

Throws:

IOException

renameFile

public static void renameFile(File srcFile,
                              File renameToFile,
                              CopyOption... copyOptions)
                       throws IOException

Throws:

IOException

truncateFile

public static void truncateFile(SeekableByteChannel fileChannel,
                                long position)
                         throws IOException

Throws:

IOException

truncateFile

public static void truncateFile(File file,
                                long position)
                         throws IOException

Throws:

IOException

fixSeparatorsInPath

public static String fixSeparatorsInPath(String path)

copyFile

public static void copyFile(File srcFile,
                            File dstFile)
                     throws IOException

Throws:

IOException

copyRecursively

public static void copyRecursively(File fromDirectory,
                                   File toDirectory)
                            throws IOException

Throws:

IOException

copyRecursively

public static void copyRecursively(File fromDirectory,
                                   File toDirectory,
                                   FileFilter filter)
                            throws IOException

Throws:

IOException

writeToFile

public static void writeToFile(File target,
                               String text,
                               boolean append)
                        throws IOException

Throws:

IOException

newBufferedFileReader

public static BufferedReader newBufferedFileReader(File file,
                                                   Charset charset)
                                            throws FileNotFoundException

Throws:

FileNotFoundException

newFilePrintWriter

public static PrintWriter newFilePrintWriter(File file,
                                             Charset charset)
                                      throws FileNotFoundException

Throws:

FileNotFoundException

path

public static File path(String root,
                        String... path)

path

public static File path(File root,
                        String... path)

pathToFileAfterMove

public static File pathToFileAfterMove(File fromDir,
                                       File toDir,
                                       File fileToMove)

Useful when you want to move a file from one directory to another by renaming the file and keep eventual sub directories. Example:

You want to move file /a/b1/c/d/file from /a/b1 to /a/b2 and keep the sub path /c/d/file.

 fileToMove = new File( "/a/b1/c/d/file" );
 fromDir = new File( "/a/b1" );
 toDir = new File( "/a/b2" );
 fileToMove.rename( pathToFileAfterMove( fromDir, toDir, fileToMove ) );
 // fileToMove.getAbsolutePath() -> /a/b2/c/d/file
 

Calls pathToFileAfterMove(Path, Path, Path) after transforming given files to paths by calling File.toPath().

NOTE: This that this does not perform the move, it only calculates the new file name.

Throws IllegalArgumentException is fileToMove is not a sub path to fromDir.

Parameters:

fromDir - Current parent directory for fileToMove

toDir - Directory denoting new parent directory for fileToMove after move

fileToMove - File denoting current location for fileToMove

Returns:

File denoting new abstract path for file after move.

pathToFileAfterMove

public static Path pathToFileAfterMove(Path fromDir,
                                       Path toDir,
                                       Path fileToMove)

Resolve toDir against fileToMove relativized against fromDir, resulting in a path denoting the location of fileToMove after being moved fromDir toDir.

NOTE: This that this does not perform the move, it only calculates the new file name.

Throws IllegalArgumentException is fileToMove is not a sub path to fromDir.

Parameters:

fromDir - Path denoting current parent directory for fileToMove

toDir - Path denoting location for fileToMove after move

fileToMove - Path denoting current location for fileToMove

Returns:

Path denoting new abstract path for file after move.

windowsSafeIOOperation

public static void windowsSafeIOOperation(FileUtils.FileOperation operation)
                                   throws IOException

Throws:

IOException

echo

public static FileUtils.LineListener echo(PrintStream target)

readTextFile

public static void readTextFile(File file,
                                FileUtils.LineListener listener)
                         throws IOException

Throws:

IOException

readTextFile

public static String readTextFile(File file,
                                  Charset charset)
                           throws IOException

Throws:

IOException

relativePath

public static String relativePath(File baseDir,
                                  File storeFile)
                           throws IOException

Given a directory and a path under it, return filename of the path relative to the directory.

Parameters:

baseDir - The base directory, containing the storeFile

storeFile - The store file path, must be contained under baseDir

Returns:

The relative path of storeFile to baseDir

Throws:

IOException - As per File.getCanonicalPath()

getMostCanonicalFile

public static File getMostCanonicalFile(File file)

writeAll

public static void writeAll(FileChannel channel,
                            ByteBuffer src,
                            long position)
                     throws IOException

Throws:

IOException

writeAll

public static void writeAll(FileChannel channel,
                            ByteBuffer src)
                     throws IOException

Throws:

IOException

convertOpenMode

public static OpenOption[] convertOpenMode(String mode)

open

public static FileChannel open(Path path,
                               String mode)
                        throws IOException

Throws:

IOException

openAsInputStream

public static InputStream openAsInputStream(Path path)
                                     throws IOException

Throws:

IOException

isEmptyDirectory

public static boolean isEmptyDirectory(File directory)
                                throws IOException

Check if directory is empty.

Parameters:

directory - - directory to check

Returns:

false if directory exists and empty, true otherwise.

Throws:

IllegalArgumentException - if specified directory represent a file

IOException - if some problem encountered during reading directory content

openAsOutputStream

public static OutputStream openAsOutputStream(Path path,
                                              boolean append)
                                       throws IOException

Throws:

IOException