org.eclipse.jgit.util
Class FileUtils

java.lang.Object
  extended by org.eclipse.jgit.util.FileUtils

public class FileUtils
extends Object

File Utilities


Field Summary
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
FileUtils()
           
 
Method Summary
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 delete(File f)
          Delete file or empty folder
static void delete(File f, int options)
          Delete file or folder
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.
 
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
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.

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


Copyright © 2012. All Rights Reserved.