org.expath.pkg.repo

Class FileHelper

java.lang.Object

org.expath.pkg.repo.FileHelper

public class FileHelper
extends java.lang.Object

Centralize some file-related utilities.

Author:

Florent Georges

Constructor Summary

Constructors

Constructor and Description
FileHelper()

Method Summary

Modifier and Type	Method and Description
static void	copy(java.nio.file.Path source, java.nio.file.Path destination) Copies a path within the filesystem If the path is a directory its contents will be recursively copied.
static boolean	deleteQuietly(java.nio.file.Path path)
static void	ensureDir(java.nio.file.Path dir) Create a directory if it does not exist yet.
static boolean	isEmpty(java.nio.file.Path directory)
static java.util.List<java.nio.file.Path>	list(java.nio.file.Path directory) A list of the entries in the directory.
static java.nio.file.Path	makeTempDir(java.lang.String prefix, java.nio.file.Path parent) Create a new directory within parent.
static void	renameTmpDir(java.nio.file.Path from, java.nio.file.Path to)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileHelper

public FileHelper()

Method Detail

ensureDir

public static void ensureDir(java.nio.file.Path dir)
                      throws PackageException

Create a directory if it does not exist yet. Throw an error if the directory already exists and is not actually a directory, or if there is an error creating it.

Parameters:

dir - the directory path

Throws:

PackageException - if an error occurs

makeTempDir

public static java.nio.file.Path makeTempDir(java.lang.String prefix,
                                             java.nio.file.Path parent)
                                      throws PackageException

Create a new directory within parent. The new directory is empty, and its name is based on prefix, and on the current date after the prefix.

Parameters:

prefix - the prefix for the temporary directory

parent - the directory in which to create the temporary directory

Returns:

the path to the temporary directory.

Throws:

PackageException - if an error occurs

renameTmpDir

public static void renameTmpDir(java.nio.file.Path from,
                                java.nio.file.Path to)
                         throws PackageException

Throws:

PackageException

copy

public static void copy(java.nio.file.Path source,
                        java.nio.file.Path destination)
                 throws java.io.IOException

Copies a path within the filesystem If the path is a directory its contents will be recursively copied. Note that copying of a directory is not an atomic-operation and so if an error occurs during copying, some of the directories descendants may have already been copied.

Parameters:

source - the source file or directory

destination - the destination file or directory

Throws:

java.io.IOException - if an error occurs whilst copying a file or directory

deleteQuietly

public static boolean deleteQuietly(java.nio.file.Path path)

list

public static java.util.List<java.nio.file.Path> list(java.nio.file.Path directory)
                                               throws java.io.IOException

A list of the entries in the directory. The listing is not recursive.

Parameters:

directory - The directory to list the entries for

Returns:

The list of entries

Throws:

java.io.IOException - if the an error occurs whilst listing the directories

isEmpty

public static boolean isEmpty(java.nio.file.Path directory)