Class MoreFiles
Path
instances, intended to complement Files
.
Many methods provided by Guava's Files
class for File
instances are
now available via the JDK's Files
class for Path
- check the JDK's
class if a sibling method from Files
appears to be missing from this class.
- Since:
- 21.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
private static final class
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static Collection
<IOException> addException
(Collection<IOException> exceptions, IOException e) Adds the given exception to the given collection, creating the collection if it's null.static ByteSink
asByteSink
(Path path, OpenOption... options) Returns a view of the givenpath
as aByteSink
.static ByteSource
asByteSource
(Path path, OpenOption... options) Returns a view of the givenpath
as aByteSource
.static CharSink
asCharSink
(Path path, Charset charset, OpenOption... options) static CharSource
asCharSource
(Path path, Charset charset, OpenOption... options) private static void
checkAllowsInsecure
(Path path, RecursiveDeleteOption[] options) Checks that the given options allow an insecure delete, throwing an exception if not.private static Collection
<IOException> concat
(Collection<IOException> exceptions, Collection<IOException> other) Concatenates the contents of the two given collections of exceptions.static void
createParentDirectories
(Path path, FileAttribute<?>... attrs) Creates any necessary but nonexistent parent directories of the specified path.static void
deleteDirectoryContents
(Path path, RecursiveDeleteOption... options) Deletes all files within the directory at the givenpath
recursively.private static Collection
<IOException> Simple, insecure method for deleting the contents of a directory for file systems that don't supportSecureDirectoryStream
.private static Collection
<IOException> Secure method for deleting the contents of a directory usingSecureDirectoryStream
.static void
deleteRecursively
(Path path, RecursiveDeleteOption... options) Deletes the file or directory at the givenpath
recursively.private static Collection
<IOException> Insecure recursive delete for file systems that don't supportSecureDirectoryStream
.private static Collection
<IOException> deleteRecursivelySecure
(SecureDirectoryStream<Path> dir, Path path) Secure recursive delete usingSecureDirectoryStream
.static boolean
Returns true if the files located by the given paths exist, are not directories, and contain the same bytes.Returns aTraverser
instance for the file and directory tree.fileTreeChildren
(Path dir) static String
getFileExtension
(Path path) Returns the file extension for the file at the given path, or the empty string if the file has no extension.static String
getNameWithoutExtension
(Path path) Returns the file name without its file extension or path.private static Path
getParentPath
(Path path) Returns a path to the parent directory of the given path.isDirectory
(LinkOption... options) Returns a predicate that returns the result ofFiles.isDirectory(Path, LinkOption...)
on input paths with the given link options.private static boolean
isDirectory
(SecureDirectoryStream<Path> dir, Path name, LinkOption... options) Returns whether or not the file with the given name in the given dir is a directory.isRegularFile
(LinkOption... options) Returns a predicate that returns the result ofFiles.isRegularFile(Path, LinkOption...)
on input paths with the given link options.static ImmutableList
<Path> Returns an immutable list of paths to the files contained in the given directory.private static NoSuchFileException
pathNotFound
(Path path, Collection<IOException> exceptions) private static void
throwDeleteFailed
(Path path, Collection<IOException> exceptions) Throws an exception indicating that one or more files couldn't be deleted when deletingpath
or its contents.static void
Like the unix command of the same name, creates an empty file or updates the last modified timestamp of the existing file at the given path to the current system time.
-
Constructor Details
-
MoreFiles
private MoreFiles()
-
-
Method Details
-
asByteSource
Returns a view of the givenpath
as aByteSource
.Any open options provided are used when opening streams to the file and may affect the behavior of the returned source and the streams it provides. See
StandardOpenOption
for the standard options that may be provided. Providing no options is equivalent to providing theREAD
option. -
asByteSink
Returns a view of the givenpath
as aByteSink
.Any open options provided are used when opening streams to the file and may affect the behavior of the returned sink and the streams it provides. See
StandardOpenOption
for the standard options that may be provided. Providing no options is equivalent to providing theCREATE
,TRUNCATE_EXISTING
andWRITE
options. -
asCharSource
Returns a view of the givenpath
as aCharSource
using the givencharset
.Any open options provided are used when opening streams to the file and may affect the behavior of the returned source and the streams it provides. See
StandardOpenOption
for the standard options that may be provided. Providing no options is equivalent to providing theREAD
option. -
asCharSink
Returns a view of the givenpath
as aCharSink
using the givencharset
.Any open options provided are used when opening streams to the file and may affect the behavior of the returned sink and the streams it provides. See
StandardOpenOption
for the standard options that may be provided. Providing no options is equivalent to providing theCREATE
,TRUNCATE_EXISTING
andWRITE
options. -
listFiles
Returns an immutable list of paths to the files contained in the given directory.- Throws:
NoSuchFileException
- if the file does not exist (optional specific exception)NotDirectoryException
- if the file could not be opened because it is not a directory (optional specific exception)IOException
- if an I/O error occurs
-
fileTraverser
Returns aTraverser
instance for the file and directory tree. The returned traverser starts from aPath
and will return all files and directories it encounters.The returned traverser attempts to avoid following symbolic links to directories. However, the traverser cannot guarantee that it will not follow symbolic links to directories as it is possible for a directory to be replaced with a symbolic link between checking if the file is a directory and actually reading the contents of that directory.
If the
Path
passed to one of the traversal methods does not exist or is not a directory, no exception will be thrown and the returnedIterable
will contain a single element: that path.DirectoryIteratorException
may be thrown when iteratingIterable
instances created by this traverser if anIOException
is thrown by a call tolistFiles(Path)
.Example:
MoreFiles.fileTraverser().depthFirstPreOrder(Paths.get("/"))
may return the following paths:["/", "/etc", "/etc/config.txt", "/etc/fonts", "/home", "/home/alice", ...]
- Since:
- 23.5
-
fileTreeChildren
-
isDirectory
Returns a predicate that returns the result ofFiles.isDirectory(Path, LinkOption...)
on input paths with the given link options. -
isDirectory
private static boolean isDirectory(SecureDirectoryStream<Path> dir, Path name, LinkOption... options) throws IOException Returns whether or not the file with the given name in the given dir is a directory.- Throws:
IOException
-
isRegularFile
Returns a predicate that returns the result ofFiles.isRegularFile(Path, LinkOption...)
on input paths with the given link options. -
equal
Returns true if the files located by the given paths exist, are not directories, and contain the same bytes.- Throws:
IOException
- if an I/O error occurs- Since:
- 22.0
-
touch
Like the unix command of the same name, creates an empty file or updates the last modified timestamp of the existing file at the given path to the current system time.- Throws:
IOException
-
createParentDirectories
Creates any necessary but nonexistent parent directories of the specified path. Note that if this operation fails, it may have succeeded in creating some (but not all) of the necessary parent directories. The parent directory is created with the givenattrs
.- Throws:
IOException
- if an I/O error occurs, or if any necessary but nonexistent parent directories of the specified file could not be created.
-
getFileExtension
Returns the file extension for the file at the given path, or the empty string if the file has no extension. The result does not include the '.
'.Note: This method simply returns everything after the last '
.
' in the file's name as determined byPath.getFileName()
. It does not account for any filesystem-specific behavior that thePath
API does not already account for. For example, on NTFS it will report"txt"
as the extension for the filename"foo.exe:.txt"
even though NTFS will drop the":.txt"
part of the name when the file is actually created on the filesystem due to NTFS's Alternate Data Streams. -
getNameWithoutExtension
Returns the file name without its file extension or path. This is similar to thebasename
unix command. The result does not include the '.
'. -
deleteRecursively
public static void deleteRecursively(Path path, RecursiveDeleteOption... options) throws IOException Deletes the file or directory at the givenpath
recursively. Deletes symbolic links, not their targets (subject to the caveat below).If an I/O exception occurs attempting to read, open or delete any file under the given directory, this method skips that file and continues. All such exceptions are collected and, after attempting to delete all files, an
IOException
is thrown containing those exceptions as suppressed exceptions.Warning: Security of recursive deletes
On a file system that supports symbolic links and does not support
SecureDirectoryStream
, it is possible for a recursive delete to delete files and directories that are outside the directory being deleted. This can happen if, after checking that a file is a directory (and not a symbolic link), that directory is replaced by a symbolic link to an outside directory before the call that opens the directory to read its entries.By default, this method throws
InsecureRecursiveDeleteException
if it can't guarantee the security of recursive deletes. If you wish to allow the recursive deletes anyway, passRecursiveDeleteOption.ALLOW_INSECURE
to this method to override that behavior.- Throws:
NoSuchFileException
- ifpath
does not exist (optional specific exception)InsecureRecursiveDeleteException
- if the security of recursive deletes can't be guaranteed for the file system andRecursiveDeleteOption.ALLOW_INSECURE
was not specifiedIOException
- ifpath
or any file in the subtree rooted at it can't be deleted for any reason
-
deleteDirectoryContents
public static void deleteDirectoryContents(Path path, RecursiveDeleteOption... options) throws IOException Deletes all files within the directory at the givenpath
recursively. Does not delete the directory itself. Deletes symbolic links, not their targets (subject to the caveat below). Ifpath
itself is a symbolic link to a directory, that link is followed and the contents of the directory it targets are deleted.If an I/O exception occurs attempting to read, open or delete any file under the given directory, this method skips that file and continues. All such exceptions are collected and, after attempting to delete all files, an
IOException
is thrown containing those exceptions as suppressed exceptions.Warning: Security of recursive deletes
On a file system that supports symbolic links and does not support
SecureDirectoryStream
, it is possible for a recursive delete to delete files and directories that are outside the directory being deleted. This can happen if, after checking that a file is a directory (and not a symbolic link), that directory is replaced by a symbolic link to an outside directory before the call that opens the directory to read its entries.By default, this method throws
InsecureRecursiveDeleteException
if it can't guarantee the security of recursive deletes. If you wish to allow the recursive deletes anyway, passRecursiveDeleteOption.ALLOW_INSECURE
to this method to override that behavior.- Throws:
NoSuchFileException
- ifpath
does not exist (optional specific exception)NotDirectoryException
- if the file atpath
is not a directory (optional specific exception)InsecureRecursiveDeleteException
- if the security of recursive deletes can't be guaranteed for the file system andRecursiveDeleteOption.ALLOW_INSECURE
was not specifiedIOException
- if one or more files can't be deleted for any reason
-
deleteRecursivelySecure
@CheckForNull private static Collection<IOException> deleteRecursivelySecure(SecureDirectoryStream<Path> dir, Path path) Secure recursive delete usingSecureDirectoryStream
. Returns a collection of exceptions that occurred or null if no exceptions were thrown. -
deleteDirectoryContentsSecure
@CheckForNull private static Collection<IOException> deleteDirectoryContentsSecure(SecureDirectoryStream<Path> dir) Secure method for deleting the contents of a directory usingSecureDirectoryStream
. Returns a collection of exceptions that occurred or null if no exceptions were thrown. -
deleteRecursivelyInsecure
Insecure recursive delete for file systems that don't supportSecureDirectoryStream
. Returns a collection of exceptions that occurred or null if no exceptions were thrown. -
deleteDirectoryContentsInsecure
@CheckForNull private static Collection<IOException> deleteDirectoryContentsInsecure(DirectoryStream<Path> dir) Simple, insecure method for deleting the contents of a directory for file systems that don't supportSecureDirectoryStream
. Returns a collection of exceptions that occurred or null if no exceptions were thrown. -
getParentPath
Returns a path to the parent directory of the given path. If the path actually has a parent path, this is simple. Otherwise, we need to do some trickier things. Returns null if the path is a root or is the empty path. -
checkAllowsInsecure
private static void checkAllowsInsecure(Path path, RecursiveDeleteOption[] options) throws InsecureRecursiveDeleteException Checks that the given options allow an insecure delete, throwing an exception if not.- Throws:
InsecureRecursiveDeleteException
-
addException
private static Collection<IOException> addException(@CheckForNull Collection<IOException> exceptions, IOException e) Adds the given exception to the given collection, creating the collection if it's null. Returns the collection. -
concat
@CheckForNull private static Collection<IOException> concat(@CheckForNull Collection<IOException> exceptions, @CheckForNull Collection<IOException> other) Concatenates the contents of the two given collections of exceptions. If either collection is null, the other collection is returned. Otherwise, the elements ofother
are added toexceptions
andexceptions
is returned. -
throwDeleteFailed
private static void throwDeleteFailed(Path path, Collection<IOException> exceptions) throws FileSystemException Throws an exception indicating that one or more files couldn't be deleted when deletingpath
or its contents.If there is only one exception in the collection, and it is a
NoSuchFileException
thrown becausepath
itself didn't exist, then throws that exception. Otherwise, the thrown exception contains all the exceptions in the given collection as suppressed exceptions.- Throws:
FileSystemException
-
pathNotFound
@CheckForNull private static NoSuchFileException pathNotFound(Path path, Collection<IOException> exceptions)
-