Package org.eclipse.jgit.util
Class FileUtils
- java.lang.Object
-
- org.eclipse.jgit.util.FileUtils
-
public class FileUtils extends Object
File Utilities
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
FileUtils.IOFunction<A,B>
-
Field Summary
Fields Modifier and Type Field Description static int
EMPTY_DIRECTORIES_ONLY
Option to only delete empty directories.static int
IGNORE_ERRORS
Option not to throw exceptions when a deletion finally doesn't succeed.static int
NONE
Option to delete givenFile
static int
RECURSIVE
Option to recursively delete givenFile
static int
RETRY
Option to retry deletion if not successfulstatic int
SKIP_MISSING
Option to skip deletion if file doesn't exist
-
Constructor Summary
Constructors Constructor Description FileUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static boolean
canExecute(File file)
Whether the given file can be executed.static File
canonicalize(File file)
Best-effort variation ofFile.getCanonicalFile()
returning the input file if the file cannot be canonicalized instead of throwingIOException
.static void
createNewFile(File f)
Atomically creates a new, empty file named by this abstract pathname if and only if a file with this name does not yet exist.static Path
createSymLink(File path, String target)
Create a symbolic linkstatic File
createTempDir(String prefix, String suffix, File dir)
Create a temporary directory.static long
delay(long last, long min, long max)
Compute a delay in amin..max
interval with random jitter.static void
delete(File f)
Delete file or empty folderstatic void
delete(File f, int options)
Delete file or folderstatic FS.Attributes
getFileAttributesPosix(FS fs, File file)
Get file system attributes for the given file.static long
getLength(File file)
Get file lengthstatic boolean
hasFiles(Path dir)
Whether the path is a directory with files in it.static boolean
isStaleFileHandle(IOException ioe)
Determine if an IOException is a Stale NFS File Handlestatic boolean
isStaleFileHandleInCausalChain(Throwable throwable)
Determine if a throwable or a cause in its causal chain is a Stale NFS File Handlestatic void
mkdir(File d)
Creates the directory named by this abstract pathname.static void
mkdir(File d, boolean skipExisting)
Creates the directory named by this abstract pathname.static void
mkdirs(File d)
Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories.static void
mkdirs(File d, boolean skipExisting)
Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories.static File
normalize(File file)
NFC normalize a file (on Mac), otherwise do nothingstatic String
normalize(String name)
On Mac: get NFC normalized form of given name, otherwise the given name.static String
pathToString(File file)
Convert a path to String, replacing separators as necessary.static String
readSymLink(File path)
Read target path of the symlink.static <T> T
readWithRetries(File file, FileUtils.IOFunction<File,? extends T> reader)
Invokes the givenFileUtils.IOFunction
, performing a limited number of re-tries if exceptions occur that indicate either a stale NFS file handle or that indicate that the file may be written concurrently.static String
relativizeGitPath(String base, String other)
Expressesother
as a relative file path frombase
.static String
relativizeNativePath(String base, String other)
Expressesother
as a relative file path frombase
.static String
relativizePath(String base, String other, String dirSeparator, boolean caseSensitive)
Expressesother
as a relative file path frombase
static void
rename(File src, File dst)
Rename a file or folder.static void
rename(File src, File dst, CopyOption... options)
Rename a file or folder using the passedCopyOption
s.static void
setHidden(File file, boolean hidden)
Set a file hidden (on Windows)static Path
toPath(File f)
static void
touch(Path f)
Touch the given file
-
-
-
Field Detail
-
NONE
public static final int NONE
Option to delete givenFile
- See Also:
- Constant Field Values
-
RECURSIVE
public static final int RECURSIVE
Option to recursively delete givenFile
- See Also:
- Constant Field Values
-
RETRY
public static final int RETRY
Option to retry deletion if not successful- See Also:
- Constant Field Values
-
SKIP_MISSING
public static final int SKIP_MISSING
Option to skip deletion if file doesn't exist- See Also:
- Constant Field Values
-
IGNORE_ERRORS
public static final int IGNORE_ERRORS
Option not to throw exceptions when a deletion finally doesn't succeed.- Since:
- 2.0
- See Also:
- Constant Field Values
-
EMPTY_DIRECTORIES_ONLY
public static final int EMPTY_DIRECTORIES_ONLY
Option to only delete empty directories. This option can be combined withRECURSIVE
- Since:
- 3.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
toPath
public static Path toPath(File f) throws IOException
- Parameters:
f
-File
to be converted toPath
- Returns:
- the path represented by the file
- Throws:
IOException
- in case the path represented by the file is not valid (InvalidPathException
)- Since:
- 4.10
-
delete
public static void delete(File f) throws IOException
Delete file or empty folder- Parameters:
f
-File
to be deleted- Throws:
IOException
- if deletion off
fails. This may occur iff
didn't exist when the method was called. This can therefore cause java.io.IOExceptions during race conditions when multiple concurrent threads all try to delete the same file.
-
delete
public static void delete(File f, int options) throws IOException
Delete file or folder- Parameters:
f
-File
to be deletedoptions
- deletion options,RECURSIVE
for recursive deletion of a subtree,RETRY
to retry when deletion failed. Retrying may help if the underlying file system doesn't allow deletion of files being read by another thread.- Throws:
IOException
- if deletion off
fails. This may occur iff
didn't exist when the method was called. This can therefore cause java.io.IOExceptions during race conditions when multiple concurrent threads all try to delete the same file. This exception is not thrown when IGNORE_ERRORS is set.
-
rename
public static void rename(File src, File dst) throws IOException
Rename a file or folder. If the rename fails and if we are running on a filesystem where it makes sense to repeat a failing rename then repeat the rename operation up to 9 times with 100ms sleep time between two calls. Furthermore if the destination exists and is directory hierarchy with only directories in it, the whole directory hierarchy will be deleted. If the target represents a non-empty directory structure, empty subdirectories within that structure may or may not be deleted even if the method fails. Furthermore if the destination exists and is a file then the file will be deleted and then the rename is retried.This operation is not atomic.
- Parameters:
src
- the oldFile
dst
- the newFile
- Throws:
IOException
- if the rename has failed- Since:
- 3.0
- See Also:
FS.retryFailedLockFileCommit()
-
rename
public static void rename(File src, File dst, CopyOption... options) throws AtomicMoveNotSupportedException, IOException
Rename a file or folder using the passedCopyOption
s. If the rename fails and if we are running on a filesystem where it makes sense to repeat a failing rename then repeat the rename operation up to 9 times with 100ms sleep time between two calls. Furthermore if the destination exists and is a directory hierarchy with only directories in it, the whole directory hierarchy will be deleted. If the target represents a non-empty directory structure, empty subdirectories within that structure may or may not be deleted even if the method fails. Furthermore if the destination exists and is a file then the file will be replaced ifStandardCopyOption.REPLACE_EXISTING
has been set. IfStandardCopyOption.ATOMIC_MOVE
has been set the rename will be done atomically or fail with anAtomicMoveNotSupportedException
- Parameters:
src
- the old filedst
- the new fileoptions
- options to pass toFiles.move(java.nio.file.Path, java.nio.file.Path, CopyOption...)
- Throws:
AtomicMoveNotSupportedException
- if file cannot be moved as an atomic file system operationIOException
- Since:
- 4.1
-
mkdir
public static void mkdir(File d) throws IOException
Creates the directory named by this abstract pathname.- Parameters:
d
- directory to be created- Throws:
IOException
- if creation ofd
fails. This may occur ifd
did exist when the method was called. This can therefore cause java.io.IOExceptions during race conditions when multiple concurrent threads all try to create the same directory.
-
mkdir
public static void mkdir(File d, boolean skipExisting) throws IOException
Creates the directory named by this abstract pathname.- Parameters:
d
- directory to be createdskipExisting
- iftrue
skip creation of the given directory if it already exists in the file system- Throws:
IOException
- if creation ofd
fails. This may occur ifd
did exist when the method was called. This can therefore cause java.io.IOExceptions during race conditions when multiple concurrent threads all try to create the same directory.
-
mkdirs
public static void mkdirs(File d) throws IOException
Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories. Note that if this operation fails it may have succeeded in creating some of the necessary parent directories.- Parameters:
d
- directory to be created- Throws:
IOException
- if creation ofd
fails. This may occur ifd
did exist when the method was called. This can therefore cause java.io.IOExceptions during race conditions when multiple concurrent threads all try to create the same directory.
-
mkdirs
public static void mkdirs(File d, boolean skipExisting) throws IOException
Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories. Note that if this operation fails it may have succeeded in creating some of the necessary parent directories.- Parameters:
d
- directory to be createdskipExisting
- iftrue
skip creation of the given directory if it already exists in the file system- Throws:
IOException
- if creation ofd
fails. This may occur ifd
did exist when the method was called. This can therefore cause java.io.IOExceptions during race conditions when multiple concurrent threads all try to create the same directory.
-
createNewFile
public static void createNewFile(File f) throws IOException
Atomically creates a new, empty file named by this abstract pathname if and only if a file with this name does not yet exist. The check for the existence of the file and the creation of the file if it does not exist are a single operation that is atomic with respect to all other filesystem activities that might affect the file.Note: this method should not be used for file-locking, as the resulting protocol cannot be made to work reliably. The
FileLock
facility should be used instead.- Parameters:
f
- the file to be created- Throws:
IOException
- if the named file already exists or if an I/O error occurred
-
createSymLink
public static Path createSymLink(File path, String target) throws IOException
Create a symbolic link- Parameters:
path
- the path of the symbolic link to createtarget
- the target of the symbolic link- Returns:
- the path to the symbolic link
- Throws:
IOException
- Since:
- 4.2
-
readSymLink
public static String readSymLink(File path) throws IOException
Read target path of the symlink.- Parameters:
path
- aFile
object.- Returns:
- target path of the symlink, or null if it is not a symbolic link
- Throws:
IOException
- Since:
- 3.0
-
createTempDir
public static File createTempDir(String prefix, String suffix, File dir) throws IOException
Create a temporary directory.- Parameters:
prefix
- prefix stringsuffix
- suffix stringdir
- The parent dir, can be null to use system default temp dir.- Returns:
- the temp dir created.
- Throws:
IOException
- Since:
- 3.4
-
relativizeNativePath
public static String relativizeNativePath(String base, String other)
Expressesother
as a relative file path frombase
. File-separator and case sensitivity are based on the current file system. See alsorelativizePath(String, String, String, boolean)
.- Parameters:
base
- Base pathother
- Destination path- Returns:
- Relative path from
base
toother
- Since:
- 4.8
-
relativizeGitPath
public static String relativizeGitPath(String base, String other)
Expressesother
as a relative file path frombase
. File-separator and case sensitivity are based on Git's internal representation of files (which matches Unix). See alsorelativizePath(String, String, String, boolean)
.- Parameters:
base
- Base pathother
- Destination path- Returns:
- Relative path from
base
toother
- Since:
- 4.8
-
relativizePath
public static String relativizePath(String base, String other, String dirSeparator, boolean caseSensitive)
Expressesother
as a relative file path frombase
For example, if called with the two following paths :
base = "c:\\Users\\jdoe\\eclipse\\git\\project"
other = "c:\\Users\\jdoe\\eclipse\\git\\another_project\\pom.xml"
Note that this will return the empty String if
base
andother
are equal.- Parameters:
base
- The path against whichother
should be relativized. This will be assumed to denote the path to a folder and not a file.other
- The path that will be made relative tobase
.dirSeparator
- A string that separates components of the path. In practice, this is "/" or "\\".caseSensitive
- Whether to consider differently-cased directory names as distinct- Returns:
- A relative path that, when resolved against
base
, will yield the originalother
. - Since:
- 4.8
-
isStaleFileHandle
public static boolean isStaleFileHandle(IOException ioe)
Determine if an IOException is a Stale NFS File Handle- Parameters:
ioe
- anIOException
object.- Returns:
- a boolean true if the IOException is a Stale NFS FIle Handle
- Since:
- 4.1
-
isStaleFileHandleInCausalChain
public static boolean isStaleFileHandleInCausalChain(Throwable throwable)
Determine if a throwable or a cause in its causal chain is a Stale NFS File Handle- Parameters:
throwable
- aThrowable
object.- Returns:
- a boolean true if the throwable or a cause in its causal chain is a Stale NFS File Handle
- Since:
- 4.7
-
readWithRetries
public static <T> T readWithRetries(File file, FileUtils.IOFunction<File,? extends T> reader) throws Exception
Invokes the givenFileUtils.IOFunction
, performing a limited number of re-tries if exceptions occur that indicate either a stale NFS file handle or that indicate that the file may be written concurrently.- Type Parameters:
T
- result type- Parameters:
file
- to readreader
- for reading the file and creating an instance ofT
- Returns:
- the result of the
reader
, ornull
if the file does not exist - Throws:
Exception
- if a problem occurs- Since:
- 6.2
-
setHidden
public static void setHidden(File file, boolean hidden) throws IOException
Set a file hidden (on Windows)- Parameters:
file
- aFile
object.hidden
- a boolean.- Throws:
IOException
- Since:
- 4.1
-
getLength
public static long getLength(File file) throws IOException
Get file length- Parameters:
file
- aFile
.- Returns:
- length of the given file
- Throws:
IOException
- Since:
- 4.1
-
hasFiles
public static boolean hasFiles(Path dir) throws IOException
Whether the path is a directory with files in it.- Parameters:
dir
- directory path- Returns:
true
if the given directory path contains files- Throws:
IOException
- on any I/O errors accessing the path- Since:
- 5.11
-
canExecute
public static boolean canExecute(File file)
Whether the given file can be executed.- Parameters:
file
- aFile
object.- Returns:
true
if the given file can be executed.- Since:
- 4.1
-
getFileAttributesPosix
public static FS.Attributes getFileAttributesPosix(FS fs, File file)
Get file system attributes for the given file.
-
normalize
public static File normalize(File file)
NFC normalize a file (on Mac), otherwise do nothing
-
normalize
public static String normalize(String name)
On Mac: get NFC normalized form of given name, otherwise the given name.- Parameters:
name
- aString
object.- Returns:
- on Mac: NFC normalized form of given name
- Since:
- 4.1
-
canonicalize
public static File canonicalize(File file)
Best-effort variation ofFile.getCanonicalFile()
returning the input file if the file cannot be canonicalized instead of throwingIOException
.- Parameters:
file
- to be canonicalized; may benull
- Returns:
- canonicalized file, or the unchanged input file if
canonicalization failed or if
file == null
- Throws:
SecurityException
- ifFile.getCanonicalFile()
throws one- Since:
- 4.2
-
pathToString
public static String pathToString(File file)
Convert a path to String, replacing separators as necessary.- Parameters:
file
- aFile
.- Returns:
- file's path as a String
- Since:
- 4.10
-
touch
public static void touch(Path f) throws IOException
Touch the given file- Parameters:
f
- the file to touch- Throws:
IOException
- Since:
- 5.1.8
-
delay
public static long delay(long last, long min, long max)
Compute a delay in amin..max
interval with random jitter.- Parameters:
last
- amount of delay waited before the last attempt. This is used to seed the next delay interval. Should be 0 if there was no prior delay.min
- shortest amount of allowable delay between attempts.max
- longest amount of allowable delay between attempts.- Returns:
- new amount of delay to wait before the next attempt.
- Since:
- 5.6
-
-