|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.io.FileUtils
com.pmease.quickbuild.util.FileUtils
public class FileUtils
Field Summary |
---|
Fields inherited from class org.apache.commons.io.FileUtils |
---|
EMPTY_FILE_ARRAY, ONE_GB, ONE_KB, ONE_MB |
Constructor Summary | |
---|---|
FileUtils()
|
Method Summary | |
---|---|
static java.lang.Long |
assignIdFor(java.io.File file)
Assign an unique integer identifier for path of specified file. |
static java.lang.String |
byteCountToDisplaySize(long size)
|
static void |
cleanDir(java.io.File dir)
Clean specified directory if exists; otherwise create an empty directory. |
static int |
comparePath(java.lang.String path1,
java.lang.String path2)
|
static boolean |
containsFileWithSuffix(java.io.File dir,
java.lang.String suffix)
Checks whether or not specified directory contains file with specified suffix recursively. |
static void |
copyDir(java.io.File srcDir,
java.io.File destDir)
|
static void |
copyFile(java.io.File srcFile,
java.io.File destFile)
|
static void |
copyFile(java.io.File srcFile,
java.io.File destFile,
boolean preserveFileDate)
|
static void |
copyFile(java.io.File srcFile,
java.io.File destFile,
boolean preserveFileDate,
boolean preserveReadOnly)
|
static void |
copyFiles(java.io.File srcDir,
java.lang.String patterns,
java.io.File destDir)
|
static void |
copyUrlToFile(java.net.URL url,
java.io.File file)
|
static void |
createDir(java.io.File dir)
Create directory if not exist |
static void |
createFile(java.io.File file)
Create file if not exists; otherwise, clear content of the file. |
static java.io.File |
createTempDir(java.lang.String prefix)
|
static java.io.File |
createTempFile(java.lang.String prefix)
|
static java.io.File |
createTempFile(java.lang.String prefix,
java.lang.String suffix)
Create a temporal file with specified prefix and suffix. |
static void |
deleteDir(java.io.File dir)
Delete directory recursively if the directory exists. |
static void |
deleteFile(java.io.File file)
Delete file if exists |
static void |
deleteFiles(java.io.File baseDir,
java.lang.String filePatterns)
Delete files from specified directory matching specified patterns. |
static java.io.File |
findChild(java.io.File dir,
java.lang.String name)
Find specified name in specified directory |
static java.lang.String |
getDefaultEncoding()
Get default file encoding of underlying OS |
static Pair<java.lang.String[],java.lang.String[]> |
getIncludesExcludes(java.lang.String pathPatterns)
|
static java.lang.String |
getRelativePath(java.lang.String longer,
java.lang.String shorter)
Determines if specified longer path is relative to the shorter path. |
static boolean |
isFilePattern(java.lang.String path)
|
static java.util.Collection<java.io.File> |
listFiles(java.io.File baseDir,
java.lang.String filePatterns)
List all files matching specified patterns under specified base directory. |
static java.util.Properties |
loadProps(java.io.File file)
|
static java.io.File |
locateLib(java.lang.Class<?> locator,
java.lang.String libName)
|
static boolean |
matches(java.lang.String path,
java.util.List<Pair<java.lang.String,java.lang.Boolean>> parsedPathPatterns)
|
static boolean |
matches(java.lang.String path,
java.lang.String pathPattern)
|
static java.io.File |
normalize(java.io.File file)
|
static java.lang.String |
normalize(java.lang.String path)
|
static java.util.List<Pair<java.lang.String,java.lang.Boolean>> |
parsePathPatterns(java.lang.String pathPatterns)
Parse path patterns into list of include and exclude pairs |
static void |
pruneDir(java.io.File dir,
java.lang.String name)
Delete all descendant directories that only has specified file or directory. |
static byte[] |
readFileAsBytes(java.io.File file)
|
static VersionedDocument |
readFileAsDom(java.io.File file)
|
static java.util.List<java.lang.String> |
readFileAsLines(java.io.File file)
|
static java.util.List<java.lang.String> |
readFileAsLines(java.io.File file,
java.lang.String encoding)
|
static java.lang.Object |
readFileAsObject(java.io.File file)
|
static java.lang.String |
readFileAsString(java.io.File file)
Read file content as a string. |
static java.lang.String |
readFileAsString(java.io.File file,
java.lang.String encoding)
|
static java.lang.String |
readFileAsString(java.io.File file,
java.lang.String pattern,
int range)
|
static java.lang.String |
readFileAsString(java.io.File file,
java.lang.String encoding,
java.lang.String pattern,
int range)
|
static java.io.File |
resolvePath(java.io.File baseDir,
java.lang.String path)
Resolve specified path against specified base directory: If path is null, the base directory will be returned. If path is an absolute path, the file represented by the path will be returned. If path is a relative path, the file represented by concatenation result of the base directory and the path will be returned. |
static void |
saveProps(java.io.File file,
java.util.Properties props)
|
static void |
saveProps(java.io.File file,
java.util.Properties props,
java.lang.String comment)
|
static void |
sortFiles(java.util.List<java.io.File> files)
|
static void |
sortPaths(java.util.List<java.lang.String> paths)
Sort paths in ascending order. |
static void |
tar(java.io.File baseDir,
java.lang.String filePatterns,
boolean compress,
java.io.OutputStream os)
|
static void |
touchFile(java.io.File file)
|
static void |
untar(java.io.InputStream is,
boolean compressed,
java.io.File destDir)
|
static void |
unzip(java.io.File file,
java.io.File dir)
|
static void |
unzip(java.io.InputStream is,
java.io.File destDir)
|
static void |
writeFile(java.io.File file,
byte[] bytes)
|
static void |
writeFile(java.io.File file,
java.util.Collection<java.lang.String> lines)
|
static void |
writeFile(java.io.File file,
java.util.Collection<java.lang.String> lines,
java.lang.String encoding)
|
static void |
writeFile(java.io.File file,
java.io.Serializable serializable)
|
static void |
writeFile(java.io.File file,
java.lang.String content)
|
static void |
writeFile(java.io.File file,
java.lang.String content,
java.lang.String encoding)
|
static void |
writeFile(java.io.File file,
VersionedDocument dom)
|
static void |
writeFile(java.io.File file,
VersionedDocument dom,
boolean clearPasswords,
boolean newlines,
boolean indent)
|
static void |
zip(java.io.File dir,
java.io.File file)
|
static void |
zip(java.io.File baseDir,
java.lang.String filePatterns,
boolean compress,
java.io.OutputStream os)
|
Methods inherited from class org.apache.commons.io.FileUtils |
---|
checksum, checksumCRC32, cleanDirectory, contentEquals, convertFileCollectionToFileArray, copyDirectory, copyDirectory, copyDirectory, copyDirectory, copyDirectoryToDirectory, copyFileToDirectory, copyFileToDirectory, copyURLToFile, deleteDirectory, deleteQuietly, forceDelete, forceDeleteOnExit, forceMkdir, isFileNewer, isFileNewer, isFileNewer, isFileOlder, isFileOlder, isFileOlder, iterateFiles, iterateFiles, lineIterator, lineIterator, listFiles, listFiles, moveDirectory, moveDirectoryToDirectory, moveFile, moveFileToDirectory, moveToDirectory, openInputStream, openOutputStream, readFileToByteArray, readFileToString, readFileToString, readLines, readLines, sizeOfDirectory, toFile, toFiles, touch, toURLs, waitFor, writeByteArrayToFile, writeLines, writeLines, writeLines, writeLines, writeStringToFile, writeStringToFile |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileUtils()
Method Detail |
---|
public static void deleteFile(java.io.File file)
file
- public static java.io.File createTempFile(java.lang.String prefix, java.lang.String suffix)
prefix
- suffix
-
public static java.io.File createTempFile(java.lang.String prefix)
public static java.io.File createTempDir(java.lang.String prefix)
public static void cleanDir(java.io.File dir)
public static void createDir(java.io.File dir)
public static java.lang.String readFileAsString(java.io.File file)
file
-
public static java.lang.String readFileAsString(java.io.File file, java.lang.String encoding)
public static java.lang.String readFileAsString(java.io.File file, java.lang.String pattern, int range)
public static java.lang.String readFileAsString(java.io.File file, java.lang.String encoding, java.lang.String pattern, int range)
public static void writeFile(java.io.File file, java.lang.String content)
public static void writeFile(java.io.File file, VersionedDocument dom)
public static void writeFile(java.io.File file, VersionedDocument dom, boolean clearPasswords, boolean newlines, boolean indent)
file
- dom
- newlines
- this is passed as a param since dom4j has a bug that an
extra empty line will be added between elements if writing dom reading
from an existing formatted xml file. In this case, we need to write the
DOM with new lines set to false.public static VersionedDocument readFileAsDom(java.io.File file)
public static void writeFile(java.io.File file, java.lang.String content, java.lang.String encoding)
public static void copyDir(java.io.File srcDir, java.io.File destDir)
public static void copyFiles(java.io.File srcDir, java.lang.String patterns, java.io.File destDir)
public static void copyFile(java.io.File srcFile, java.io.File destFile)
public static void copyFile(java.io.File srcFile, java.io.File destFile, boolean preserveFileDate)
public static void copyFile(java.io.File srcFile, java.io.File destFile, boolean preserveFileDate, boolean preserveReadOnly)
public static java.util.List<java.lang.String> readFileAsLines(java.io.File file)
public static java.util.List<java.lang.String> readFileAsLines(java.io.File file, java.lang.String encoding)
public static void writeFile(java.io.File file, java.util.Collection<java.lang.String> lines)
public static void writeFile(java.io.File file, java.util.Collection<java.lang.String> lines, java.lang.String encoding)
public static void writeFile(java.io.File file, byte[] bytes)
public static void writeFile(java.io.File file, java.io.Serializable serializable)
public static void createFile(java.io.File file)
file
- public static byte[] readFileAsBytes(java.io.File file)
public static java.lang.Object readFileAsObject(java.io.File file)
public static void deleteFiles(java.io.File baseDir, java.lang.String filePatterns)
baseDir
- filePatterns
- public static java.util.Collection<java.io.File> listFiles(java.io.File baseDir, java.lang.String filePatterns)
baseDir
- should not be nullfilePatterns
- null to list all files
public static java.util.List<Pair<java.lang.String,java.lang.Boolean>> parsePathPatterns(java.lang.String pathPatterns)
pathPatterns
- should not be blank
public static java.lang.String getRelativePath(java.lang.String longer, java.lang.String shorter)
shorter
- a string representing shorter path, can be a relative path. The path
separator does not matter, and will be converted to "/" at comparing time.longer
- a string representing longer path, can be a relative path. The path
separator does not matter, and will be converted to "/" at comparing time.
public static void sortPaths(java.util.List<java.lang.String> paths)
paths
- a list of string representing paths to be compared. Strings in this param
will be re-ordered, and the path will be separated by \"/\" no matter what path separator
they originally uses. Ending path separator in this list will be removed before sorting.public static int comparePath(java.lang.String path1, java.lang.String path2)
public static Pair<java.lang.String[],java.lang.String[]> getIncludesExcludes(java.lang.String pathPatterns)
public static boolean matches(java.lang.String path, java.lang.String pathPattern)
public static boolean matches(java.lang.String path, java.util.List<Pair<java.lang.String,java.lang.Boolean>> parsedPathPatterns)
public static java.io.File findChild(java.io.File dir, java.lang.String name)
dir
- the directory to search in. This directory should existname
- name of the file/dir to find
public static java.lang.String getDefaultEncoding()
public static void copyUrlToFile(java.net.URL url, java.io.File file)
public static void pruneDir(java.io.File dir, java.lang.String name)
public static void sortFiles(java.util.List<java.io.File> files)
public static void zip(java.io.File dir, java.io.File file)
public static void unzip(java.io.File file, java.io.File dir)
public static java.util.Properties loadProps(java.io.File file)
public static void saveProps(java.io.File file, java.util.Properties props)
public static void saveProps(java.io.File file, java.util.Properties props, java.lang.String comment)
public static java.io.File resolvePath(java.io.File baseDir, java.lang.String path)
baseDir
- path
-
public static java.io.File normalize(java.io.File file)
public static java.lang.String normalize(java.lang.String path)
public static void deleteDir(java.io.File dir)
dir
- public static boolean isFilePattern(java.lang.String path)
public static void tar(java.io.File baseDir, java.lang.String filePatterns, boolean compress, java.io.OutputStream os)
public static void untar(java.io.InputStream is, boolean compressed, java.io.File destDir)
public static void zip(java.io.File baseDir, java.lang.String filePatterns, boolean compress, java.io.OutputStream os)
public static void unzip(java.io.InputStream is, java.io.File destDir)
public static void touchFile(java.io.File file)
public static boolean containsFileWithSuffix(java.io.File dir, java.lang.String suffix)
dir
- must be an existing directorysuffix
-
public static java.lang.Long assignIdFor(java.io.File file)
file
-
public static java.lang.String byteCountToDisplaySize(long size)
public static java.io.File locateLib(java.lang.Class<?> locator, java.lang.String libName)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |