jodd.io
Class FileUtil

java.lang.Object
  extended by jodd.io.FileUtil

public class FileUtil
extends java.lang.Object

File utilities.


Nested Class Summary
static class FileUtil.Settings
          Inner settings describe behaviour of the FileUtil class.
 
Field Summary
static FileUtil.Settings settings
           
 
Constructor Summary
FileUtil()
           
 
Method Summary
static void cleanDir(java.io.File dest)
           
static void cleanDir(java.io.File dest, FileUtil.Settings settings)
          Cleans a directory without deleting it.
static void cleanDir(java.lang.String dest)
           
static void cleanDir(java.lang.String dest, FileUtil.Settings settings)
           
static FileUtil.Settings cloneSettings()
          Creates new FileUtil.Settings instance by cloning current default settings.
static boolean compare(java.io.File file1, java.io.File file2)
          Compare the contents of two files to determine if they are equal or not.
static boolean compare(java.lang.String file1, java.lang.String file2)
           
static void copy(java.io.File src, java.io.File dest)
           
static void copy(java.io.File src, java.io.File dest, FileUtil.Settings settings)
          Smart copy.
static void copy(java.lang.String src, java.lang.String dest)
           
static void copy(java.lang.String src, java.lang.String dest, FileUtil.Settings settings)
           
static void copyDir(java.io.File srcDir, java.io.File destDir)
           
static void copyDir(java.io.File srcDir, java.io.File destDir, FileUtil.Settings settings)
          Copies directory with specified copy settings.
static void copyDir(java.lang.String srcDir, java.lang.String destDir)
           
static void copyDir(java.lang.String srcDir, java.lang.String destDir, FileUtil.Settings settings)
           
static void copyFile(java.io.File src, java.io.File dest)
           
static void copyFile(java.io.File src, java.io.File dest, FileUtil.Settings settings)
          Copies a file to another file with specified copy settings.
static void copyFile(java.lang.String src, java.lang.String dest)
           
static void copyFile(java.lang.String src, java.lang.String dest, FileUtil.Settings settings)
           
static void copyFileToDir(java.io.File src, java.io.File destDir)
           
static void copyFileToDir(java.io.File src, java.io.File destDir, FileUtil.Settings settings)
          Copies a file to folder with specified copy settings.
static void copyFileToDir(java.lang.String src, java.lang.String destDir)
           
static void copyFileToDir(java.lang.String src, java.lang.String destDir, FileUtil.Settings settings)
           
static void delete(java.io.File dest)
           
static void delete(java.io.File dest, FileUtil.Settings settings)
          Smart delete of destination file or directory.
static void delete(java.lang.String dest)
           
static void delete(java.lang.String dest, FileUtil.Settings settings)
           
static void deleteDir(java.io.File dest)
           
static void deleteDir(java.io.File dest, FileUtil.Settings settings)
          Deletes a directory.
static void deleteDir(java.lang.String dest)
           
static void deleteDir(java.lang.String dest, FileUtil.Settings settings)
           
static void deleteFile(java.io.File dest)
           
static void deleteFile(java.lang.String dest)
           
protected static void doCopy(java.io.File src, java.io.File dest)
          Copies one file to another without any checking.
protected static void doCopy(java.lang.String src, java.lang.String dest)
          Copies one file to another without any checking.
static boolean equals(java.io.File file1, java.io.File file2)
          Checks if two files points to the same file.
static boolean equals(java.lang.String file1, java.lang.String file2)
          Checks if two files points to the same file.
static boolean isNewer(java.io.File file, java.io.File reference)
          Test if specified File is newer than the reference File.
static boolean isNewer(java.io.File file, long timeMillis)
          Tests if the specified File is newer than the specified time reference.
static boolean isNewer(java.lang.String file, long timeMillis)
           
static boolean isNewer(java.lang.String file, java.lang.String reference)
           
static boolean isOlder(java.io.File file, java.io.File reference)
           
static boolean isOlder(java.io.File file, long timeMillis)
           
static boolean isOlder(java.lang.String file, long timeMillis)
           
static boolean isOlder(java.lang.String file, java.lang.String reference)
           
