|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ccl.util.FileUtil
Utility class for file operations.
Simple but most commonly used methods of this class are:
- readFile
- writeFile
- appendFile
- concatPath
- exists
- existsDir
- existsFile
Other less frequently used but still handy methods are:
- getResourceAsString
- normalizeFileName
to take the current user directory into account via the 'user.dir' system property
- deleteRecursively
There are also the standard file operation methods available.
Some of these are named for convenience and easy memorization after their Unix
counterparts, like mv
, rm
, mkdir
(md
), and cp
.
Method Summary | |
static java.util.Vector |
_getFilteredDirContent(java.lang.String sDir_,
java.io.FilenameFilter pFilenameFilter_)
Deprecated. |
static void |
appendFile(java.lang.String sFileName_,
java.lang.String sAddedContent_)
Append string to a file content. |
static boolean |
areAllPathsAbsolute(java.lang.String sPathList_)
Tests if the file represented by this File object is an absolute pathname. |
static java.lang.String |
concatPath(java.lang.String sPath_,
java.lang.String sFile_)
Concatenates a file path with the file name. |
static boolean |
copy(java.io.BufferedInputStream pBufferedInputStream_,
java.io.BufferedOutputStream pBufferedOutputStream_)
Copy content of an buffered input stream into an buffered output stream. |
static boolean |
copy(java.io.InputStream pInputStream_,
java.io.OutputStream pOutputStream_)
Copy content of an input stream into an output stream. |
static boolean |
copy(java.lang.String sSourceFile_,
java.lang.String sDestinationFile_)
Copy file. |
static boolean |
copyDir(java.lang.String sDir_,
java.lang.String sDestination_)
Like: cp -r sDir_ sDestination_ No consideration for links are in place, so be aware of possible infinite loops. |
static boolean |
cp(java.lang.String sSourceFile_,
java.lang.String sDestinationFile_)
Copy file. |
static void |
createBackupFile(java.lang.String sFileName_)
Copy the specified file to the same location and append ".bak" to its file name. |
static java.lang.String |
createTempDir()
Unlike 'getTempDir()' which returns something like "/tmp" this method creates a new temporary directory which has no other files inside. |
static boolean |
delete(java.lang.String sFileName_)
Remove file on file system. |
static boolean |
deleteRecursively(java.lang.String sFileName_)
Delete file or directory. |
static boolean |
equalsFile(java.lang.String sFileNameA_,
java.lang.String sFileNameB_)
Reads two files and compares them. |
static boolean |
equalsPath(java.lang.String sFirstPath_,
java.lang.String sSecondPath_)
Checks weather two paths point to the same object on the file system. |
static boolean |
exists(java.lang.String sFileOrDirName_)
True if a specified object on the file system is either a file or a directory. |
static boolean |
existsDir(java.lang.String sDirName_)
Tests, if a given directory exists. |
static boolean |
existsFile(java.lang.String sFileName_)
True if a specified file exists. |
static java.lang.String |
getAbsoluteFileName(java.lang.String sFileName_)
|
static java.lang.String |
getAbsolutePath(java.lang.String sFileName_)
The same as getAbsoluteFileName(..). |
static java.lang.String |
getAbsolutePathList(java.lang.String sPathList_)
Converts each path element to an aboslute path and concatenates these again using the platforms path separator character. |
static java.lang.String |
getApplicationHome(java.lang.Object oClass)
Deprecated. use ClassPathUtil.getApplicationHome instead. |
static java.lang.String |
getBaseFileName(java.lang.String sFileName_)
Deprecated. use getBaseName. |
static java.lang.String |
getBaseName(java.lang.String sFileName_)
Get the base name of a file. |
static java.lang.String |
getClassPath(java.lang.Object oClass_)
Does work only when class exists outside a zip or jar file. |
static java.lang.String |
getClassPath(java.lang.String sFullClassName_)
Does work only when class exists outside a zip or jar file. |
static java.lang.String |
getDir(java.lang.String sFile_)
Returns the directory as a string of the given file. |
static java.lang.String |
getDirName(java.lang.String sFileName)
Equivalent to unix dirname command. |
static java.util.Vector |
getFiles(java.lang.String sDir_)
Returns a Vector with all files of the given directory. |
static java.util.Vector |
getFiles(java.lang.String sDir_,
java.lang.String sSuffix_)
Returns a Vector with all file names that are inside the specified directory. |
static java.util.Vector |
getFiles(java.lang.String sDir_,
java.lang.String sPrefix_,
java.lang.String sSuffix_)
Returns a Vector with all file (and dir) names that are inside the specified directory. |
static java.util.Vector |
getFilteredDirContent(java.lang.String sDir_,
java.io.FilenameFilter pFilenameFilter_)
Returns a Vector with all file names that are inside the specified directory. |
static java.lang.String |
getPackagePath(java.lang.String sPackageName_)
You give it a package name and it looks with the help of the classpath on the file system if it can find a directory that relates to this package. |
static java.lang.String |
getPackagePath(java.lang.String sPackageName_,
java.lang.String sClassPath_)
You give it a package name and it looks with the help of the classpath on the file system if it can find a directory that relates to this package. |
static java.util.Vector |
getRecursiveDir(java.lang.String sFileName_)
Be aware that symbolic links might lead to infinite loops. |
static java.io.InputStream |
getResourceAsStream(java.lang.Object pObject_,
java.lang.String sRecourceName_)
There is one big advantage this method has over Class.getResourceAsStream(..). |
static java.lang.String |
getResourceAsString(java.lang.Object pObject_,
java.lang.String sRecourceName_)
There is one big advantage this method has over Class.getResourceAsStream(..). |
static java.util.Vector |
getSubDirs(java.lang.String sDir_)
Liefert einen Vector mit allen Unter-Directories zur?ck. |
static java.lang.String |
getSwingHome()
It searchs in the classpath for swingall.jar, then for swing.jar and last for com/sun/java/swing on the file system. |
static java.lang.String |
getTempDir()
Returns a temporary directory. |
static java.lang.String |
getTempFileName()
Creates a path with a temp directory plus a 5 digit random file name. |
static boolean |
isAbsolute(java.lang.String sFileName_)
Tests if the file represented by this File object is an absolute pathname. |
static boolean |
isFileReadable(java.lang.String sFileName_)
This method checks if it is save to use a file or if for example someone else is currently writing into this file. |
static boolean |
isQuitInStdin()
Checks if the next word in the standard input stream is quit followed by a linefeed. |
static boolean |
md(java.lang.String sFullDirName)
Creates the specified directory and if necessary any parent directories. |
static boolean |
mkdir(java.lang.String sFullDirName)
Creates the specified directory and if necessary any parent directories. |
static boolean |
move(java.lang.String sSource_,
java.lang.String sDest_)
Renames or moves a file. |
static boolean |
mv(java.lang.String sSource_,
java.lang.String sDest_)
Renames or moves a file. |
static java.lang.String |
normalizeFileName(java.lang.String sFile)
This method returns an absolute (canonical) file name. |
static java.lang.String |
normalizeFileName(java.lang.String sFile,
java.lang.String sUserDir)
This method returns an absolute (canonical) file name. |
static java.io.DataInputStream |
openFile(java.lang.String sFile)
Get a DataInputStream for a specified file. |
static java.io.DataOutputStream |
openOutputFile(java.lang.String sFile)
Get a DataOutputStream for a specified file. |
static void |
printAndWaitUntilQuit()
Prints a user message and reads standard input until someone types 'quit' and <enter>. |
static java.lang.Byte[] |
readBinaryFile(java.lang.String sFileName_)
Deprecated. Method has no implementation. |
static java.lang.String |
readFile(java.lang.String sFileName_)
Reads a File and returns the content in a String. |
static java.lang.String |
readFile(java.net.URL location)
Reads the content of a URL and returns a string. |
static java.lang.String |
readStream(java.io.InputStream stream_)
Reads a stream, gives back a string. |
static boolean |
rm(java.lang.String sFileName_)
Remove file on file system. |
static void |
writeDosFile(java.lang.String sFileName_,
java.lang.String sContent_)
Like writeFile but converts LFs to CRLFs. |
static void |
writeFile(java.lang.String sFileName,
java.lang.String sContent)
Writes a String into a given File. |
static void |
writeFileWithBackup(java.lang.String sFileName_,
java.lang.String sContent_)
Writes a String into a given File and does move the old file if existent to sFileName + ".bak". |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static java.lang.String getPackagePath(java.lang.String sPackageName_)
public static java.lang.String getPackagePath(java.lang.String sPackageName_, java.lang.String sClassPath_)
Todo: what happens with an empty classpath? That should be equivalent to a "." classpath.
public static java.lang.String getClassPath(java.lang.Object oClass_)
public static java.lang.String getClassPath(java.lang.String sFullClassName_)
public static java.lang.String getSwingHome()
public static java.lang.String concatPath(java.lang.String sPath_, java.lang.String sFile_)
This method is inspired from the FrIJDE project out of the gCollins.File.FileTools class.
FrIJDE Homepage: http://amber.wpi.edu/~thethe/Document/Besiex/Java/FrIJDE/
sPath_
- a directory path. Is not allowed to be null.sFile_
- the base name of a file.
public static java.io.DataInputStream openFile(java.lang.String sFile)
public static java.io.DataOutputStream openOutputFile(java.lang.String sFile)
public static java.lang.String readStream(java.io.InputStream stream_) throws java.io.IOException, java.io.FileNotFoundException
java.io.FileNotFoundException
- if file does not exist.
java.io.IOException
- if any file operation fails.public static java.lang.String readFile(java.lang.String sFileName_) throws java.io.IOException, java.io.FileNotFoundException
sFileName_
- the name of the file to read.
java.io.FileNotFoundException
- if file does not exist.
java.io.IOException
- if any file operation fails.public static java.lang.Byte[] readBinaryFile(java.lang.String sFileName_)
public static java.lang.String readFile(java.net.URL location) throws java.net.MalformedURLException, java.io.IOException
java.io.IOException
- if any file operation fails.
java.net.MalformedURLException
- if given location is wrong.public static void appendFile(java.lang.String sFileName_, java.lang.String sAddedContent_) throws java.io.IOException
java.io.IOException
- if writing file fails.public static void writeFile(java.lang.String sFileName, java.lang.String sContent) throws java.io.IOException
java.io.IOException
- if writing file fails.public static void writeFileWithBackup(java.lang.String sFileName_, java.lang.String sContent_) throws java.io.IOException
java.io.IOException
writeFile(java.lang.String, java.lang.String)
public static void createBackupFile(java.lang.String sFileName_) throws java.io.IOException
java.io.IOException
- when creating backup file
fails.public static void writeDosFile(java.lang.String sFileName_, java.lang.String sContent_) throws java.io.IOException
java.io.IOException
writeFile(java.lang.String, java.lang.String)
public static boolean equalsFile(java.lang.String sFileNameA_, java.lang.String sFileNameB_)
public static boolean existsFile(java.lang.String sFileName_)
public static boolean existsDir(java.lang.String sDirName_)
public static boolean exists(java.lang.String sFileOrDirName_)
public static java.util.Vector getFilteredDirContent(java.lang.String sDir_, java.io.FilenameFilter pFilenameFilter_)
getFiles(java.lang.String, java.lang.String)
public static java.util.Vector _getFilteredDirContent(java.lang.String sDir_, java.io.FilenameFilter pFilenameFilter_)
getFilteredDirContent(java.lang.String, java.io.FilenameFilter)
public static java.util.Vector getSubDirs(java.lang.String sDir_)
public static java.util.Vector getFiles(java.lang.String sDir_)
public static java.util.Vector getFiles(java.lang.String sDir_, java.lang.String sSuffix_)
sSuffix_
- A list of suffixes (separated with the
File.pathSeparatorChar) the file names must
match. Otherwise they are not selected.public static java.util.Vector getFiles(java.lang.String sDir_, java.lang.String sPrefix_, java.lang.String sSuffix_)
sPrefix_
- A prefix which each file must have to be
returned on the list.sSuffix_
- A list of suffixes (separated with the
File.pathSeparatorChar) the file names must
match. Otherwise they are not selected.public static boolean equalsPath(java.lang.String sFirstPath_, java.lang.String sSecondPath_)
public static boolean delete(java.lang.String sFileName_)
public static boolean rm(java.lang.String sFileName_)
delete(java.lang.String)
,
deleteRecursively(java.lang.String)
public static boolean deleteRecursively(java.lang.String sFileName_)
public static boolean move(java.lang.String sSource_, java.lang.String sDest_)
mv(java.lang.String, java.lang.String)
public static boolean mv(java.lang.String sSource_, java.lang.String sDest_)
move(java.lang.String, java.lang.String)
public static boolean md(java.lang.String sFullDirName)
File.mkdirs()
public static boolean mkdir(java.lang.String sFullDirName)
File.mkdirs()
public static java.lang.String getAbsoluteFileName(java.lang.String sFileName_)
public static java.lang.String getAbsolutePath(java.lang.String sFileName_)
public static java.lang.String normalizeFileName(java.lang.String sFile)
public static java.lang.String normalizeFileName(java.lang.String sFile, java.lang.String sUserDir)
public static java.lang.String getTempFileName()
public static java.lang.String getTempDir()
public static java.lang.String createTempDir() throws java.io.IOException
java.io.IOException
- if the creation of the temporary directory
failed.public static boolean isAbsolute(java.lang.String sFileName_)
public static boolean areAllPathsAbsolute(java.lang.String sPathList_)
public static java.lang.String getAbsolutePathList(java.lang.String sPathList_)
For example: .;C:\jdk1.1.7\lib\classes.zip -> C:\java\projects;C:\jdk1.1.7\lib\classes.zip
public static java.util.Vector getRecursiveDir(java.lang.String sFileName_)
public static boolean copyDir(java.lang.String sDir_, java.lang.String sDestination_)
public static boolean cp(java.lang.String sSourceFile_, java.lang.String sDestinationFile_)
public static boolean copy(java.lang.String sSourceFile_, java.lang.String sDestinationFile_)
public static boolean copy(java.io.InputStream pInputStream_, java.io.OutputStream pOutputStream_)
public static boolean copy(java.io.BufferedInputStream pBufferedInputStream_, java.io.BufferedOutputStream pBufferedOutputStream_)
public static java.io.InputStream getResourceAsStream(java.lang.Object pObject_, java.lang.String sRecourceName_)
Class.getResourceAsStream(java.lang.String)
public static java.lang.String getResourceAsString(java.lang.Object pObject_, java.lang.String sRecourceName_) throws java.io.IOException
java.io.IOException
Class.getResourceAsStream(java.lang.String)
public static void printAndWaitUntilQuit()
Shouldn't this method be in Util and not FileUtil? No, because this is stdio and therefore also file related.
public static boolean isQuitInStdin()
public static java.lang.String getDir(java.lang.String sFile_)
public static boolean isFileReadable(java.lang.String sFileName_)
public static java.lang.String getBaseFileName(java.lang.String sFileName_)
sFileName_
- a string with a file name.
public static java.lang.String getBaseName(java.lang.String sFileName_)
sFileName_
- a string with a file name.
public static java.lang.String getDirName(java.lang.String sFileName)
public static java.lang.String getApplicationHome(java.lang.Object oClass)
oClass
- An instantiated class which belongs
to the application.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |