MoreFiles (Giraffe 0.9.0)

java.lang.Object
- com.palantir.giraffe.file.MoreFiles

```
public final class MoreFiles
extends Object
```
Provides static methods that extend the functionality provided by Files.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addPermission(Path path, PosixFilePermission permission)` Adds a permission to a file or directory.
`static void`	`addPermissionRecursive(Path path, PosixFilePermission permission)` Recursively adds a permission to a directory.
`static void`	`copyLarge(Path source, Path target)` Copy a file to a target file in an efficient way.
`static void`	`copyRecursive(Path source, Path target)` Copy a path to a target path recursively.
`static Path`	`defaultDirectory(FileSystem fs)` Returns the default directory for the given file system.
`static void`	`deleteRecursive(Path path)` Deletes a path recursively.
`static boolean`	`deleteRecursiveIfExists(Path path)` Deletes a path recursively if it exists.
`static DirectoryStream.Filter<Path>`	`directoryFilter()` Returns a directory filter that matches directories.
`static boolean`	`isEmpty(Path path)` Test if the given path is empty.
`static boolean`	`isLocal(Path path)` Determines if the given path is associated with the default (local) file system.
`static List<Path>`	`listDirectory(Path dir)` Gets a list of the files and directories in the given directory.
`static List<Path>`	`listDirectoryFiles(Path dir)` Gets a list of the files in the given directory.
`static List<Path>`	`listDirectoryFilesRecursive(Path dir)` Gets a list of the files in the given directory and all sub-directories.
`static List<Path>`	`listDirectoryRecursive(Path dir)` Gets a list of the files and directories in the given directory and all sub-directories.
`static String`	`readAllString(Path path, Charset cs)` Reads the contents of a file as a string.
`static DirectoryStream.Filter<Path>`	`regularFileFilter()` Returns a directory filter that matches regular files.
`static void`	`removePermission(Path path, PosixFilePermission permission)` Removes a permission from a file or directory.
`static void`	`removePermissionRecursive(Path path, PosixFilePermission permission)` Recursively removes a permission from a directory.
`static void`	`setExecutable(Path path)` Adds the `OWNER_EXECUTE` permission to a file or directory.
`static void`	`setPermissionRecursive(Path path, Set<PosixFilePermission> permissions)` Recursively sets permissions for a directory.
`static Path`	`write(Path path, String string, Charset cs, OpenOption... options)` Writes a string to a file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - regularFileFilter
```
public static DirectoryStream.Filter<Path> regularFileFilter()
```
    Returns a directory filter that matches regular files.
  - directoryFilter
```
public static DirectoryStream.Filter<Path> directoryFilter()
```
    Returns a directory filter that matches directories.
  - deleteRecursive
```
public static void deleteRecursive(Path path)
                            throws IOException
```
    Deletes a path recursively.
    If the path is a file or an empty directory, this method is equivalent to Files.delete(Path). If the path is a non-empty directory, the directory, all sub-directories, and all child files are deleted.
    This operation is not atomic with respect to other file system operations. As a result, the path may be left in a partially-deleted state if this method fails.
    
    Parameters:
    
    path - the path to delete
    
    Throws:
    
    NoSuchFileException - if the path does not exist
    
    IOException - if an I/O error occurs while deleting the path
  - deleteRecursiveIfExists
```
public static boolean deleteRecursiveIfExists(Path path)
                                       throws IOException
```
    Deletes a path recursively if it exists.
    If the path is a file or an empty directory, this method is equivalent to Files.deleteIfExists(Path). If the path is a non-empty directory, the directory, all sub-directories, and all child files are deleted.
    This operation is not atomic with respect to other file system operations. As a result, the path may be left in a partially-deleted state if this method fails.
    
    Parameters:
    
    path - the path to delete
    
    Returns:
    
    true if the path was deleted by this method, false if the path did not exist
    
    Throws:
    
    IOException - if an I/O error occurs while deleting the path
  - copyLarge
```
public static void copyLarge(Path source,
                             Path target)
                      throws IOException
```
    Copy a file to a target file in an efficient way.
    This method is equivalent to Files.copy(source, target, StandardCopyOptions.REPLACE_EXISTING), but may be significantly faster depending on the file systems of the source and the target.
    
    Parameters:
    
    source - the file to copy
    
    target - the target file
    
    Throws:
    
    IllegalArgumentException - if source is not a regular file or target is a directory.
    
    IOException - if an IO error occurs while copying
  - copyRecursive
```
public static void copyRecursive(Path source,
                                 Path target)
                          throws IOException
```
    Copy a path to a target path recursively.
    If the source is a file or empty directory, this method is equivalent to Files.copy(source, target). If the source is a non-empty directory, the directory and all descendants are copied to the target path. The destination must not exist.
    If an IOException occurs while copying files and directories, this method may leave a partial copy at the target path. Users may catch these exceptions and recursively delete the target path if this is a problem.
    
    Parameters:
    
    source - the path to copy
    
    target - the target path
    
    Throws:
    
    FileAlreadyExistsException - if the target already exists
    
    NoSuchFileException - if any parents of the target do not exist
    
    IOException - if an I/O error occurs while copying
  - readAllString
```
public static String readAllString(Path path,
                                   Charset cs)
                            throws IOException
```
    Reads the contents of a file as a string.
    
    Parameters:
    
    path - the file to read
    
    cs - the charset to use for decoding
    
    Returns:
    
    a string containing the full contents of the file
    
    Throws:
    
    IOException - if an I/O error occurs while reading a file
    
    See Also:
    
    Files.readAllBytes(Path)
  - write
```
public static Path write(Path path,
                         String string,
                         Charset cs,
                         OpenOption... options)
                  throws IOException
```
    Writes a string to a file.
    
    Parameters:
    
    path - the path to the file
    
    string - the string to write
    
    cs - the charset to use for encoding
    
    options - options specifying how the file is opened
    
    Returns:
    
    the path
    
    Throws:
    
    IOException - if an I/O error occurs while writing the file
    
    See Also:
    
    Files.write(Path, Iterable, Charset, OpenOption...)
  - defaultDirectory
```
public static Path defaultDirectory(FileSystem fs)
```
    Returns the default directory for the given file system.
  - addPermission
```
public static void addPermission(Path path,
                                 PosixFilePermission permission)
                          throws IOException
```
    Adds a permission to a file or directory.
    
    Parameters:
    
    path - the path to the file or directory
    
    permission - the permission to add
    
    Throws:
    
    IOException - if an I/O error occurs while adding the permission
  - addPermissionRecursive
```
public static void addPermissionRecursive(Path path,
                                          PosixFilePermission permission)
                                   throws IOException
```
    Recursively adds a permission to a directory.
    
    Parameters:
    
    path - the path to the directory
    
    permission - the permission to add
    
    Throws:
    
    IOException - if an I/O error occurs while adding the permission
  - setExecutable
```
public static void setExecutable(Path path)
                          throws IOException
```
    Adds the OWNER_EXECUTE permission to a file or directory.
    
    Parameters:
    
    path - the path to the file or directory
    
    Throws:
    
    IOException - if an I/O error occurs while setting the permission
  - removePermission
```
public static void removePermission(Path path,
                                    PosixFilePermission permission)
                             throws IOException
```
    Removes a permission from a file or directory.
    
    Parameters:
    
    path - the path to the file or directory
    
    permission - the permission to remove
    
    Throws:
    
    IOException - if an I/O error occurs while removing the permission
  - removePermissionRecursive
```
public static void removePermissionRecursive(Path path,
                                             PosixFilePermission permission)
                                      throws IOException
```
    Recursively removes a permission from a directory.
    
    Parameters:
    
    path - the path to the directory
    
    permission - the permission to remove
    
    Throws:
    
    IOException - if an I/O error occurs while removing the permission
  - setPermissionRecursive
```
public static void setPermissionRecursive(Path path,
                                          Set<PosixFilePermission> permissions)
                                   throws IOException
```
    Recursively sets permissions for a directory.
    
    Parameters:
    
    path - the path to the directory
    
    permissions - the desired POSIX file permissions
    
    Throws:
    
    IOException - if an I/O error occurs while setting the permission
  - isEmpty
```
public static boolean isEmpty(Path path)
                       throws IOException
```
    Test if the given path is empty. Directories are empty if they contain no entries. Files are empty if they exist and their size is zero. Paths that do not exist are always empty.
    
    Parameters:
    
    path - the path
    
    Returns:
    
    true if the path is empty
    
    Throws:
    
    IOException - if an I/O error occurs while accessing the path
  - listDirectory
```
public static List<Path> listDirectory(Path dir)
                                throws IOException
```
    Gets a list of the files and directories in the given directory. The returned paths are resolved against the given path.
    
    Parameters:
    
    dir - the Path to list
    
    Throws:
    
    IOException - if an I/O error occurs while listing entries
  - listDirectoryFiles
```
public static List<Path> listDirectoryFiles(Path dir)
                                     throws IOException
```
    Gets a list of the files in the given directory. The returned paths are resolved against the given path.
    
    Parameters:
    
    dir - the Path to list
    
    Throws:
    
    IOException - if an I/O error occurs while listing entries
  - listDirectoryRecursive
```
public static List<Path> listDirectoryRecursive(Path dir)
                                         throws IOException
```
    Gets a list of the files and directories in the given directory and all sub-directories. The returned paths are resolved against the given path.
    
    Parameters:
    
    dir - the Path to list
    
    Throws:
    
    IOException - if an I/O error occurs while descending the file tree
  - listDirectoryFilesRecursive
```
public static List<Path> listDirectoryFilesRecursive(Path dir)
                                              throws IOException
```
    Gets a list of the files in the given directory and all sub-directories. The returned paths are resolved against the given path.
    
    Parameters:
    
    dir - the Path to list
    
    Throws:
    
    IOException - if an I/O error occurs while descending the file tree
  - isLocal
```
public static boolean isLocal(Path path)
```
    Determines if the given path is associated with the default (local) file system.

Class MoreFiles

Method Summary

Methods inherited from class java.lang.Object

Method Detail

regularFileFilter

directoryFilter

deleteRecursive

deleteRecursiveIfExists

copyLarge

copyRecursive

readAllString

write

defaultDirectory

addPermission

addPermissionRecursive

setExecutable

removePermission

removePermissionRecursive

setPermissionRecursive

isEmpty

listDirectory

listDirectoryFiles

listDirectoryRecursive

listDirectoryFilesRecursive

isLocal