static void mkdir(java.io.File dir)
          Creates single folders.
static void mkdir(java.lang.String dir)
          Creates single folder.
static void mkdirs(java.io.File dirs)
          Creates all folders at once.
static void mkdirs(java.lang.String dirs)
          Creates all folders at once.
static void move(java.io.File src, java.io.File dest)
           
static void move(java.io.File src, java.io.File dest, FileUtil.Settings settings)
          Smart move.
static void move(java.lang.String src, java.lang.String dest)
           
static void move(java.lang.String src, java.lang.String dest, FileUtil.Settings settings)
           
static void moveDir(java.io.File srcDir, java.io.File destDir)
           
static void moveDir(java.lang.String srcDir, java.lang.String destDir)
           
static void moveFile(java.io.File src, java.io.File dest)
           
static void moveFile(java.io.File src, java.io.File dest, FileUtil.Settings settings)
           
static void moveFile(java.lang.String src, java.lang.String dest)
           
static void moveFile(java.lang.String src, java.lang.String dest, FileUtil.Settings settings)
           
static void moveFileToDir(java.io.File src, java.io.File destDir)
           
static void moveFileToDir(java.io.File src, java.io.File destDir, FileUtil.Settings settings)
           
static void moveFileToDir(java.lang.String src, java.lang.String destDir)
           
static void moveFileToDir(java.lang.String src, java.lang.String destDir, FileUtil.Settings settings)
           
static FileUtil.Settings newSettings()
          Creates new FileUtil.Settings instance with default values.
static byte[] readBytes(java.io.File source)
           
static byte[] readBytes(java.lang.String file)
           
static java.lang.String readString(java.io.File source)
           
static java.lang.String readString(java.io.File source, java.lang.String encoding)
           
static java.lang.String readString(java.lang.String source)
           
static java.lang.String readString(java.lang.String source, java.lang.String encoding)
           
static java.io.File toFile(java.net.URL url)
          Converts file URLs to file.
static java.lang.String toFileName(java.net.URL url)
          Converts file URLs to file name.
static java.lang.String toFileNames(java.net.URL[] urls)
          Converts array of URLS to file names string.
static void touch(java.io.File file)
          Implements the Unix "touch" utility.
static void touch(java.lang.String file)
           
static void writeBytes(java.io.File dest, byte[] data)
           
static void writeBytes(java.io.File dest, byte[] data, int off, int len)
           
static void writeBytes(java.lang.String dest, byte[] data)
           
static void writeBytes(java.lang.String dest, byte[] data, int off, int len)
           
static void writeString(java.io.File dest, java.lang.String data)
           
static void writeString(java.io.File dest, java.lang.String data, java.lang.String encoding)
           
static void writeString(java.lang.String dest, java.lang.String data)
           
static void writeString(java.lang.String dest, java.lang.String data, java.lang.String encoding)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

settings

public static FileUtil.Settings settings
Constructor Detail

FileUtil

public FileUtil()
Method Detail

equals

public static boolean equals(java.lang.String file1,
                             java.lang.String file2)
Checks if two files points to the same file.


equals

public static boolean equals(java.io.File file1,
                             java.io.File file2)
Checks if two files points to the same file.


toFile

public static java.io.File toFile(java.net.URL url)
Converts file URLs to file. Ignores other schemes and returns null.


toFileName

public static java.lang.String toFileName(java.net.URL url)
Converts file URLs to file name. Ignores other schemes and returns null.


toFileNames

public static java.lang.String toFileNames(java.net.URL[] urls)
Converts array of URLS to file names string. Other schemes are ignored.


mkdirs

public static void mkdirs(java.lang.String dirs)
                   throws java.io.IOException
Creates all folders at once.

Throws:
java.io.IOException

mkdirs

public static void mkdirs(java.io.File dirs)
                   throws java.io.IOException
Creates all folders at once.

Throws:
java.io.IOException

mkdir

public static void mkdir(java.lang.String dir)
                  throws java.io.IOException
Creates single folder.

Throws:
java.io.IOException

mkdir

public static void mkdir(java.io.File dir)
                  throws java.io.IOException
