Class FileUtils
This class provides basic facilities for manipulating files and file paths.
Path-related methodsMethods exist to retrieve the components of a typical file path. For example
/www/hosted/mysite/index.html
, can be broken into:
/www/hosted/mysite/
-- retrievable throughgetPath(java.lang.String)
index.html
-- retrievable throughremovePath(java.lang.String)
/www/hosted/mysite/index
-- retrievable throughremoveExtension(java.lang.String)
html
-- retrievable throughgetExtension(java.lang.String)
There are also methods to concatenate two paths
, resolve a path relative to a
File
and normalize(java.lang.String)
a path.
There are methods to create a File from a URL
, copy a File to a
directory
, copy a File to another File
, copy a URL's contents to a File
, as
well as methods to delete
and clean
a directory.
Common File
manipulation routines.
Taken from the commons-utils repo. Also code from Alexandria's FileUtils. And from Avalon Excalibur's IO. And from Ant.
-
Nested Class Summary
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
Returns the filename portion of a file specification string.static String
Returns the filename portion of a file specification string.static String
byteCountToDisplaySize
(int size) Returns a human-readable version of the file size (original is in bytes).static String
Will concatenate 2 paths.static void
cleanDirectory
(File directory) Clean a directory without deleting it.static void
cleanDirectory
(String directory) Clean a directory without deleting it.static boolean
contentEquals
(File file1, File file2) Compare the contents of two files to determine if they are equal or not.static void
copyDirectory
(File sourceDirectory, File destinationDirectory) Copy a directory to an other one.static void
copyDirectory
(File sourceDirectory, File destinationDirectory, String includes, String excludes) Copy a directory to an other one.static void
copyDirectoryLayout
(File sourceDirectory, File destinationDirectory, String[] includes, String[] excludes) Copies a entire directory layout : no files will be copied only directoriesstatic void
copyDirectoryStructure
(File sourceDirectory, File destinationDirectory) Copies a entire directory structure.static void
copyDirectoryStructureIfModified
(File sourceDirectory, File destinationDirectory) Copies an entire directory structure but only source files with timestamp later than the destinations'.static void
Copy file from source to destination.static void
copyFile
(File from, File to, String encoding, FileUtils.FilterWrapper[] wrappers) If wrappers is null or empty, the file will be copy only ifto.lastModified() < from.lastModified()
static void
copyFile
(File from, File to, String encoding, FileUtils.FilterWrapper[] wrappers, boolean overwrite) If wrappers is null or empty, the file will be copy only ifto.lastModified() < from.lastModified()
, if overwrite is truestatic boolean
copyFileIfModified
(File source, File destination) Copy file from source to destination only if source timestamp is later than the destination timestamp.static void
copyFileToDirectory
(File source, File destinationDirectory) Copy file from source to destination.static void
copyFileToDirectory
(String source, String destinationDirectory) Copy file from source to destination.static void
copyFileToDirectoryIfModified
(File source, File destinationDirectory) Copy file from source to destination only if source is newer than the target file.static void
copyFileToDirectoryIfModified
(String source, String destinationDirectory) Copy file from source to destination only if source is newer than the target file.static void
copyStreamToFile
(InputStreamFacade source, File destination) static void
copyURLToFile
(URL source, File destination) Copies bytes from the URLsource
to a filedestination
.static File
createTempFile
(String prefix, String suffix, File parentDir) Create a temporary file in a given directory.static void
deleteDirectory
(File directory) Recursively delete a directory.static void
deleteDirectory
(String directory) Recursively delete a directory.static String
Returns the directory path portion of a file specification string.static String
Returns the extension portion of a file specification string.static void
fileAppend
(String fileName, String data) Deprecated.static void
fileAppend
(String fileName, String encoding, String data) Deprecated.usejava.nio.files.Files.write(filename, data.getBytes(encoding), StandardOpenOption.APPEND, StandardOpenOption.CREATE)
static void
fileDelete
(String fileName) Deletes a file.static boolean
fileExists
(String fileName) Check if a file exits.static String
Returns the filename portion of a file specification string.static String
Note: the file content is read with platform encodingstatic String
static String
Note: the file content is read with platform encoding.static String
static void
Writes data to a file.static void
Writes data to a file.static void
Writes data to a file.static void
Writes data to a file.static void
forceDelete
(File file) Delete a file.static void
forceDelete
(String file) Delete a file.static void
forceDeleteOnExit
(File file) Schedule a file to be deleted when JVM exits.static void
forceMkdir
(File file) Make a directory.static String[]
static String
getDirectoryNames
(File directory, String includes, String excludes, boolean includeBasedir) Return a list of directories as String depending options.getDirectoryNames
(File directory, String includes, String excludes, boolean includeBasedir, boolean isCaseSensitive) Return a list of directories as String depending options.static String
getExtension
(String filename) Get extension from filename.static File
Creates a file handle.getFileAndDirectoryNames
(File directory, String includes, String excludes, boolean includeBasedir, boolean isCaseSensitive, boolean getFiles, boolean getDirectories) Return a list of files as String depending options.getFileNames
(File directory, String includes, String excludes, boolean includeBasedir) Return a list of files as String depending options.getFileNames
(File directory, String includes, String excludes, boolean includeBasedir, boolean isCaseSensitive) Return a list of files as String depending options.Return the files contained in the directory, using inclusion and exclusion Ant patterns, including the directory name in each of the filesReturn the files contained in the directory, using inclusion and exclusion Ant patternsstatic String[]
getFilesFromExtension
(String directory, String[] extensions) Given a directory and an array of extensions return an array of compliant files.static String
Get path from filename.static String
Get path from filename.static boolean
For Windows OS, check if the file name contains any of the following characters:":", "*", "?", "\"", "<", ">", "|"
static void
Link file from destination to source.Note: the file content is read with platform encodingstatic void
Simple way to make a directorystatic void
Creates a number of directories, as delivered from DirectoryScannerstatic String
Normalize a path.static String
removeExtension
(String filename) Remove extension from filename.static String
removePath
(String filepath) Remove path from filename.static String
removePath
(String filepath, char fileSeparatorChar) Remove path from filename.static void
Renames a file, even if that involves crossing file system boundaries.static File
resolveFile
(File baseFile, String filename) Resolve a filefilename
to it's canonical form.static long
sizeOfDirectory
(File directory) Recursively count size of a directory.static long
sizeOfDirectory
(String directory) Recursively count size of a directory.static File
Convert from aURL
to aFile
.static URL[]
Convert the array of Files into a list of URLs.static boolean
Waits for NFS to propagate a file creation, imposing a timeout.static boolean
Waits for NFS to propagate a file creation, imposing a timeout.
-
Field Details
-
ONE_KB
public static final int ONE_KBThe number of bytes in a kilobyte.- See Also:
-
ONE_MB
public static final int ONE_MBThe number of bytes in a megabyte.- See Also:
-
ONE_GB
public static final int ONE_GBThe number of bytes in a gigabyte.- See Also:
-
FS
The vm file separator
-
-
Constructor Details
-
FileUtils
public FileUtils()
-
-
Method Details
-
getDefaultExcludes
- Returns:
- the default excludes pattern
- See Also:
-
getDefaultExcludesAsList
- Returns:
- the default excludes pattern as list.
- See Also:
-
getDefaultExcludesAsString
- Returns:
- the default excludes pattern as comma separated string.
- See Also:
-
byteCountToDisplaySize
Returns a human-readable version of the file size (original is in bytes).- Parameters:
size
- The number of bytes.- Returns:
- A human-readable display value (includes units).
-
dirname
Returns the directory path portion of a file specification string. Matches the equally named unix command.- Parameters:
filename
- the file path- Returns:
- The directory portion excluding the ending file separator.
-
filename
Returns the filename portion of a file specification string.- Parameters:
filename
- the file path- Returns:
- The filename string with extension.
-
basename
Returns the filename portion of a file specification string. Matches the equally named unix command.- Parameters:
filename
- the file path- Returns:
- The filename string without extension.
-
basename
Returns the filename portion of a file specification string. Matches the equally named unix command.- Parameters:
filename
- the file pathsuffix
- the file suffix- Returns:
- the basename of the file
-
extension
Returns the extension portion of a file specification string. This everything after the last dot '.' in the filename (NOT including the dot).- Parameters:
filename
- the file path- Returns:
- the extension of the file
-
fileExists
Check if a file exits.- Parameters:
fileName
- the file path.- Returns:
- true if file exists.
-
fileRead
Note: the file content is read with platform encoding.- Parameters:
file
- the file path- Returns:
- the file content using the platform encoding.
- Throws:
IOException
- if any
-
fileRead
- Parameters:
file
- the file pathencoding
- the wanted encoding- Returns:
- the file content using the specified encoding.
- Throws:
IOException
- if any
-
fileRead
Note: the file content is read with platform encoding- Parameters:
file
- the file path- Returns:
- the file content using the platform encoding.
- Throws:
IOException
- if any
-
fileRead
- Parameters:
file
- the file pathencoding
- the wanted encoding- Returns:
- the file content using the specified encoding.
- Throws:
IOException
- if any
-
fileAppend
Deprecated.usejava.nio.files.Files.write(filename, data.getBytes(encoding), StandardOpenOption.APPEND, StandardOpenOption.CREATE)
Appends data to a file. The file will be created if it does not exist. Note: the data is written with platform encoding- Parameters:
fileName
- The path of the file to write.data
- The content to write to the file.- Throws:
IOException
- if any
-
fileAppend
Deprecated.usejava.nio.files.Files.write(filename, data.getBytes(encoding), StandardOpenOption.APPEND, StandardOpenOption.CREATE)
Appends data to a file. The file will be created if it does not exist.- Parameters:
fileName
- The path of the file to write.encoding
- The encoding of the file.data
- The content to write to the file.- Throws:
IOException
- if any
-
fileWrite
Writes data to a file. The file will be created if it does not exist. Note: the data is written with platform encoding- Parameters:
fileName
- The path of the file to write.data
- The content to write to the file.- Throws:
IOException
- if any
-
fileWrite
Writes data to a file. The file will be created if it does not exist.- Parameters:
fileName
- The path of the file to write.encoding
- The encoding of the file.data
- The content to write to the file.- Throws:
IOException
- if any
-
fileWrite
Writes data to a file. The file will be created if it does not exist. Note: the data is written with platform encoding- Parameters:
file
- The file to write.data
- The content to write to the file.- Throws:
IOException
- if any- Since:
- 2.0.6
-
fileWrite
Writes data to a file. The file will be created if it does not exist.- Parameters:
file
- The file to write.encoding
- The encoding of the file.data
- The content to write to the file.- Throws:
IOException
- if any- Since:
- 2.0.6
-
fileDelete
Deletes a file.- Parameters:
fileName
- The path of the file to delete.
-
waitFor
Waits for NFS to propagate a file creation, imposing a timeout.- Parameters:
fileName
- The path of the file.seconds
- The maximum time in seconds to wait.- Returns:
- True if file exists.
-
waitFor
Waits for NFS to propagate a file creation, imposing a timeout.- Parameters:
file
- The file.seconds
- The maximum time in seconds to wait.- Returns:
- True if file exists.
-
getFile
Creates a file handle.- Parameters:
fileName
- The path of the file.- Returns:
- A
File
manager.
-
getFilesFromExtension
Given a directory and an array of extensions return an array of compliant files.
TODO Should an ignore list be passed in? TODO Should a recurse flag be passed in?
The given extensions should be like "java" and not like ".java"
- Parameters:
directory
- The path of the directory.extensions
- an array of expected extensions.- Returns:
- An array of files for the wanted extensions.
-
mkdir
Simple way to make a directory- Parameters:
dir
- the directory to create- Throws:
IllegalArgumentException
- if the dir contains illegal Windows characters under Windows OS.- See Also:
-
INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME
-
contentEquals
Compare the contents of two files to determine if they are equal or not.- Parameters:
file1
- the first filefile2
- the second file- Returns:
- true if the content of the files are equal or they both don't exist, false otherwise
- Throws:
IOException
- if any
-
toFile
Convert from aURL
to aFile
.- Parameters:
url
- File URL.- Returns:
- The equivalent
File
object, ornull
if the URL's protocol is notfile
-
toURLs
Convert the array of Files into a list of URLs.- Parameters:
files
- the array of files- Returns:
- the array of URLs
- Throws:
IOException
- if an error occurs
-
removeExtension
Remove extension from filename. iefoo.txt --> foo a\b\c.jpg --> a\b\c a\b\c --> a\b\c
- Parameters:
filename
- the path of the file- Returns:
- the filename minus extension
-
getExtension
Get extension from filename. iefoo.txt --> "txt" a\b\c.jpg --> "jpg" a\b\c --> ""
- Parameters:
filename
- the path of the file- Returns:
- the extension of filename or "" if none
-
removePath
Remove path from filename. Equivalent to the unix commandbasename
ie.a/b/c.txt --> c.txt a.txt --> a.txt
- Parameters:
filepath
- the path of the file- Returns:
- the filename minus path
-
removePath
Remove path from filename. ie.a/b/c.txt --> c.txt a.txt --> a.txt
- Parameters:
filepath
- the path of the filefileSeparatorChar
- the file separator character like / on Unix platforms.- Returns:
- the filename minus path
-
getPath
Get path from filename. Roughly equivalent to the unix commanddirname
. ie.a/b/c.txt --> a/b a.txt --> ""
- Parameters:
filepath
- the filepath- Returns:
- the filename minus path
-
getPath
Get path from filename. ie.a/b/c.txt --> a/b a.txt --> ""
- Parameters:
filepath
- the filepathfileSeparatorChar
- the file separator character like / on Unix platforms.- Returns:
- the filename minus path
-
copyFileToDirectory
public static void copyFileToDirectory(String source, String destinationDirectory) throws IOException Copy file from source to destination. IfdestinationDirectory
does not exist, it (and any parent directories) will be created. If a filesource
indestinationDirectory
exists, it will be overwritten.- Parameters:
source
- An existingFile
to copy.destinationDirectory
- A directory to copysource
into.- Throws:
FileNotFoundException
- ifsource
isn't a normal file.IllegalArgumentException
- ifdestinationDirectory
isn't a directory.IOException
- ifsource
does not exist, the file indestinationDirectory
cannot be written to, or an IO error occurs during copying.
-
copyFileToDirectoryIfModified
public static void copyFileToDirectoryIfModified(String source, String destinationDirectory) throws IOException Copy file from source to destination only if source is newer than the target file. IfdestinationDirectory
does not exist, it (and any parent directories) will be created. If a filesource
indestinationDirectory
exists, it will be overwritten.- Parameters:
source
- An existingFile
to copy.destinationDirectory
- A directory to copysource
into.- Throws:
FileNotFoundException
- ifsource
isn't a normal file.IllegalArgumentException
- ifdestinationDirectory
isn't a directory.IOException
- ifsource
does not exist, the file indestinationDirectory
cannot be written to, or an IO error occurs during copying.
-
copyFileToDirectory
Copy file from source to destination. IfdestinationDirectory
does not exist, it (and any parent directories) will be created. If a filesource
indestinationDirectory
exists, it will be overwritten.- Parameters:
source
- An existingFile
to copy.destinationDirectory
- A directory to copysource
into.- Throws:
FileNotFoundException
- ifsource
isn't a normal file.IllegalArgumentException
- ifdestinationDirectory
isn't a directory.IOException
- ifsource
does not exist, the file indestinationDirectory
cannot be written to, or an IO error occurs during copying.
-
copyFileToDirectoryIfModified
public static void copyFileToDirectoryIfModified(File source, File destinationDirectory) throws IOException Copy file from source to destination only if source is newer than the target file. IfdestinationDirectory
does not exist, it (and any parent directories) will be created. If a filesource
indestinationDirectory
exists, it will be overwritten.- Parameters:
source
- An existingFile
to copy.destinationDirectory
- A directory to copysource
into.- Throws:
FileNotFoundException
- ifsource
isn't a normal file.IllegalArgumentException
- ifdestinationDirectory
isn't a directory.IOException
- ifsource
does not exist, the file indestinationDirectory
cannot be written to, or an IO error occurs during copying.
-
mkDirs
Creates a number of directories, as delivered from DirectoryScanner- Parameters:
sourceBase
- The basedir used for the directory scandirs
- The getIncludedDirs from the dirscannerdestination
- The base dir of the output structure- Throws:
IOException
- io issue
-
copyFile
Copy file from source to destination. The directories up todestination
will be created if they don't already exist.destination
will be overwritten if it already exists.- Parameters:
source
- An existing non-directoryFile
to copy bytes from.destination
- A non-directoryFile
to write bytes to (possibly overwriting).- Throws:
IOException
- ifsource
does not exist,destination
cannot be written to, or an IO error occurs during copying.FileNotFoundException
- ifdestination
is a directory (usecopyFileToDirectory(java.lang.String, java.lang.String)
).
-
linkFile
Link file from destination to source. The directories up todestination
will be created if they don't already exist.destination
will be overwritten if it already exists.- Parameters:
source
- An existing non-directoryFile
to link to.destination
- A non-directoryFile
becoming the link (possibly overwriting).- Throws:
IOException
- ifsource
does not exist,destination
cannot be created, or an IO error occurs during linking.FileNotFoundException
- ifdestination
is a directory (usecopyFileToDirectory(java.lang.String, java.lang.String)
).
-
copyFileIfModified
Copy file from source to destination only if source timestamp is later than the destination timestamp. The directories up todestination
will be created if they don't already exist.destination
will be overwritten if it already exists.- Parameters:
source
- An existing non-directoryFile
to copy bytes from.destination
- A non-directoryFile
to write bytes to (possibly overwriting).- Returns:
- true if no problem occured
- Throws:
IOException
- ifsource
does not exist,destination
cannot be written to, or an IO error occurs during copying.
-
copyURLToFile
Copies bytes from the URLsource
to a filedestination
. The directories up todestination
will be created if they don't already exist.destination
will be overwritten if it already exists.- Parameters:
source
- AURL
to copy bytes from.destination
- A non-directoryFile
to write bytes to (possibly overwriting).- Throws:
IOException
- ifsource
URL cannot be openeddestination
cannot be written to- an IO error occurs during copying
-
copyStreamToFile
Copies bytes from theInputStream
source
to a filedestination
. The directories up todestination
will be created if they don't already exist.destination
will be overwritten if it already exists.- Parameters:
source
- AnInputStream
to copy bytes from. This stream is guaranteed to be closed.destination
- A non-directoryFile
to write bytes to (possibly overwriting).- Throws:
IOException
- ifsource
URL cannot be openeddestination
cannot be written to- an IO error occurs during copying
-
normalize
Normalize a path. Eliminates "/../" and "/./" in a string. Returnsnull
if the ..'s went past the root. Eg:/foo// --> /foo/ /foo/./ --> /foo/ /foo/../bar --> /bar /foo/../bar/ --> /bar/ /foo/../bar/../baz --> /baz //foo//./bar --> /foo/bar /../ --> null
- Parameters:
path
- the path to normalize- Returns:
- the normalized String, or
null
if too many ..'s.
-
catPath
Will concatenate 2 paths. Paths with
Eg.,..
will be properly handled./a/b/c + d = /a/b/d /a/b/c + ../d = /a/d
Thieved from Tomcat sources...
- Parameters:
lookupPath
- a pathpath
- the path to concatenate- Returns:
- The concatenated paths, or null if error occurs
-
resolveFile
Resolve a filefilename
to it's canonical form. Iffilename
is relative (doesn't start with/
), it will be resolved relative tobaseFile
, otherwise it is treated as a normal root-relative path.- Parameters:
baseFile
- Where to resolvefilename
from, iffilename
is relative.filename
- Absolute or relative file path to resolve.- Returns:
- The canonical
File
offilename
.
-
forceDelete
Delete a file. If file is directory delete it and all sub-directories.- Parameters:
file
- the file path- Throws:
IOException
- if any
-
forceDelete
Delete a file. If file is directory delete it and all sub-directories.- Parameters:
file
- a file- Throws:
IOException
- if any
-
forceDeleteOnExit
Schedule a file to be deleted when JVM exits. If file is directory delete it and all sub-directories.- Parameters:
file
- a file- Throws:
IOException
- if any
-
forceMkdir
Make a directory.- Parameters:
file
- not null- Throws:
IOException
- If there already exists a file with specified name or the directory is unable to be createdIllegalArgumentException
- if the file contains illegal Windows characters under Windows OS.- See Also:
-
INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME
-
deleteDirectory
Recursively delete a directory.- Parameters:
directory
- a directory- Throws:
IOException
- if any
-
deleteDirectory
Recursively delete a directory.- Parameters:
directory
- a directory- Throws:
IOException
- if any
-
cleanDirectory
Clean a directory without deleting it.- Parameters:
directory
- a directory- Throws:
IOException
- if any
-
cleanDirectory
Clean a directory without deleting it.- Parameters:
directory
- a directory- Throws:
IOException
- if any
-
sizeOfDirectory
Recursively count size of a directory.- Parameters:
directory
- a directory- Returns:
- size of directory in bytes.
-
sizeOfDirectory
Recursively count size of a directory.- Parameters:
directory
- a directory- Returns:
- size of directory in bytes.
-
getFiles
public static List<File> getFiles(File directory, String includes, String excludes) throws IOException Return the files contained in the directory, using inclusion and exclusion Ant patterns, including the directory name in each of the files- Parameters:
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separated- Returns:
- a list of File objects
- Throws:
IOException
- io issue- See Also:
-
getFiles
public static List<File> getFiles(File directory, String includes, String excludes, boolean includeBasedir) throws IOException Return the files contained in the directory, using inclusion and exclusion Ant patterns- Parameters:
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separatedincludeBasedir
- true to include the base dir in each file- Returns:
- a list of File objects
- Throws:
IOException
- io issue- See Also:
-
getFileNames
public static List<String> getFileNames(File directory, String includes, String excludes, boolean includeBasedir) throws IOException Return a list of files as String depending options. This method use case sensitive file name.- Parameters:
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separatedincludeBasedir
- true to include the base dir in each String of file- Returns:
- a list of files as String
- Throws:
IOException
- io issue
-
getFileNames
public static List<String> getFileNames(File directory, String includes, String excludes, boolean includeBasedir, boolean isCaseSensitive) throws IOException Return a list of files as String depending options.- Parameters:
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separatedincludeBasedir
- true to include the base dir in each String of fileisCaseSensitive
- true if case sensitive- Returns:
- a list of files as String
- Throws:
IOException
- io issue
-
getDirectoryNames
public static List<String> getDirectoryNames(File directory, String includes, String excludes, boolean includeBasedir) throws IOException Return a list of directories as String depending options. This method use case sensitive file name.- Parameters:
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separatedincludeBasedir
- true to include the base dir in each String of file- Returns:
- a list of directories as String
- Throws:
IOException
- io issue
-
getDirectoryNames
public static List<String> getDirectoryNames(File directory, String includes, String excludes, boolean includeBasedir, boolean isCaseSensitive) throws IOException Return a list of directories as String depending options.- Parameters:
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separatedincludeBasedir
- true to include the base dir in each String of fileisCaseSensitive
- true if case sensitive- Returns:
- a list of directories as String
- Throws:
IOException
- io issue
-
getFileAndDirectoryNames
public static List<String> getFileAndDirectoryNames(File directory, String includes, String excludes, boolean includeBasedir, boolean isCaseSensitive, boolean getFiles, boolean getDirectories) throws IOException Return a list of files as String depending options.- Parameters:
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separatedincludeBasedir
- true to include the base dir in each String of fileisCaseSensitive
- true if case sensitivegetFiles
- true if get filesgetDirectories
- true if get directories- Returns:
- a list of files as String
- Throws:
IOException
- io issue
-
copyDirectory
public static void copyDirectory(File sourceDirectory, File destinationDirectory) throws IOException Copy a directory to an other one.- Parameters:
sourceDirectory
- the source dirdestinationDirectory
- the target dir- Throws:
IOException
- if any
-
copyDirectory
public static void copyDirectory(File sourceDirectory, File destinationDirectory, String includes, String excludes) throws IOException Copy a directory to an other one.- Parameters:
sourceDirectory
- the source dirdestinationDirectory
- the target dirincludes
- include patternexcludes
- exclude pattern- Throws:
IOException
- if any- See Also:
-
copyDirectoryLayout
public static void copyDirectoryLayout(File sourceDirectory, File destinationDirectory, String[] includes, String[] excludes) throws IOException Copies a entire directory layout : no files will be copied only directories
Note:- It will include empty directories.
- The
sourceDirectory
must exists.
- Parameters:
sourceDirectory
- the source dirdestinationDirectory
- the target dirincludes
- include patternexcludes
- exclude pattern- Throws:
IOException
- if any- Since:
- 1.5.7
-
copyDirectoryStructure
public static void copyDirectoryStructure(File sourceDirectory, File destinationDirectory) throws IOException Copies a entire directory structure.
Note:- It will include empty directories.
- The
sourceDirectory
must exists.
- Parameters:
sourceDirectory
- the source dirdestinationDirectory
- the target dir- Throws:
IOException
- if any
-
copyDirectoryStructureIfModified
public static void copyDirectoryStructureIfModified(File sourceDirectory, File destinationDirectory) throws IOException Copies an entire directory structure but only source files with timestamp later than the destinations'.
Note:- It will include empty directories.
- The
sourceDirectory
must exists.
- Parameters:
sourceDirectory
- the source dirdestinationDirectory
- the target dir- Throws:
IOException
- if any
-
rename
Renames a file, even if that involves crossing file system boundaries.
This will remove
to
(if it exists), ensure thatto
's parent directory exists and movefrom
, which involves deletingfrom
as well.- Parameters:
from
- the file to moveto
- the new file name- Throws:
IOException
- if anything bad happens during this process. Note thatto
may have been deleted already when this happens.
-
createTempFile
Create a temporary file in a given directory.
The file denoted by the returned abstract pathname did not exist before this method was invoked, any subsequent invocation of this method will yield a different file name.
The filename is prefixNNNNNsuffix where NNNN is a random number
This method is different to
File.createTempFile(String, String, File)
of JDK 1.2 as it doesn't create the file itself. It uses the location pointed to by java.io.tmpdir when the parentDir attribute is null.To delete automatically the file created by this method, use the
File.deleteOnExit()
method.- Parameters:
prefix
- prefix before the random numbersuffix
- file extension; include the '.'parentDir
- Directory to create the temporary file in-java.io.tmpdir
used if not specificed- Returns:
- a File reference to the new temporary file.
-
copyFile
public static void copyFile(File from, File to, String encoding, FileUtils.FilterWrapper[] wrappers) throws IOException If wrappers is null or empty, the file will be copy only ifto.lastModified() < from.lastModified()
- Parameters:
from
- the file to copyto
- the destination fileencoding
- the file output encoding (only if wrappers is not empty)wrappers
- array ofFileUtils.FilterWrapper
- Throws:
IOException
- if an IO error occurs during copying or filtering
-
copyFile
public static void copyFile(File from, File to, String encoding, FileUtils.FilterWrapper[] wrappers, boolean overwrite) throws IOException If wrappers is null or empty, the file will be copy only ifto.lastModified() < from.lastModified()
, if overwrite is true- Parameters:
from
- the file to copyto
- the destination fileencoding
- the file output encoding (only if wrappers is not empty)wrappers
- array ofFileUtils.FilterWrapper
overwrite
- if true and wrappers is null or empty, the file will be copied even ifto.lastModified() < from.lastModified()
- Throws:
IOException
- if an IO error occurs during copying or filtering- Since:
- 1.5.2
-
loadFile
Note: the file content is read with platform encoding- Parameters:
file
- the file- Returns:
- a List containing every every line not starting with # and not empty
- Throws:
IOException
- if any
-
isValidWindowsFileName
For Windows OS, check if the file name contains any of the following characters:":", "*", "?", "\"", "<", ">", "|"
- Parameters:
f
- not null file- Returns:
false
if the file path contains any of forbidden Windows characters,true
if the Os is not Windows or if the file path respect the Windows constraints.- Since:
- 1.5.2
- See Also:
-
INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME
-
java.nio.files.Files.write(filename, data.getBytes(encoding), StandardOpenOption.APPEND, StandardOpenOption.CREATE)