|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.io.FilenameUtils
Common File
manipulation routines through
use of a filename.
Constructor Summary | |
FilenameUtils()
|
Method Summary | |
static java.lang.String |
basename(java.lang.String filename)
Deprecated. This method will be deleted before a 1.0 release TODO DELETE before 1.0 |
static java.lang.String |
basename(java.lang.String filename,
java.lang.String suffix)
Deprecated. This method will be deleted. |
static java.lang.String |
catPath(java.lang.String lookupPath,
java.lang.String path)
Will concatenate 2 paths. |
static void |
cleanDirectory(java.lang.String directory)
Deprecated. Use FileUtils.cleanDirectory(File) |
static void |
copyFileToDirectory(java.lang.String source,
java.lang.String destinationDirectory)
Deprecated. Use FileUtils.copyFileToDirectory(File, File) |
static void |
deleteDirectory(java.lang.String directory)
Deprecated. Use FileUtils.deleteDirectory(File) |
static java.lang.String |
dirname(java.lang.String filename)
Deprecated. Use FileUtils#getPath(File)
TODO DELETE before 1.0 |
static java.lang.String |
extension(java.lang.String filename)
Deprecated. Use FileUtils#getExtension(File)
TODO probably duplicate method. See getExtension |
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)
Deprecated. Use FileUtils#removeExtension(File)
TODO DELETE before 1.0 |
static void |
forceDelete(java.lang.String file)
Deprecated. Use FileUtils.forceDelete(File) |
static java.lang.String |
getExtension(java.lang.String filename)
Get extension from filename. |
static java.io.File |
getFile(java.lang.String fileName)
Deprecated. Use java.io.File#Constructor(String) |
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. |
static void |
mkdir(java.lang.String dir)
Simple way to make a directory. |
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 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.lang.String directory)
Deprecated. Use FileUtils.sizeOfDirectory(File) |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FilenameUtils()
Method Detail |
public static boolean fileExists(java.lang.String fileName)
fileName
- The name of the file to check.
public static void fileDelete(java.lang.String fileName)
fileName
- The name of the file to delete.public static void mkdir(java.lang.String dir)
dir
- directory to createpublic 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 filename
public static java.lang.String getExtension(java.lang.String filename)
foo.txt --> "txt" a\b\c.jpg --> "jpg" a\b\c --> ""
filename
- the filename
public static java.lang.String removePath(java.lang.String filepath)
basename
ie.
a/b/c.txt --> c.txt a.txt --> a.txt
filepath
- the filepath
public static java.lang.String removePath(java.lang.String filepath, char fileSeparatorChar)
a/b/c.txt --> c.txt a.txt --> a.txt
filepath
- the filepathfileSeparatorChar
- the file separator character to use
public static java.lang.String getPath(java.lang.String filepath)
dirname
.
ie.
a/b/c.txt --> a/b a.txt --> ""
filepath
- the filepath
public 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 to use
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 normalize
null
if too many ..'s.public static java.lang.String catPath(java.lang.String lookupPath, java.lang.String path)
..
will be
properly handled.
Eg.,
/a/b/c
+ d
= /a/b/d
/a/b/c
+ ../d
= /a/d
public 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 java.lang.String basename(java.lang.String filename)
filename
- filename to inspect
public static java.lang.String basename(java.lang.String filename, java.lang.String suffix)
filename
- filename to inspectsuffix
- additional remaining portion of name that if matches will
be removed
public static void forceDelete(java.lang.String file) throws java.io.IOException
FileUtils.forceDelete(File)
file
- file or directory to delete.
java.io.IOException
- in case deletion is unsuccessfulpublic static void cleanDirectory(java.lang.String directory) throws java.io.IOException
FileUtils.cleanDirectory(File)
directory
- directory to clean
java.io.IOException
- in case cleaning is unsuccessfulpublic static long sizeOfDirectory(java.lang.String directory)
FileUtils.sizeOfDirectory(File)
directory
- directory to inspect
public static void copyFileToDirectory(java.lang.String source, java.lang.String destinationDirectory) throws java.io.IOException, java.io.FileNotFoundException
FileUtils.copyFileToDirectory(File, File)
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 deleteDirectory(java.lang.String directory) throws java.io.IOException
FileUtils.deleteDirectory(File)
directory
- directory to delete
java.io.IOException
- in case deletion is unsuccessfulpublic static java.lang.String dirname(java.lang.String filename)
FileUtils#getPath(File)
TODO DELETE before 1.0
filename
- filename to inspect
public static java.lang.String filename(java.lang.String filename)
FileUtils#removeExtension(File)
TODO DELETE before 1.0
filename
- filename to inspect
public static java.lang.String extension(java.lang.String filename)
FileUtils#getExtension(File)
TODO probably duplicate method. See getExtension
filename
- filename to inspect
public static java.io.File getFile(java.lang.String fileName)
java.io.File#Constructor(String)
fileName
- The name of the file.
File
instance.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |