com.facebook.buck.io.file

Class MostFiles

java.lang.Object

com.facebook.buck.io.file.MostFiles

public final class MostFiles
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MostFiles.DeleteRecursivelyOptions

Field Summary

Fields

Modifier and Type	Field and Description
static long	S_IFDIR
static long	S_IFLNK
static long	S_IFREG

Method Summary

Modifier and Type	Method and Description
static boolean	concatenateFiles(Path dest, Iterable<Path> pathsToConcatenate) Concatenates the contents of one or more files.
static void	copyRecursively(Path fromPath, Path toPath) Recursively copies all files under fromPath to toPath.
static void	copyRecursively(Path fromPath, Path toPath, java.util.function.Function<Path,Path> transform) Recursively copies all files under fromPath to toPath.
static void	copyRecursively(Path fromPath, Path toPath, java.util.function.Function<Path,Path> transform, java.util.function.Function<Path,Boolean> filter)
static void	deleteRecursively(Path path)
static void	deleteRecursivelyIfExists(Path path)
static void	deleteRecursivelyWithOptions(Path path, EnumSet<MostFiles.DeleteRecursivelyOptions> options)
static void	makeExecutable(Path file) Tries to make the specified file executable.
static String	sanitize(String name) Given a file name, replace any illegal characters from it.
static void	sortFilesByAccessTime(File[] files) Does an in-place sort of the specified files array.
static void	writeLinesToFile(Iterable<String> lines, AbsPath file) Writes the specified lines to the specified file, encoded as UTF-8.
static void	writeLinesToFile(Iterable<String> lines, Path file) Writes the specified lines to the specified file, encoded as UTF-8.

Methods inherited from class java.lang.Object

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

Field Detail

S_IFDIR

public static final long S_IFDIR

See Also:

Constant Field Values

S_IFREG

public static final long S_IFREG

See Also:

Constant Field Values

S_IFLNK

public static final long S_IFLNK

See Also:

Constant Field Values

Method Detail

deleteRecursivelyIfExists

public static void deleteRecursivelyIfExists(Path path)
                                      throws IOException

Throws:

IOException

copyRecursively

public static void copyRecursively(Path fromPath,
                                   Path toPath)
                            throws IOException

Recursively copies all files under fromPath to toPath.

Throws:

IOException

copyRecursively

public static void copyRecursively(Path fromPath,
                                   Path toPath,
                                   java.util.function.Function<Path,Path> transform)
                            throws IOException

Recursively copies all files under fromPath to toPath. The transform will be applied after the destination path for a file has been relativized. This will remove any existing files in the toPath if there is a conflict.

Parameters:

fromPath - item to copy

toPath - destination of copy

transform - renaming function to apply when copying. If this function returns null, then the file is not copied.

Throws:

IOException

copyRecursively

public static void copyRecursively(Path fromPath,
                                   Path toPath,
                                   java.util.function.Function<Path,Path> transform,
                                   java.util.function.Function<Path,Boolean> filter)
                            throws IOException

Throws:

IOException

deleteRecursively

public static void deleteRecursively(Path path)
                              throws IOException

Throws:

IOException

deleteRecursivelyWithOptions

public static void deleteRecursivelyWithOptions(Path path,
                                                EnumSet<MostFiles.DeleteRecursivelyOptions> options)
                                         throws IOException

Throws:

IOException

writeLinesToFile

public static void writeLinesToFile(Iterable<String> lines,
                                    Path file)
                             throws IOException

Writes the specified lines to the specified file, encoded as UTF-8.

Throws:

IOException

writeLinesToFile

public static void writeLinesToFile(Iterable<String> lines,
                                    AbsPath file)
                             throws IOException

Writes the specified lines to the specified file, encoded as UTF-8.

Throws:

IOException

sortFilesByAccessTime

public static void sortFilesByAccessTime(File[] files)

Does an in-place sort of the specified files array. Most recently accessed files will be at the front of the array when sorted.

makeExecutable

public static void makeExecutable(Path file)
                           throws IOException

Tries to make the specified file executable. For file systems that do support the POSIX-style permissions, the executable permission is set for each category of users that already has the read permission.

If the file system does not support the executable permission or the operation fails, a java.io.IOException is thrown.

Throws:

IOException

sanitize

public static String sanitize(String name)

Given a file name, replace any illegal characters from it.

Parameters:

name - The file name to sanitize

Returns:

a properly sanitized filename

concatenateFiles

public static boolean concatenateFiles(Path dest,
                                       Iterable<Path> pathsToConcatenate)
                                throws IOException

Concatenates the contents of one or more files.

Parameters:

dest - The path to which the concatenated files' contents are written.

pathsToConcatenate - The paths whose contents are concatenated to dest.

Returns:

true if any data was concatenated to dest, false otherwise.

Throws:

IOException