|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.dynamide.util.FileTools
public class FileTools
Nested Class Summary | |
---|---|
static class |
FileTools.FileInfo
A class that contains information about a file and its contents so that the class can be read fully, while preserving the File handle to pass back to the caller. |
Field Summary | |
---|---|
static int |
LN_FILENAME
|
static int |
LN_FILENAME_NO_EXT
|
static int |
LN_FULL
|
static int |
LT_ALL
|
static int |
LT_DIRS
|
static int |
LT_FILES
|
Constructor Summary | |
---|---|
FileTools()
|
Method Summary | |
---|---|
static boolean |
backup(java.lang.String fileName)
Copies the file named by fileName to a backup file in the same directory, with a name generated by FileTools.generateBackupName(fileName) and returns true, otherwise returns true, and returns false if there's an Exception. |
static void |
cleanOneDir(java.lang.String dir,
java.lang.String name,
java.lang.String sanity)
|
static java.util.List |
copyDir(java.lang.String srcDir,
java.lang.String destDir)
Copy srcDir to destDir, overwriting all files. |
static boolean |
copyFile(java.lang.String sourceFileName,
java.lang.String destFileName)
Copy a binary source file to a destination file. |
static java.lang.String |
copyToTempFile(java.lang.String directory,
java.lang.String shortFilename,
java.lang.String extension)
Finds a new name for the file named in the directory named, and creates that file, without deleting the original file. |
static java.io.File |
createDirectory(java.lang.String fullPath)
|
static java.io.File |
createDirectory(java.lang.String baseDir,
java.lang.String relativePath)
Creates a directory, returned as a File object -- call File.getCanonicalPath() to see the full path as a String(). |
static java.io.File |
createDirectory(java.lang.String baseDir,
java.lang.String relativePath,
boolean nullReturnIfDirExists)
|
static java.io.File |
createTempSubdirectory(java.lang.String leader)
|
static boolean |
delete(java.lang.String filename)
|
static boolean |
delete(java.lang.String dirname,
java.lang.String filename)
|
static void |
directoryDiver(java.lang.String diveID,
java.io.File directory,
java.lang.String relativePath,
IFileDiverListener listener,
java.lang.String separator)
|
static void |
directoryDiver(java.lang.String diveID,
java.lang.String startingDir,
IFileDiverListener listener)
|
static void |
directoryDiver(java.lang.String diveID,
java.lang.String startingDir,
IFileDiverListener listener,
java.lang.String separator)
|
static boolean |
directoryExists(java.lang.String filename)
|
static boolean |
fileExists(java.lang.String filename)
|
static boolean |
fileSystemIsDOS()
|
static java.util.List<java.lang.String> |
fileToLines(java.io.File file)
|
static java.lang.String |
fixFilename(java.lang.String filename)
|
static java.lang.String |
generateBackupName(java.lang.String basename)
|
static boolean |
isWebSafeFileName(java.lang.String path)
|
static java.lang.String |
join(java.lang.String dir,
java.lang.String file)
|
static java.lang.String |
joinExt(java.lang.String filename,
java.lang.String ext)
|
static java.lang.String |
joinExt(java.lang.String filename,
java.lang.String ext,
boolean isURI)
|
static java.lang.String |
joinURI(java.lang.String dir,
java.lang.String file)
|
static java.lang.String |
joinURIExt(java.lang.String filename,
java.lang.String ext)
|
static java.lang.String |
joinURIExt(java.lang.String dir,
java.lang.String filename,
java.lang.String ext)
|
static java.util.Map |
list(java.lang.String dirname,
int type,
int nameStyle)
|
static java.util.Properties |
loadPropertiesFromFile(java.lang.String dir,
java.lang.String relativeName)
|
static void |
main(java.lang.String[] args)
|
boolean |
onDirectory(java.lang.String diveID,
java.io.File directory,
java.lang.String dirname,
java.lang.String relativePath)
|
void |
onFile(java.lang.String diveID,
java.io.File directory,
java.io.File file,
java.lang.String filename,
java.lang.String relativePath)
filename is the short name of the file, without directory info, relativePath is the relative path, including intermediate directories, starting from the point where the dive was initiated. |
static java.io.File |
openFile(java.lang.String dir,
java.lang.String relPath)
|
static java.io.File |
openFile(java.lang.String dir,
java.lang.String relPath,
boolean forceParentDirectories)
|
static byte[] |
readBinaryFile(java.lang.String dir,
java.lang.String relPath)
|
static FileTools.FileInfo |
readBinaryFileInfo(java.lang.String dir,
java.lang.String relPath)
|
static FileTools.FileInfo |
readBinaryFileInfo(java.lang.String dir,
java.lang.String relPath,
long lastModified)
|
static java.lang.String |
readFile(java.lang.String fullPath)
|
static java.lang.String |
readFile(java.lang.String dir,
java.lang.String relPath)
|
static FileTools.FileInfo |
readFileInfo(java.lang.String dir,
java.lang.String relPath)
|
static FileTools.FileInfo |
readFileInfo(java.lang.String dir,
java.lang.String relPath,
long lastModified)
|
static java.lang.String |
readFully(java.io.InputStream inputStream)
|
static java.lang.String |
resolve(java.lang.String path)
|
static java.io.File |
saveFile(java.lang.String dir,
java.lang.String relativeName,
byte[] content)
|
static java.io.File |
saveFile(java.lang.String dir,
java.lang.String relativeName,
java.lang.String content)
|
static boolean |
savePropertiesToFile(java.util.Properties props,
java.lang.String headerComment,
java.lang.String dir,
java.lang.String relativeName)
|
static java.io.File |
saveToTempFile(java.lang.String directory,
java.lang.String content)
|
static java.lang.String |
toURI(java.lang.String filename)
|
static void |
usage()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int LT_FILES
public static final int LT_DIRS
public static final int LT_ALL
public static final int LN_FULL
public static final int LN_FILENAME
public static final int LN_FILENAME_NO_EXT
Constructor Detail |
---|
public FileTools()
Method Detail |
---|
public static void directoryDiver(java.lang.String diveID, java.lang.String startingDir, IFileDiverListener listener)
public static void directoryDiver(java.lang.String diveID, java.lang.String startingDir, IFileDiverListener listener, java.lang.String separator)
public static void directoryDiver(java.lang.String diveID, java.io.File directory, java.lang.String relativePath, IFileDiverListener listener, java.lang.String separator)
public void onFile(java.lang.String diveID, java.io.File directory, java.io.File file, java.lang.String filename, java.lang.String relativePath)
onFile
in interface IFileDiverListener
diveID
- This identifies the callback so that you know which thing you are doing if you use the
callback interface for two tasks within one class, or within multiple threads.directoryDiver(java.lang.String, java.lang.String, com.dynamide.util.IFileDiverListener)
public boolean onDirectory(java.lang.String diveID, java.io.File directory, java.lang.String dirname, java.lang.String relativePath)
onDirectory
in interface IFileDiverListener
diveID
- This identifies the callback so that you know which thing you are doing if you use the
callback interface for two tasks within one class, or within multiple threads.
for a description of relativePath.
public static java.util.Map list(java.lang.String dirname, int type, int nameStyle) throws java.lang.Exception
type
- should be one of LT_FILES, LT_DIRS or LT_ALL.nameStyle
- should be one of LN_FULL, LN_FILENAME or LN_FILENAME_NO_EXT.
java.lang.Exception
public static boolean fileSystemIsDOS()
public static java.lang.String fixFilename(java.lang.String filename)
public static java.lang.String join(java.lang.String dir, java.lang.String file)
public static java.lang.String joinURI(java.lang.String dir, java.lang.String file)
public static java.lang.String toURI(java.lang.String filename)
public static java.lang.String joinExt(java.lang.String filename, java.lang.String ext)
public static java.lang.String joinURIExt(java.lang.String filename, java.lang.String ext)
public static java.lang.String joinURIExt(java.lang.String dir, java.lang.String filename, java.lang.String ext)
public static java.lang.String joinExt(java.lang.String filename, java.lang.String ext, boolean isURI)
public static java.io.File createDirectory(java.lang.String fullPath)
public static java.io.File createDirectory(java.lang.String baseDir, java.lang.String relativePath)
relativePath
- can be empty.baseDir
- can be be a full path or partial path.
public static java.io.File createDirectory(java.lang.String baseDir, java.lang.String relativePath, boolean nullReturnIfDirExists)
public static java.io.File createTempSubdirectory(java.lang.String leader) throws java.util.ConcurrentModificationException
java.util.ConcurrentModificationException
public static boolean delete(java.lang.String filename)
public static boolean delete(java.lang.String dirname, java.lang.String filename)
public static void cleanOneDir(java.lang.String dir, java.lang.String name, java.lang.String sanity)
sanity
- is a safety check, or you can pass "".public static boolean isWebSafeFileName(java.lang.String path)
public static boolean copyFile(java.lang.String sourceFileName, java.lang.String destFileName)
public static java.util.List copyDir(java.lang.String srcDir, java.lang.String destDir) throws java.io.IOException
java.io.IOException
public static java.io.File openFile(java.lang.String dir, java.lang.String relPath)
public static java.io.File openFile(java.lang.String dir, java.lang.String relPath, boolean forceParentDirectories)
public static java.lang.String resolve(java.lang.String path) throws java.io.IOException
java.io.IOException
public static java.lang.String readFile(java.lang.String fullPath)
public static java.lang.String readFile(java.lang.String dir, java.lang.String relPath)
public static FileTools.FileInfo readFileInfo(java.lang.String dir, java.lang.String relPath)
public static FileTools.FileInfo readFileInfo(java.lang.String dir, java.lang.String relPath, long lastModified)
lastModified
- Pass zero to indicate that you want the file read regardless of
the last modified timestamp, otherwise this method compares the value with
the File's lastModified() result, and returns an empty FileInfo with getNotModified() == true,
or a filled out FileInfo if the file has been modified since the timestamp.public static byte[] readBinaryFile(java.lang.String dir, java.lang.String relPath)
public static FileTools.FileInfo readBinaryFileInfo(java.lang.String dir, java.lang.String relPath)
public static FileTools.FileInfo readBinaryFileInfo(java.lang.String dir, java.lang.String relPath, long lastModified)
public static java.lang.String readFully(java.io.InputStream inputStream) throws java.io.IOException
java.io.IOException
public static java.io.File saveToTempFile(java.lang.String directory, java.lang.String content)
public static java.lang.String copyToTempFile(java.lang.String directory, java.lang.String shortFilename, java.lang.String extension) throws java.lang.Exception
directory
- The canonical path to the file, without filename or extensionshortFilename
- the basename of the file without extension, e.g. for /tmp/MyFile.txt shortFilename is "MyFile"extension
- Just the extension, without the dot, eg. for /tmp/MyFile.txt extension is "txt"
java.lang.Exception
public static java.io.File saveFile(java.lang.String dir, java.lang.String relativeName, java.lang.String content)
public static java.io.File saveFile(java.lang.String dir, java.lang.String relativeName, byte[] content)
public static java.lang.String generateBackupName(java.lang.String basename) throws java.lang.Exception
java.lang.Exception
public static boolean backup(java.lang.String fileName)
public static boolean fileExists(java.lang.String filename)
public static boolean directoryExists(java.lang.String filename)
public static java.util.Properties loadPropertiesFromFile(java.lang.String dir, java.lang.String relativeName)
public static boolean savePropertiesToFile(java.util.Properties props, java.lang.String headerComment, java.lang.String dir, java.lang.String relativeName)
headerComment
- can be null, if no # comment is desired at the top of the file.public static java.util.List<java.lang.String> fileToLines(java.io.File file) throws java.io.FileNotFoundException
java.io.FileNotFoundException
public static void usage()
public static void main(java.lang.String[] args)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |