public class FileUtils
extends java.lang.Object
This class provides basic facilities for manipulating files and file paths.
Methods 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 through getPath(java.lang.String)
index.html
-- retrievable through removePath(java.lang.String)
/www/hosted/mysite/index
-- retrievable through removeExtension(java.lang.String)
html
-- retrievable through getExtension(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.
Modifier and Type | Class and Description |
---|---|
static class |
FileUtils.FilterWrapper |
Modifier and Type | Field and Description |
---|---|
private static long |
FILE_COPY_BUFFER_SIZE
The file copy buffer size (30 MB)
|
static java.lang.String |
FS
The vm file separator
|
private static java.lang.String[] |
INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME
Non-valid Characters for naming files, folders under Windows:
":", "*", "?", "\"", "<", ">", "|" |
static int |
ONE_GB
The number of bytes in a gigabyte.
|
static int |
ONE_KB
The number of bytes in a kilobyte.
|
static int |
ONE_MB
The number of bytes in a megabyte.
|
Constructor and Description |
---|
FileUtils() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
basename(java.lang.String filename)
Returns the filename portion of a file specification string.
|
static java.lang.String |
basename(java.lang.String filename,
java.lang.String suffix)
Returns the filename portion of a file specification string.
|
private static java.util.List<java.lang.String> |
blendFilesToVector(java.util.List<java.lang.String> v,
java.lang.String[] files)
Private helper method for getFilesFromExtension()
|
static java.lang.String |
byteCountToDisplaySize(int size)
Returns a human-readable version of the file size (original is in bytes).
|
static java.lang.String |
catPath(java.lang.String lookupPath,
java.lang.String path)
Will concatenate 2 paths.
|
private static void |
checkCanWrite(java.io.File destination) |
static void |
cleanDirectory(java.io.File directory)
Clean a directory without deleting it.
|
static void |
cleanDirectory(java.lang.String directory)
Clean a directory without deleting it.
|
private static void |
cleanDirectoryOnExit(java.io.File directory)
Clean a directory without deleting it.
|
static boolean |
contentEquals(java.io.File file1,
java.io.File file2)
Compare the contents of two files to determine if they are equal or not.
|
static void |
copyDirectory(java.io.File sourceDirectory,
java.io.File destinationDirectory)
Copy a directory to an other one.
|
static void |
copyDirectory(java.io.File sourceDirectory,
java.io.File destinationDirectory,
java.lang.String includes,
java.lang.String excludes)
Copy a directory to an other one.
|
static void |
copyDirectoryLayout(java.io.File sourceDirectory,
java.io.File destinationDirectory,
java.lang.String[] includes,
java.lang.String[] excludes)
Copies a entire directory layout : no files will be copied only directories
|
static void |
copyDirectoryStructure(java.io.File sourceDirectory,
java.io.File destinationDirectory)
Copies a entire directory structure.
|
private static void |
copyDirectoryStructure(java.io.File sourceDirectory,
java.io.File destinationDirectory,
java.io.File rootDestinationDirectory,
boolean onlyModifiedFiles) |
static void |
copyDirectoryStructureIfModified(java.io.File sourceDirectory,
java.io.File destinationDirectory)
Copies an entire directory structure but only source files with timestamp later than the destinations'.
|
static void |
copyFile(java.io.File source,
java.io.File destination)
Copy file from source to destination.
|
static void |
copyFile(java.io.File from,
java.io.File to,
java.lang.String encoding,
FileUtils.FilterWrapper[] wrappers)
If wrappers is null or empty, the file will be copy only if
to.lastModified() < from.lastModified() |
static void |
copyFile(java.io.File from,
java.io.File to,
java.lang.String encoding,
FileUtils.FilterWrapper[] wrappers,
boolean overwrite)
If wrappers is null or empty, the file will be copy only if
to.lastModified() < from.lastModified() , if overwrite is true |
static boolean |
copyFileIfModified(java.io.File source,
java.io.File destination)
Copy file from source to destination only if source timestamp is later than the destination timestamp.
|
static void |
copyFileToDirectory(java.io.File source,
java.io.File destinationDirectory)
Copy file from source to destination.
|
static void |
copyFileToDirectory(java.lang.String source,
java.lang.String destinationDirectory)
Copy file from source to destination.
|
static void |
copyFileToDirectoryIfModified(java.io.File source,
java.io.File destinationDirectory)
Copy file from source to destination only if source is newer than the target file.
|
static void |
copyFileToDirectoryIfModified(java.lang.String source,
java.lang.String destinationDirectory)
Copy file from source to destination only if source is newer than the target file.
|
static void |
copyStreamToFile(InputStreamFacade source,
java.io.File destination)
Copies bytes from the
InputStream source to a file destination . |
static void |
copyURLToFile(java.net.URL source,
java.io.File destination)
Copies bytes from the URL
source to a file destination . |
static java.io.File |
createTempFile(java.lang.String prefix,
java.lang.String suffix,
java.io.File parentDir)
Create a temporary file in a given directory.
|
static void |
deleteDirectory(java.io.File directory)
Recursively delete a directory.
|
static void |
deleteDirectory(java.lang.String directory)
Recursively delete a directory.
|
private static void |
deleteDirectoryOnExit(java.io.File directory)
Recursively schedule directory for deletion on JVM exit.
|
private static boolean |
deleteFile(java.io.File file)
Accommodate Windows bug encountered in both Sun and IBM JDKs.
|
static java.lang.String |
dirname(java.lang.String filename)
Returns the directory path portion of a file specification string.
|
private static void |
doCopyFile(java.io.File source,
java.io.File destination) |
private static void |
doCopyFileUsingLegacyIO(java.io.File source,
java.io.File destination) |
private static void |
doCopyFileUsingNewIO(java.io.File source,
java.io.File destination) |
static java.lang.String |
extension(java.lang.String filename)
Returns the extension portion of a file specification string.
|
static void |
fileAppend(java.lang.String fileName,
java.lang.String data)
Appends data to a file.
|
static void |
fileAppend(java.lang.String fileName,
java.lang.String encoding,
java.lang.String data)
Appends data to a file.
|
static void |
fileDelete(java.lang.String fileName)
Deletes a file.
|
static boolean |
fileExists(java.lang.String fileName)
Check if a file exits.
|
static java.lang.String |
filename(java.lang.String filename)
Returns the filename portion of a file specification string.
|
static java.lang.String |
fileRead(java.io.File file)
Note: the file content is read with platform encoding
|
static java.lang.String |
fileRead(java.io.File file,
java.lang.String encoding) |
static java.lang.String |
fileRead(java.lang.String file)
Note: the file content is read with platform encoding.
|
static java.lang.String |
fileRead(java.lang.String file,
java.lang.String encoding) |
static void |
fileWrite(java.io.File file,
java.lang.String data)
Writes data to a file.
|
static void |
fileWrite(java.io.File file,
java.lang.String encoding,
java.lang.String data)
Writes data to a file.
|
static void |
fileWrite(java.lang.String fileName,
java.lang.String data)
Writes data to a file.
|
static void |
fileWrite(java.lang.String fileName,
java.lang.String encoding,
java.lang.String data)
Writes data to a file.
|
static void |
forceDelete(java.io.File file)
Delete a file.
|
static void |
forceDelete(java.lang.String file)
Delete a file.
|
static void |
forceDeleteOnExit(java.io.File file)
Schedule a file to be deleted when JVM exits.
|
static void |
forceMkdir(java.io.File file)
Make a directory.
|
static java.lang.String[] |
getDefaultExcludes() |
static java.util.List<java.lang.String> |
getDefaultExcludesAsList() |
static java.lang.String |
getDefaultExcludesAsString() |
static java.util.List<java.lang.String> |
getDirectoryNames(java.io.File directory,
java.lang.String includes,
java.lang.String excludes,
boolean includeBasedir)
Return a list of directories as String depending options.
|
static java.util.List<java.lang.String> |
getDirectoryNames(java.io.File directory,
java.lang.String includes,
java.lang.String excludes,
boolean includeBasedir,
boolean isCaseSensitive)
Return a list of directories as String depending options.
|
static java.lang.String |
getExtension(java.lang.String filename)
Get extension from filename.
|
static java.io.File |
getFile(java.lang.String fileName)
Creates a file handle.
|
static java.util.List<java.lang.String> |
getFileAndDirectoryNames(java.io.File directory,
java.lang.String includes,
java.lang.String excludes,
boolean includeBasedir,
boolean isCaseSensitive,
boolean getFiles,
boolean getDirectories)
Return a list of files as String depending options.
|
static java.util.List<java.lang.String> |
getFileNames(java.io.File directory,
java.lang.String includes,
java.lang.String excludes,
boolean includeBasedir)
Return a list of files as String depending options.
|
static java.util.List<java.lang.String> |
getFileNames(java.io.File directory,
java.lang.String includes,
java.lang.String excludes,
boolean includeBasedir,
boolean isCaseSensitive)
Return a list of files as String depending options.
|
static java.util.List<java.io.File> |
getFiles(java.io.File directory,
java.lang.String includes,
java.lang.String excludes)
Return the files contained in the directory, using inclusion and exclusion Ant patterns, including the directory
name in each of the files
|
static java.util.List<java.io.File> |
getFiles(java.io.File directory,
java.lang.String includes,
java.lang.String excludes,
boolean includeBasedir)
Return the files contained in the directory, using inclusion and exclusion Ant patterns
|
static java.lang.String[] |
getFilesFromExtension(java.lang.String directory,
java.lang.String[] extensions)
Given a directory and an array of extensions return an array of compliant files.
|
static java.lang.String |
getPath(java.lang.String filepath)
Get path from filename.
|
static java.lang.String |
getPath(java.lang.String filepath,
char fileSeparatorChar)
Get path from filename.
|
private static boolean |
isSourceNewerThanDestination(java.io.File source,
java.io.File destination) |
private static boolean |
isValidFile(java.lang.String file,
java.lang.String[] extensions)
Checks to see if a file is of a particular type(s).
|
static boolean |
isValidWindowsFileName(java.io.File f)
For Windows OS, check if the file name contains any of the following characters:
":", "*", "?", "\"", "<", ">", "|" |
static java.util.List<java.lang.String> |
loadFile(java.io.File file)
Note: the file content is read with platform encoding
|
static void |
mkdir(java.lang.String dir)
Simple way to make a directory
|
static void |
mkDirs(java.io.File sourceBase,
java.lang.String[] dirs,
java.io.File destination)
Creates a number of directories, as delivered from DirectoryScanner
|
private static void |
mkdirsFor(java.io.File destination) |
static java.lang.String |
normalize(java.lang.String path)
Normalize a path.
|
static java.lang.String |
removeExtension(java.lang.String filename)
Remove extension from filename.
|
static java.lang.String |
removePath(java.lang.String filepath)
Remove path from filename.
|
static java.lang.String |
removePath(java.lang.String filepath,
char fileSeparatorChar)
Remove path from filename.
|
static void |
rename(java.io.File from,
java.io.File to)
Renames a file, even if that involves crossing file system boundaries.
|
static java.io.File |
resolveFile(java.io.File baseFile,
java.lang.String filename)
Resolve a file
filename to it's canonical form. |
static long |
sizeOfDirectory(java.io.File directory)
Recursively count size of a directory.
|
static long |
sizeOfDirectory(java.lang.String directory)
Recursively count size of a directory.
|
static java.io.File |
toFile(java.net.URL url)
Convert from a
URL to a File . |
static java.net.URL[] |
toURLs(java.io.File[] files)
Convert the array of Files into a list of URLs.
|
static boolean |
waitFor(java.io.File file,
int seconds)
Waits for NFS to propagate a file creation, imposing a timeout.
|
static boolean |
waitFor(java.lang.String fileName,
int seconds)
Waits for NFS to propagate a file creation, imposing a timeout.
|
public static final int ONE_KB
public static final int ONE_MB
public static final int ONE_GB
private static final long FILE_COPY_BUFFER_SIZE
public static java.lang.String FS
private static final java.lang.String[] INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME
":", "*", "?", "\"", "<", ">", "|"
public static java.lang.String[] getDefaultExcludes()
AbstractScanner.DEFAULTEXCLUDES
public static java.util.List<java.lang.String> getDefaultExcludesAsList()
getDefaultExcludes()
public static java.lang.String getDefaultExcludesAsString()
AbstractScanner.DEFAULTEXCLUDES
,
StringUtils.join(Object[], String)
public static java.lang.String byteCountToDisplaySize(int size)
size
- The number of bytes.public static java.lang.String dirname(java.lang.String filename)
filename
- the file pathpublic static java.lang.String filename(java.lang.String filename)
filename
- the file pathpublic static java.lang.String basename(java.lang.String filename)
filename
- the file pathpublic static java.lang.String basename(java.lang.String filename, java.lang.String suffix)
filename
- the file pathsuffix
- the file suffixpublic static java.lang.String extension(java.lang.String filename)
filename
- the file pathpublic static boolean fileExists(java.lang.String fileName)
fileName
- the file path.public static java.lang.String fileRead(java.lang.String file) throws java.io.IOException
file
- the file pathjava.io.IOException
- if anypublic static java.lang.String fileRead(java.lang.String file, java.lang.String encoding) throws java.io.IOException
file
- the file pathencoding
- the wanted encodingjava.io.IOException
- if anypublic static java.lang.String fileRead(java.io.File file) throws java.io.IOException
file
- the file pathjava.io.IOException
- if anypublic static java.lang.String fileRead(java.io.File file, java.lang.String encoding) throws java.io.IOException
file
- the file pathencoding
- the wanted encodingjava.io.IOException
- if anypublic static void fileAppend(java.lang.String fileName, java.lang.String data) throws java.io.IOException
fileName
- The path of the file to write.data
- The content to write to the file.java.io.IOException
- if anypublic static void fileAppend(java.lang.String fileName, java.lang.String encoding, java.lang.String data) throws java.io.IOException
fileName
- The path of the file to write.encoding
- The encoding of the file.data
- The content to write to the file.java.io.IOException
- if anypublic static void fileWrite(java.lang.String fileName, java.lang.String data) throws java.io.IOException
fileName
- The path of the file to write.data
- The content to write to the file.java.io.IOException
- if anypublic static void fileWrite(java.lang.String fileName, java.lang.String encoding, java.lang.String data) throws java.io.IOException
fileName
- The path of the file to write.encoding
- The encoding of the file.data
- The content to write to the file.java.io.IOException
- if anypublic static void fileWrite(java.io.File file, java.lang.String data) throws java.io.IOException
file
- The file to write.data
- The content to write to the file.java.io.IOException
- if anypublic static void fileWrite(java.io.File file, java.lang.String encoding, java.lang.String data) throws java.io.IOException
file
- The file to write.encoding
- The encoding of the file.data
- The content to write to the file.java.io.IOException
- if anypublic static void fileDelete(java.lang.String fileName)
fileName
- The path of the file to delete.public static boolean waitFor(java.lang.String fileName, int seconds)
fileName
- The path of the file.seconds
- The maximum time in seconds to wait.public static boolean waitFor(java.io.File file, int seconds)
file
- The file.seconds
- The maximum time in seconds to wait.public static java.io.File getFile(java.lang.String fileName)
fileName
- The path of the file.File
manager.public static java.lang.String[] getFilesFromExtension(java.lang.String directory, java.lang.String[] extensions)
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"
directory
- The path of the directory.extensions
- an array of expected extensions.private static java.util.List<java.lang.String> blendFilesToVector(java.util.List<java.lang.String> v, java.lang.String[] files)
private static boolean isValidFile(java.lang.String file, java.lang.String[] extensions)
public static void mkdir(java.lang.String dir)
dir
- the directory to createjava.lang.IllegalArgumentException
- if the dir contains illegal Windows characters under Windows OS.INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME
public static boolean contentEquals(java.io.File file1, java.io.File file2) throws java.io.IOException
file1
- the first filefile2
- the second filejava.io.IOException
- if anypublic static java.io.File toFile(java.net.URL url)
URL
to a File
.url
- File URL.File
object, or null
if the URL's protocol is not
file
public static java.net.URL[] toURLs(java.io.File[] files) throws java.io.IOException
files
- the array of filesjava.io.IOException
- if an error occurspublic static java.lang.String removeExtension(java.lang.String filename)
foo.txt --> foo a\b\c.jpg --> a\b\c a\b\c --> a\b\c
filename
- the path of the filepublic static java.lang.String getExtension(java.lang.String filename)
foo.txt --> "txt" a\b\c.jpg --> "jpg" a\b\c --> ""
filename
- the path of the filepublic static java.lang.String removePath(java.lang.String filepath)
basename
ie.
a/b/c.txt --> c.txt a.txt --> a.txt
filepath
- the path of the filepublic static java.lang.String removePath(java.lang.String filepath, char fileSeparatorChar)
a/b/c.txt --> c.txt a.txt --> a.txt
filepath
- the path of the filefileSeparatorChar
- the file separator character like / on Unix platforms.public static java.lang.String getPath(java.lang.String filepath)
dirname
. ie.
a/b/c.txt --> a/b a.txt --> ""
filepath
- the filepathpublic static java.lang.String getPath(java.lang.String filepath, char fileSeparatorChar)
a/b/c.txt --> a/b a.txt --> ""
filepath
- the filepathfileSeparatorChar
- the file separator character like / on Unix platforms.public static void copyFileToDirectory(java.lang.String source, java.lang.String destinationDirectory) throws java.io.IOException
destinationDirectory
does not exist, it (and any parent
directories) will be created. If a file source
in destinationDirectory
exists, it will
be overwritten.source
- An existing File
to copy.destinationDirectory
- A directory to copy source
into.java.io.FileNotFoundException
- if source
isn't a normal file.java.lang.IllegalArgumentException
- if destinationDirectory
isn't a directory.java.io.IOException
- if source
does not exist, the file in destinationDirectory
cannot
be written to, or an IO error occurs during copying.public static void copyFileToDirectoryIfModified(java.lang.String source, java.lang.String destinationDirectory) throws java.io.IOException
destinationDirectory
does not exist, it (and any parent directories) will be created. If a file
source
in destinationDirectory
exists, it will be overwritten.source
- An existing File
to copy.destinationDirectory
- A directory to copy source
into.java.io.FileNotFoundException
- if source
isn't a normal file.java.lang.IllegalArgumentException
- if destinationDirectory
isn't a directory.java.io.IOException
- if source
does not exist, the file in destinationDirectory
cannot
be written to, or an IO error occurs during copying.public static void copyFileToDirectory(java.io.File source, java.io.File destinationDirectory) throws java.io.IOException
destinationDirectory
does not exist, it (and any parent
directories) will be created. If a file source
in destinationDirectory
exists, it will
be overwritten.source
- An existing File
to copy.destinationDirectory
- A directory to copy source
into.java.io.FileNotFoundException
- if source
isn't a normal file.java.lang.IllegalArgumentException
- if destinationDirectory
isn't a directory.java.io.IOException
- if source
does not exist, the file in destinationDirectory
cannot
be written to, or an IO error occurs during copying.public static void copyFileToDirectoryIfModified(java.io.File source, java.io.File destinationDirectory) throws java.io.IOException
destinationDirectory
does not exist, it (and any parent directories) will be created. If a file
source
in destinationDirectory
exists, it will be overwritten.source
- An existing File
to copy.destinationDirectory
- A directory to copy source
into.java.io.FileNotFoundException
- if source
isn't a normal file.java.lang.IllegalArgumentException
- if destinationDirectory
isn't a directory.java.io.IOException
- if source
does not exist, the file in destinationDirectory
cannot
be written to, or an IO error occurs during copying.public static void mkDirs(java.io.File sourceBase, java.lang.String[] dirs, java.io.File destination) throws java.io.IOException
sourceBase
- The basedir used for the directory scandirs
- The getIncludedDirs from the dirscannerdestination
- The base dir of the output structurejava.io.IOException
public static void copyFile(java.io.File source, java.io.File destination) throws java.io.IOException
destination
will be created if they
don't already exist. destination
will be overwritten if it already exists.source
- An existing non-directory File
to copy bytes from.destination
- A non-directory File
to write bytes to (possibly overwriting).java.io.IOException
- if source
does not exist, destination
cannot be written to, or an
IO error occurs during copying.java.io.FileNotFoundException
- if destination
is a directory (use
copyFileToDirectory(java.lang.String, java.lang.String)
).private static void doCopyFile(java.io.File source, java.io.File destination) throws java.io.IOException
java.io.IOException
private static void doCopyFileUsingLegacyIO(java.io.File source, java.io.File destination) throws java.io.IOException
java.io.IOException
private static void doCopyFileUsingNewIO(java.io.File source, java.io.File destination) throws java.io.IOException
java.io.IOException
public static boolean copyFileIfModified(java.io.File source, java.io.File destination) throws java.io.IOException
destination
will be created if they don't already exist. destination
will be overwritten if it already exists.source
- An existing non-directory File
to copy bytes from.destination
- A non-directory File
to write bytes to (possibly overwriting).java.io.IOException
- if source
does not exist, destination
cannot be written to, or an
IO error occurs during copying.public static void copyURLToFile(java.net.URL source, java.io.File destination) throws java.io.IOException
source
to a file destination
. The directories up to
destination
will be created if they don't already exist. destination
will be
overwritten if it already exists.source
- A URL
to copy bytes from.destination
- A non-directory File
to write bytes to (possibly overwriting).java.io.IOException
- if
source
URL cannot be openeddestination
cannot be written topublic static void copyStreamToFile(InputStreamFacade source, java.io.File destination) throws java.io.IOException
InputStream
source
to a file destination
. The directories
up to destination
will be created if they don't already exist. destination
will be
overwritten if it already exists.source
- An InputStream
to copy bytes from. This stream is guaranteed to be closed.destination
- A non-directory File
to write bytes to (possibly overwriting).java.io.IOException
- if
source
URL cannot be openeddestination
cannot be written toprivate static void checkCanWrite(java.io.File destination) throws java.io.IOException
java.io.IOException
private static void mkdirsFor(java.io.File destination)
public static java.lang.String normalize(java.lang.String path)
null
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
path
- the path to normalizenull
if too many ..'s.public static java.lang.String catPath(java.lang.String lookupPath, java.lang.String path)
Will concatenate 2 paths. Paths with ..
will be properly handled.
/a/b/c + d = /a/b/d /a/b/c + ../d = /a/d
Thieved from Tomcat sources...
lookupPath
- a pathpath
- the path to concatenatepublic static java.io.File resolveFile(java.io.File baseFile, java.lang.String filename)
filename
to it's canonical form. If filename
is relative (doesn't start
with /
), it will be resolved relative to baseFile
, otherwise it is treated as a normal
root-relative path.baseFile
- Where to resolve filename
from, if filename
is relative.filename
- Absolute or relative file path to resolve.File
of filename
.public static void forceDelete(java.lang.String file) throws java.io.IOException
file
- the file pathjava.io.IOException
- if anypublic static void forceDelete(java.io.File file) throws java.io.IOException
file
- a filejava.io.IOException
- if anyprivate static boolean deleteFile(java.io.File file) throws java.io.IOException
file
- a filejava.io.IOException
- if anypublic static void forceDeleteOnExit(java.io.File file) throws java.io.IOException
file
- a filejava.io.IOException
- if anyprivate static void deleteDirectoryOnExit(java.io.File directory) throws java.io.IOException
directory
- a directoryjava.io.IOException
- if anyprivate static void cleanDirectoryOnExit(java.io.File directory) throws java.io.IOException
directory
- a directoryjava.io.IOException
- if anypublic static void forceMkdir(java.io.File file) throws java.io.IOException
file
- not nulljava.io.IOException
- If there already exists a file with specified name or the directory is unable to be createdjava.lang.IllegalArgumentException
- if the file contains illegal Windows characters under Windows OS.INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME
public static void deleteDirectory(java.lang.String directory) throws java.io.IOException
directory
- a directoryjava.io.IOException
- if anypublic static void deleteDirectory(java.io.File directory) throws java.io.IOException
directory
- a directoryjava.io.IOException
- if anypublic static void cleanDirectory(java.lang.String directory) throws java.io.IOException
directory
- a directoryjava.io.IOException
- if anypublic static void cleanDirectory(java.io.File directory) throws java.io.IOException
directory
- a directoryjava.io.IOException
- if anypublic static long sizeOfDirectory(java.lang.String directory)
directory
- a directorypublic static long sizeOfDirectory(java.io.File directory)
directory
- a directorypublic static java.util.List<java.io.File> getFiles(java.io.File directory, java.lang.String includes, java.lang.String excludes) throws java.io.IOException
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separatedjava.io.IOException
getFileNames(File, String, String, boolean)
public static java.util.List<java.io.File> getFiles(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir) throws java.io.IOException
directory
- the directory to scanincludes
- the includes pattern, comma separatedexcludes
- the excludes pattern, comma separatedincludeBasedir
- true to include the base dir in each filejava.io.IOException
getFileNames(File, String, String, boolean)
public static java.util.List<java.lang.String> getFileNames(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir) throws java.io.IOException
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 filejava.io.IOException
public static java.util.List<java.lang.String> getFileNames(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir, boolean isCaseSensitive) throws java.io.IOException
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 sensitivejava.io.IOException
public static java.util.List<java.lang.String> getDirectoryNames(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir) throws java.io.IOException
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 filejava.io.IOException
public static java.util.List<java.lang.String> getDirectoryNames(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir, boolean isCaseSensitive) throws java.io.IOException
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 sensitivejava.io.IOException
public static java.util.List<java.lang.String> getFileAndDirectoryNames(java.io.File directory, java.lang.String includes, java.lang.String excludes, boolean includeBasedir, boolean isCaseSensitive, boolean getFiles, boolean getDirectories) throws java.io.IOException
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 directoriesjava.io.IOException
public static void copyDirectory(java.io.File sourceDirectory, java.io.File destinationDirectory) throws java.io.IOException
sourceDirectory
- the source dirdestinationDirectory
- the target dirjava.io.IOException
- if anypublic static void copyDirectory(java.io.File sourceDirectory, java.io.File destinationDirectory, java.lang.String includes, java.lang.String excludes) throws java.io.IOException
sourceDirectory
- the source dirdestinationDirectory
- the target dirincludes
- include patternexcludes
- exclude patternjava.io.IOException
- if anygetFiles(File, String, String)
public static void copyDirectoryLayout(java.io.File sourceDirectory, java.io.File destinationDirectory, java.lang.String[] includes, java.lang.String[] excludes) throws java.io.IOException
Copies a entire directory layout : no files will be copied only directories
Note:sourceDirectory
must exists.
sourceDirectory
- the source dirdestinationDirectory
- the target dirincludes
- include patternexcludes
- exclude patternjava.io.IOException
- if anypublic static void copyDirectoryStructure(java.io.File sourceDirectory, java.io.File destinationDirectory) throws java.io.IOException
Copies a entire directory structure.
Note:sourceDirectory
must exists.
sourceDirectory
- the source dirdestinationDirectory
- the target dirjava.io.IOException
- if anypublic static void copyDirectoryStructureIfModified(java.io.File sourceDirectory, java.io.File destinationDirectory) throws java.io.IOException
Copies an entire directory structure but only source files with timestamp later than the destinations'.
Note:sourceDirectory
must exists.
sourceDirectory
- the source dirdestinationDirectory
- the target dirjava.io.IOException
- if anyprivate static void copyDirectoryStructure(java.io.File sourceDirectory, java.io.File destinationDirectory, java.io.File rootDestinationDirectory, boolean onlyModifiedFiles) throws java.io.IOException
java.io.IOException
public static void rename(java.io.File from, java.io.File to) throws java.io.IOException
Renames a file, even if that involves crossing file system boundaries.
This will remove to
(if it exists), ensure that to
's parent directory exists and move
from
, which involves deleting from
as well.
from
- the file to moveto
- the new file namejava.io.IOException
- if anything bad happens during this process. Note that to
may have been deleted
already when this happens.public static java.io.File createTempFile(java.lang.String prefix, java.lang.String suffix, java.io.File parentDir)
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.
prefix
- prefix before the random numbersuffix
- file extension; include the '.'parentDir
- Directory to create the temporary file in -java.io.tmpdir
used if not specificedpublic static void copyFile(java.io.File from, java.io.File to, java.lang.String encoding, FileUtils.FilterWrapper[] wrappers) throws java.io.IOException
to.lastModified() < from.lastModified()
from
- the file to copyto
- the destination fileencoding
- the file output encoding (only if wrappers is not empty)wrappers
- array of FileUtils.FilterWrapper
java.io.IOException
- if an IO error occurs during copying or filteringpublic static void copyFile(java.io.File from, java.io.File to, java.lang.String encoding, FileUtils.FilterWrapper[] wrappers, boolean overwrite) throws java.io.IOException
to.lastModified() < from.lastModified()
, if overwrite is truefrom
- the file to copyto
- the destination fileencoding
- the file output encoding (only if wrappers is not empty)wrappers
- array of FileUtils.FilterWrapper
overwrite
- if true and wrappers is null or empty, the file will be copied even if to.lastModified() < from.lastModified()
java.io.IOException
- if an IO error occurs during copying or filteringprivate static boolean isSourceNewerThanDestination(java.io.File source, java.io.File destination)
public static java.util.List<java.lang.String> loadFile(java.io.File file) throws java.io.IOException
file
- the filejava.io.IOException
- if anypublic static boolean isValidWindowsFileName(java.io.File f)
":", "*", "?", "\"", "<", ">", "|"
f
- not null filefalse
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.INVALID_CHARACTERS_FOR_WINDOWS_FILE_NAME