Creates single folders.

Throws:
java.io.IOException

touch

public static void touch(java.lang.String file)
                  throws java.io.IOException
Throws:
java.io.IOException

touch

public static void touch(java.io.File file)
                  throws java.io.IOException
Implements the Unix "touch" utility. It creates a new file with size 0 or, if the file exists already, it is opened and closed without modifying it, but updating the file date and time.

Throws:
java.io.IOException

cloneSettings

public static FileUtil.Settings cloneSettings()
Creates new FileUtil.Settings instance by cloning current default settings.


newSettings

public static FileUtil.Settings newSettings()
Creates new FileUtil.Settings instance with default values.


copyFile

public static void copyFile(java.lang.String src,
                            java.lang.String dest)
                     throws java.io.IOException
Throws:
java.io.IOException

copyFile

public static void copyFile(java.lang.String src,
                            java.lang.String dest,
                            FileUtil.Settings settings)
                     throws java.io.IOException
Throws:
java.io.IOException

copyFile

public static void copyFile(java.io.File src,
                            java.io.File dest)
                     throws java.io.IOException
Throws:
java.io.IOException

copyFile

public static void copyFile(java.io.File src,
                            java.io.File dest,
                            FileUtil.Settings settings)
                     throws java.io.IOException
Copies a file to another file with specified copy settings.

Throws:
java.io.IOException

doCopy

protected static void doCopy(java.lang.String src,
                             java.lang.String dest)
                      throws java.io.IOException
Copies one file to another without any checking.

Throws:
java.io.IOException
See Also:
doCopy(java.io.File, java.io.File)

doCopy

protected static void doCopy(java.io.File src,
                             java.io.File dest)
                      throws java.io.IOException
Copies one file to another without any checking. It is assumed that both parameters represents valid files.

Throws:
java.io.IOException

copyFileToDir

public static void copyFileToDir(java.lang.String src,
                                 java.lang.String destDir)
                          throws java.io.IOException
Throws:
java.io.IOException

copyFileToDir

public static void copyFileToDir(java.lang.String src,
                                 java.lang.String destDir,
                                 FileUtil.Settings settings)
                          throws java.io.IOException
Throws:
java.io.IOException

copyFileToDir

public static void copyFileToDir(java.io.File src,
                                 java.io.File destDir)
                          throws java.io.IOException
Throws:
java.io.IOException

copyFileToDir

public static void copyFileToDir(java.io.File src,
                                 java.io.File destDir,
                                 FileUtil.Settings settings)
                          throws java.io.IOException
Copies a file to folder with specified copy settings.

Throws:
java.io.IOException

copyDir

public static void copyDir(java.lang.String srcDir,
                           java.lang.String destDir)
                    throws java.io.IOException
Throws:
java.io.IOException

copyDir

public static void copyDir(java.lang.String srcDir,
                           java.lang.String destDir,
                           FileUtil.Settings settings)
                    throws java.io.IOException
Throws:
java.io.IOException

copyDir

public static void copyDir(java.io.File srcDir,
                           java.io.File destDir)
                    throws java.io.IOException
Throws:
java.io.IOException

copyDir

public static void copyDir(java.io.File srcDir,
                           java.io.File destDir,
                           FileUtil.Settings settings)
                    throws java.io.IOException
Copies directory with specified copy settings.

Throws:
java.io.IOException

moveFile

public static void moveFile(java.lang.String src,
                            java.lang.String dest)
                     throws java.io.IOException
Throws:
java.io.IOException

moveFile

public static void moveFile(java.lang.String src,
                            java.lang.String dest,
                            FileUtil.Settings settings)
                     throws java.io.IOException
Throws:
java.io.IOException

moveFile

public static void moveFile(java.io.File src,
                            java.io.File dest)
                     throws java.io.IOException
Throws:
java.io.IOException

moveFile

public static void moveFile(java.io.File src,
                            java.io.File dest,
                            FileUtil.Settings settings)
                     throws java.io.IOException
Throws:
java.io.IOException

moveFileToDir

public static void moveFileToDir(java.lang.String src,
                                 java.lang.String destDir)
                          throws java.io.IOException
Throws:
java.io.IOException

moveFileToDir

public static void moveFileToDir(java.lang.String src,
                                 java.lang.String destDir,
                                 FileUtil.Settings settings)
                          throws java.io.IOException
Throws:
java.io.IOException

moveFileToDir

public static void moveFileToDir(java.io.File src,
                                 java.io.File destDir)
                          throws java.io.IOException
Throws:
java.io.IOException

moveFileToDir

public static void moveFileToDir(java.io.File src,
                                 java.io.File destDir,
                                 FileUtil.Settings settings)
                          throws java.io.IOException
Throws:
java.io.IOException

moveDir

public static void moveDir(java.lang.String srcDir,
                           java.lang.String destDir)
                    throws java.io.IOException
Throws:
java.io.IOException

moveDir

public static void moveDir(java.io.File srcDir,
                           java.io.File destDir)
                    throws java.io.IOException
Throws:
java.io.IOException

deleteFile

public static void deleteFile(java.lang.String dest)
                       throws java.io.IOException
Throws:
java.io.IOException

deleteFile

public static void deleteFile(java.io.File dest)
                       throws java.io.IOException
Throws:
java.io.IOException

deleteDir

public static void deleteDir(java.lang.String dest)
                      throws java.io.IOException
Throws:
java.io.IOException

deleteDir

public static void deleteDir(java.lang.String dest,
                             FileUtil.Settings settings)
                      throws java.io.IOException
Throws:
java.io.IOException

deleteDir

public static void deleteDir(java.io.File dest)
                      throws java.io.IOException
Throws:
java.io.IOException

deleteDir

public static void deleteDir(java.io.File dest,
                             FileUtil.Settings settings)
                      throws java.io.IOException
Deletes a directory.

Throws:
java.io.IOException

cleanDir

public static void cleanDir(java.lang.String dest)
                     throws java.io.IOException
Throws:
java.io.IOException

cleanDir

public static void cleanDir(java.lang.String dest,
                            FileUtil.Settings settings)
                     throws java.io.IOException
Throws:
java.io.IOException

cleanDir

public static void cleanDir(java.io.File dest)
                     throws java.io.IOException
Throws:
java.io.IOException

cleanDir

public static void cleanDir(java.io.File dest,
                            FileUtil.Settings settings)
                     throws java.io.IOException
Cleans a directory without deleting it.

Throws:
java.io.IOException

readString

public static java.lang.String readString(java.lang.String source)
                                   throws java.io.IOException
Throws:
java.io.IOException

readString

public static java.lang.String readString(java.lang.String source,
                                          java.lang.String encoding)
                                   throws java.io.IOException
Throws:
java.io.IOException

readString

public static java.lang.String readString(java.io.File source)
                                   throws java.io.IOException
Throws:
java.io.IOException

readString

public static java.lang.String readString(java.io.File source,
                                          java.lang.String encoding)
                                   throws java.io.IOException
Throws:
java.io.IOException

writeString

public static void writeString(java.lang.String dest,
                               java.lang.String data)
                        throws java.io.IOException
Throws:
java.io.IOException

writeString

public static void writeString(java.lang.String dest,
                               java.lang.String data,
                               java.lang.String encoding)
                        throws java.io.IOException
Throws:
java.io.IOException

writeString

public static void writeString(java.io.File dest,
                               java.lang.String data)
                        throws java.io.IOException
Throws:
java.io.IOException

writeString

public static void writeString(java.io.File dest,
                               java.lang.String data,
                               java.lang.String encoding)
                        throws java.io.IOException
Throws:
java.io.IOException

readBytes

public static byte[] readBytes(java.lang.String file)
                        throws java.io.IOException
Throws:
java.io.IOException

readBytes

public static byte[] readBytes(java.io.File source)
                        throws java.io.IOException
Throws:
java.io.IOException

writeBytes

public static void writeBytes(java.lang.String dest,
                              byte[] data)
                       throws java.io.IOException
Throws:
java.io.IOException

writeBytes

public static void writeBytes(java.lang.String dest,
                              byte[] data,
                              int off,
                              int len)
                       throws java.io.IOException
Throws:
java.io.IOException

writeBytes

public static void writeBytes(java.io.File dest,
                              byte[] data)
                       throws java.io.IOException
Throws:
java.io.IOException

writeBytes

public static void writeBytes(java.io.File dest,
                              byte[] data,
                              int off,
                              int len)
                       throws java.io.IOException
Throws:
java.io.IOException

compare

public static boolean compare(java.lang.String file1,
                              java.lang.String file2)
                       throws java.io.IOException
Throws:
java.io.IOException

compare

public static boolean compare(java.io.File file1,
                              java.io.File file2)
                       throws java.io.IOException
Compare the contents of two files to determine if they are equal or not.

This method checks to see if the two files are different lengths or if they point to the same file, before resorting to byte-by-byte comparison of the contents.

Code origin: Avalon

Throws:
java.io.IOException

isNewer

public static boolean isNewer(java.lang.String file,
                              java.lang.String reference)

isNewer

public static boolean isNewer(java.io.File file,
                              java.io.File reference)
Test if specified File is newer than the reference File.

Parameters:
file - the File of which the modification date must be compared
reference - the File of which the modification date is used
Returns:
true if the File exists and has been modified more recently than the reference File.

isOlder

public static boolean isOlder(java.lang.String file,
                              java.lang.String reference)

isOlder

public static boolean isOlder(java.io.File file,
                              java.io.File reference)

isNewer

public static boolean isNewer(java.io.File file,
                              long timeMillis)
Tests if the specified File is newer than the specified time reference.

Parameters:
file - the File of which the modification date must be compared.
timeMillis - the time reference measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)
Returns:
true if the File exists and has been modified after the given time reference.

isNewer

public static boolean isNewer(java.lang.String file,
                              long timeMillis)

isOlder

public static boolean isOlder(java.io.File file,
                              long timeMillis)

isOlder

public static boolean isOlder(java.lang.String file,
                              long timeMillis)

copy

public static void copy(java.lang.String src,
                        java.lang.String dest)
                 throws java.io.IOException
Throws:
java.io.IOException

copy

public static void copy(java.lang.String src,
                        java.lang.String dest,
                        FileUtil.Settings settings)
                 throws java.io.IOException
Throws:
java.io.IOException

copy

public static void copy(java.io.File src,
                        java.io.File dest)
                 throws java.io.IOException
Throws:
java.io.IOException

copy

public static void copy(java.io.File src,
                        java.io.File dest,
                        FileUtil.Settings settings)
                 throws java.io.IOException
Smart copy. If source is a directory, copy it to destination. Otherwise, if destination is directory, copy source file to it. Otherwise, try to copy source file to destination file.

Throws:
java.io.IOException

move

public static void move(java.lang.String src,
                        java.lang.String dest)
                 throws java.io.IOException
Throws:
java.io.IOException

move

public static void move(java.lang.String src,
                        java.lang.String dest,
                        FileUtil.Settings settings)
                 throws java.io.IOException
Throws:
java.io.IOException

move

public static void move(java.io.File src,
                        java.io.File dest)
                 throws java.io.IOException
Throws:
java.io.IOException

move

public static void move(java.io.File src,
                        java.io.File dest,
                        FileUtil.Settings settings)
                 throws java.io.IOException
Smart move. If source is a directory, move it to destination. Otherwise, if destination is directory, move source file to it. Otherwise, try to move source file to destination file.

Throws:
java.io.IOException

delete

public static void delete(java.lang.String dest)
                   throws java.io.IOException
Throws:
java.io.IOException

delete

public static void delete(java.lang.String dest,
                          FileUtil.Settings settings)
                   throws java.io.IOException
Throws:
java.io.IOException

delete

public static void delete(java.io.File dest)
                   throws java.io.IOException
Throws:
java.io.IOException

delete

public static void delete(java.io.File dest,
                          FileUtil.Settings settings)
                   throws java.io.IOException
Smart delete of destination file or directory.

Throws:
java.io.IOException


Copyright ©2008 Jodd Team