org.elasticsearch.common.io

Class FileSystemUtils

java.lang.Object

org.elasticsearch.common.io.FileSystemUtils

public final class FileSystemUtils
extends Object

Elasticsearch utils to work with Path

Method Summary

Modifier and Type	Method and Description
static Path	append(Path base, Path path, int strip) Appends the path to the given base and strips N elements off the path if strip is > 0.
static void	copyDirectoryRecursively(Path source, Path destination) Copy recursively a dir to a new location
static void	deleteSubDirectories(Path... paths) Deletes all subdirectories in the given path recursively
static boolean	exists(Path... files) Returns true iff one of the files exists otherwise false
static Path[]	files(Path directory) Returns an array of all files in the given directory.
static Path[]	files(Path from, DirectoryStream.Filter<Path> filter) Returns an array of all files in the given directory matching.
static Path[]	files(Path directory, String glob) Returns an array of all files in the given directory matching the glob.
static boolean	hasExtensions(Path root, String... extensions) Returns true iff a file under the given root has one of the given extensions.
static boolean	isAccessibleDirectory(Path directory, ESLogger logger) Check that a directory exists, is a directory and is readable by the current user
static boolean	isHidden(Path path) Check whether the file denoted by the given path is hidden.
static void	move(Path source, Path destination) Move or rename a file to a target file.
static void	moveFilesWithoutOverwriting(Path source, Path destination, String suffix) This utility copy a full directory content (excluded) under a new directory but without overwriting existing files.
static BufferedReader	newBufferedReader(URL url, Charset cs) Opens the given url for reading returning a BufferedReader that may be used to read text from the URL in an efficient manner.

Methods inherited from class java.lang.Object

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

Method Detail

hasExtensions

public static boolean hasExtensions(Path root,
                                    String... extensions)
                             throws IOException

Returns true iff a file under the given root has one of the given extensions. This method will travers directories recursively and will terminate once any of the extensions was found. This methods will not follow any links.

Parameters:

root - the root directory to travers. Must be a directory

extensions - the file extensions to look for

Returns:

true iff a file under the given root has one of the given extensions, otherwise false

Throws:

IOException - if an IOException occurs or if the given root path is not a directory.

exists

public static boolean exists(Path... files)

Returns true iff one of the files exists otherwise false

isHidden

public static boolean isHidden(Path path)

Check whether the file denoted by the given path is hidden. In practice, this will check if the file name starts with a dot. This should be preferred to Files.isHidden(Path) as this does not depend on the operating system.

append

public static Path append(Path base,
                          Path path,
                          int strip)

Appends the path to the given base and strips N elements off the path if strip is > 0.

deleteSubDirectories

public static void deleteSubDirectories(Path... paths)
                                 throws IOException

Deletes all subdirectories in the given path recursively

Throws:

IllegalArgumentException - if the given path is not a directory

IOException

isAccessibleDirectory

public static boolean isAccessibleDirectory(Path directory,
                                            ESLogger logger)

Check that a directory exists, is a directory and is readable by the current user

newBufferedReader

public static BufferedReader newBufferedReader(URL url,
                                               Charset cs)
                                        throws IOException

Opens the given url for reading returning a BufferedReader that may be used to read text from the URL in an efficient manner. Bytes from the file are decoded into characters using the specified charset.

Throws:

IOException

moveFilesWithoutOverwriting

public static void moveFilesWithoutOverwriting(Path source,
                                               Path destination,
                                               String suffix)
                                        throws IOException

This utility copy a full directory content (excluded) under a new directory but without overwriting existing files. When a file already exists in destination dir, the source file is copied under destination directory but with a suffix appended if set or source file is ignored if suffix is not set (null).

Parameters:

source - Source directory (for example /tmp/es/src)

destination - Destination directory (destination directory /tmp/es/dst)

suffix - When not null, files are copied with a suffix appended to the original name (eg: ".new") When null, files are ignored

Throws:

IOException

copyDirectoryRecursively

public static void copyDirectoryRecursively(Path source,
                                            Path destination)
                                     throws IOException

Copy recursively a dir to a new location

Parameters:

source - source dir

destination - destination dir

Throws:

IOException

move

public static void move(Path source,
                        Path destination)
                 throws IOException

Move or rename a file to a target file. This method supports moving a file from different filesystems (not supported by Files.move()).

Parameters:

source - source file

destination - destination file

Throws:

IOException

files

public static Path[] files(Path from,
                           DirectoryStream.Filter<Path> filter)
                    throws IOException

Returns an array of all files in the given directory matching.

Throws:

IOException

files

public static Path[] files(Path directory)
                    throws IOException

Returns an array of all files in the given directory.

Throws:

IOException

files

public static Path[] files(Path directory,
                           String glob)
                    throws IOException

Returns an array of all files in the given directory matching the glob.

Throws:

IOException