org.eclipse.jgit.util

Class FileUtils

java.lang.Object

org.eclipse.jgit.util.FileUtils

public class FileUtils
extends Object

File Utilities

Field Summary

Fields

Modifier and Type	Field and 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 given File
static int	RECURSIVE Option to recursively delete given File
static int	RETRY Option to retry deletion if not successful
static int	SKIP_MISSING Option to skip deletion if file doesn't exist

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canExecute(File file)
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 void	createSymLink(File path, String target) Create a symbolic link
static File	createTempDir(String prefix, String suffix, File dir) Create a temporary directory.
static void	delete(File f) Delete file or empty folder
static void	delete(File f, int options) Delete file or folder
static FS.Attributes	getFileAttributesPosix(FS fs, File file)
static long	getLength(File file)
static boolean	isStaleFileHandle(IOException ioe) Determine if an IOException is a Stale NFS File Handle
static 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)
static String	normalize(String name)
static String	readSymLink(File path)
static String	relativize(String base, String other) This will try and make a given path relative to another.
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 passed CopyOptions.
static void	setHidden(File file, boolean hidden)

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final int NONE

Option to delete given File

See Also:

Constant Field Values

RECURSIVE

public static final int RECURSIVE

Option to recursively delete given File

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 with RECURSIVE

Since:

3.0

See Also:

Constant Field Values

Constructor Detail

FileUtils

public FileUtils()

Method Detail

delete

public static void delete(File f)
                   throws IOException

Delete file or empty folder

Parameters:

f - File to be deleted

Throws:

IOException - if deletion of f fails. This may occur if f didn't exist when the method was called. This can therefore cause 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 deleted

options - 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 of f fails. This may occur if f didn't exist when the method was called. This can therefore cause 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 old File

dst - the new File

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 passed CopyOptions. 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 if StandardCopyOption.REPLACE_EXISTING has been set. If StandardCopyOption.ATOMIC_MOVE has been set the rename will be done atomically or fail with an AtomicMoveNotSupportedException

Parameters:

src - the old file

dst - the new file

options - options to pass to Files.move(java.nio.file.Path, java.nio.file.Path, CopyOption...)

Throws:

AtomicMoveNotSupportedException - if file cannot be moved as an atomic file system operation

IOException

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 of d fails. This may occur if d did exist when the method was called. This can therefore cause 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 created

skipExisting - if true skip creation of the given directory if it already exists in the file system

Throws:

IOException - if creation of d fails. This may occur if d did exist when the method was called. This can therefore cause 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 of d fails. This may occur if d did exist when the method was called. This can therefore cause 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 created

skipExisting - if true skip creation of the given directory if it already exists in the file system

Throws:

IOException - if creation of d fails. This may occur if d did exist when the method was called. This can therefore cause 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 void createSymLink(File path,
                 String target)
                          throws IOException

Create a symbolic link

Parameters:

path -

target -

Throws:

IOException

Since:

3.0

readSymLink

public static String readSymLink(File path)
                          throws IOException

Parameters:

path -

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 -

suffix -

dir - The parent dir, can be null to use system default temp dir.

Returns:

the temp dir created.

Throws:

IOException

Since:

3.4

relativize

public static String relativize(String base,
                String other)

This will try and make a given path relative to another.

For example, if this is called with the two following paths :

 base = "c:\\Users\\jdoe\\eclipse\\git\\project"
 other = "c:\\Users\\jdoe\\eclipse\\git\\another_project\\pom.xml"
 

This will return "..\\another_project\\pom.xml".

This method uses File.separator to split the paths into segments.

Note that this will return the empty String if base and other are equal.

Parameters:

base - The path against which other 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 to base.

Returns:

A relative path that, when resolved against base, will yield the original other.

Since:

3.7

isStaleFileHandle

public static boolean isStaleFileHandle(IOException ioe)

Determine if an IOException is a Stale NFS File Handle

Parameters:

ioe -

Returns:

a boolean true if the IOException is a Stale NFS FIle Handle

Since:

4.1

setHidden

public static void setHidden(File file,
             boolean hidden)
                      throws IOException

Parameters:

file -

hidden -

Throws:

IOException

Since:

4.1

getLength

public static long getLength(File file)
                      throws IOException

Parameters:

file -

Returns:

length of the given file

Throws:

IOException

Since:

4.1

canExecute

public static boolean canExecute(File file)

Parameters:

file -

Returns:

true if the given file can be executed

Since:

4.1

getFileAttributesPosix

public static FS.Attributes getFileAttributesPosix(FS fs,
                                   File file)

Parameters:

fs -

file -

Returns:

file system attributes for the given file

Since:

4.1

normalize

public static File normalize(File file)

Parameters:

file -

Returns:

on Mac: NFC normalized File, otherwise the passed file

Since:

4.1

normalize

public static String normalize(String name)

Parameters:

name -

Returns:

on Mac: NFC normalized form of given name

Since:

4.1