FileUtility (onecode-common-client 1.1.1 API)

java.lang.Object
- com.ds.common.util.FileUtility

```
public final class FileUtility
extends Object
```
Title: 常用代码打包

Description: This class provides basic facilities for manipulating files and file paths.
Path-related methods

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.

File-related methods

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.

Copyright: Copyright (c) 2006

Company: www.justdos.net
版本:

1.0

作者:

wenzhang li

字段概要

字段
限定符和类型	字段和说明
`static int`	`DISKFILE_DOC`
`static int`	`DISKFILE_JPG`
`static int`	`DISKFILE_MUSIC`
`static int`	`DISKFILE_OTHER` Private constructor to prevent instantiation.
`static int`	`DISKFILE_PDF`
`static int`	`DISKFILE_PIC`
`static int`	`DISKFILE_PNG`
`static int`	`DISKFILE_SWF`
`static int`	`DISKFILE_VIDEO`
`static int`	`DISKFILE_ZIP`

方法概要

所有方法静态方法具体方法已过时的方法
限定符和类型	方法和说明
`static String`	`catPath(String lookupPath, String path)` Will concatenate 2 paths, dealing with `..`
`static int`	`checkOfficeType(String oldfilepath)` 检测文件类型,是否是 office文档
`static int`	`checkPictureType(String oldfilepath)` 检测文件类型,是否是 picture
`static int`	`checkVideoFileType(String oldfilepath)` 检测文件类型是否是视频文件
`static void`	`cleanDirectory(File directory)` Clean a directory without deleting it.
`static void`	`cleanDirectory(String directory)` Clean a directory without deleting it.
`static boolean`	`contentEquals(File file1, File file2)` Compare the contents of two files to determine if they are equal or not.
`static void`	`copyFile(File source, File destination)` Copy file from source to destination.
`static void`	`copyFileToDirectory(File source, File destinationDirectory)` Copy file from source to destination.
`static void`	`copyFileToDirectory(String source, String destinationDirectory)` Copy file from source to destination.
`static void`	`copyURLToFile(URL source, File destination)` Copies bytes from the URL `source` to a file `destination`.
`static void`	`deleteDirectory(File directory)` Recursively delete a directory.
`static void`	`deleteDirectory(String directory)` Recursively delete a directory.
`static void`	`forceDelete(File file)` Delete a file.
`static void`	`forceDelete(String file)` Delete a file.
`static String`	`getExtension(String filename)` Get extension from filename.
`static int`	`getFileType(String filename)` 根据文件后缀名得到文件类型
`static String`	`getPath(String filepath)` Get path from filename.
`static String`	`getPath(String filepath, char fileSeparatorChar)` Get path from filename.
`static File`	`getUniqueFile(String dir, String originFile)` Get an unique file
`static File`	`getUniquePath(String basePath, String subPath)` Get an unique path file
`static String`	`normalize(String path)` Normalize a path.
`static String`	`removeExtension(String filename)` Remove extension from filename.
`static String`	`removeExtention(String filename)` 已过时。 Use removeExtension as removeExtention is mispelled
`static String`	`removePath(String filepath)` Remove path from filename.
`static String`	`removePath(String filepath, char fileSeparatorChar)` Remove path from filename.
`static File`	`resolveFile(File baseFile, String filename)` Resolve a file `filename` to it's canonical form.
`static long`	`sizeOfDirectory(File directory)` Recursively count size of a directory.
`static long`	`sizeOfDirectory(String directory)` Recursively count size of a directory.
`static File`	`toFile(URL url)` Convert from a `URL` to a `File`.
`static URL[]`	`toURLs(File[] files)` Convert the array of Files into a list of URLs.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DISKFILE_OTHER
```
public static final int DISKFILE_OTHER
```
    Private constructor to prevent instantiation.
    
    另请参阅:
    
    常量字段值
  - DISKFILE_DOC
```
public static final int DISKFILE_DOC
```
    另请参阅:
    
    常量字段值
  - DISKFILE_PIC
```
public static final int DISKFILE_PIC
```
    另请参阅:
    
    常量字段值
  - DISKFILE_MUSIC
```
public static final int DISKFILE_MUSIC
```
    另请参阅:
    
    常量字段值
  - DISKFILE_VIDEO
```
public static final int DISKFILE_VIDEO
```
    另请参阅:
    
    常量字段值
  - DISKFILE_ZIP
```
public static final int DISKFILE_ZIP
```
    另请参阅:
    
    常量字段值
  - DISKFILE_SWF
```
public static final int DISKFILE_SWF
```
    另请参阅:
    
    常量字段值
  - DISKFILE_PDF
```
public static final int DISKFILE_PDF
```
    另请参阅:
    
    常量字段值
  - DISKFILE_JPG
```
public static final int DISKFILE_JPG
```
    另请参阅:
    
    常量字段值
  - DISKFILE_PNG
```
public static final int DISKFILE_PNG
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - contentEquals
```
public static boolean contentEquals(File file1,
                                    File file2)
                             throws IOException
```
    Compare the contents of two files to determine if they are equal or not.
    
    参数:
    
    file1 - the first file
    
    file2 - the second file
    
    返回:
    
    true if the content of the files are equal or they both don't exist, false otherwise
    
    抛出:
    
    IOException
  - toFile
```
public static File toFile(URL url)
```
    Convert from a URL to a File.
    
    参数:
    
    url - File URL.
    
    返回:
    
    The equivalent File object, or null if the URL's protocol is not file
  - toURLs
```
public static URL[] toURLs(File[] files)
                    throws IOException
```
    Convert the array of Files into a list of URLs.
    
    参数:
    
    files - the array of files
    
    返回:
    
    the array of URLs
    
    抛出:
    
    IOException - if an error occurs
  - removeExtention
```
public static String removeExtention(String filename)
```
    已过时。 Use removeExtension as removeExtention is mispelled
    Remove extension from filename. ie
```
 foo.txt    --> foo
 a\b\c.jpg --> a\b\c
 a\b\c     --> a\b\c
 
```
    参数:
    
    filename - the filename
    
    返回:
    
    the filename minus extension
  - removeExtension
```
public static String removeExtension(String filename)
```
    Remove extension from filename. ie
```
 foo.txt    --> foo
 a\b\c.jpg --> a\b\c
 a\b\c     --> a\b\c
 
```
    参数:
    
    filename - the filename
    
    返回:
    
    the filename minus extension
  - getExtension
```
public static String getExtension(String filename)
```
    Get extension from filename. ie
```
 foo.txt    --> "txt"
 a\b\c.jpg --> "jpg"
 a\b\c     --> ""
 
```
    参数:
    
    filename - the filename
    
    返回:
    
    the extension of filename or "" if none
  - removePath
```
public static String removePath(String filepath)
```
    Remove path from filename. Equivalent to the unix command basename ie.
```
 a/b/c.txt --> c.txt
 a.txt     --> a.txt
 
```
    参数:
    
    filepath - the filepath
    
    返回:
    
    the filename minus path
  - removePath
```
public static String removePath(String filepath,
                                char fileSeparatorChar)
```
    Remove path from filename. ie.
```
 a/b/c.txt --> c.txt
 a.txt     --> a.txt
 
```
    参数:
    
    filepath - the filepath
    
    返回:
    
    the filename minus path
  - getPath
```
public static String getPath(String filepath)
```
    Get path from filename. Roughly equivalent to the unix command dirname. ie.
```
 a/b/c.txt --> a/b
 a.txt     --> ""
 
```
    参数:
    
    filepath - the filepath
    
    返回:
    
    the filename minus path
  - getFileType
```
public static int getFileType(String filename)
```
    根据文件后缀名得到文件类型
    
    参数:
    
    oldfilepath -
    
    返回:
  - checkOfficeType
```
public static int checkOfficeType(String oldfilepath)
```
    检测文件类型,是否是 office文档
    
    参数:
    
    oldfilepath -
    
    返回:
    
    0 不是office文档
  - checkPictureType
```
public static int checkPictureType(String oldfilepath)
```
    检测文件类型,是否是 picture
    
    参数:
    
    oldfilepath -
    
    返回:
    
    0 不是office文档
  - checkVideoFileType
```
public static int checkVideoFileType(String oldfilepath)
```
    检测文件类型是否是视频文件
    
    参数:
    
    oldfilepath -
    
    返回:
    
    0 不是视频文件
  - getPath
```
public static String getPath(String filepath,
                             char fileSeparatorChar)
```
    Get path from filename. ie.
```
 a/b/c.txt --> a/b
 a.txt     --> ""
 
```
    参数:
    
    filepath - the filepath
    
    返回:
    
    the filename minus path
  - copyFileToDirectory
```
public static void copyFileToDirectory(String source,
                                       String destinationDirectory)
                                throws IOException
```
    Copy file from source to destination. If 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.
    
    destination - A directory to copy source into.
    
    抛出:
    
    FileNotFoundException - if source isn't a normal file.
    
    IllegalArgumentException - if destinationDirectory isn't a directory.
    
    IOException - if source does not exist, the file in destinationDirectory cannot be written to, or an IO error occurs during copying.
  - copyFileToDirectory
```
public static void copyFileToDirectory(File source,
                                       File destinationDirectory)
                                throws IOException
```
    Copy file from source to destination. If 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.
    
    destination - A directory to copy source into.
    
    抛出:
    
    FileNotFoundException - if source isn't a normal file.
    
    IllegalArgumentException - if destinationDirectory isn't a directory.
    
    IOException - if source does not exist, the file in destinationDirectory cannot be written to, or an IO error occurs during copying.
  - copyFile
```
public static void copyFile(File source,
                            File destination)
                     throws IOException
```
    Copy file from source to 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 existing non-directory File to copy bytes from.
    
    destination - A non-directory File to write bytes to (possibly overwriting).
    
    抛出:
    
    IOException - if source does not exist, destination cannot be written to, or an IO error occurs during copying.
    
    FileNotFoundException - if destination is a directory (use copyFileToDirectory(java.lang.String, java.lang.String)).
  - copyURLToFile
```
public static void copyURLToFile(URL source,
                                 File destination)
                          throws IOException
```
    Copies bytes from the URL 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).
    
    抛出:
    IOException - if
    
    source URL cannot be opened
    
    destination cannot be written to
    
    an IO error occurs during copying
  - normalize
```
public static String normalize(String path)
```
    Normalize a path. Eliminates "/../" and "/./" in a string. Returns 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
    
    返回:
    
    the normalized String, or null if too many ..'s.
  - catPath
```
public static String catPath(String lookupPath,
                             String path)
```
    Will concatenate 2 paths, dealing with ..
    Eg.,
    /a/b/c + d = /a/b/d
    /a/b/c + ../d = /a/d
    
    Thieved from Tomcat sources...
    
    返回:
    
    The concatenated paths, or null if error occurs
  - resolveFile
```
public static File resolveFile(File baseFile,
                               String filename)
```
    Resolve a file 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.
    
    返回:
    
    The canonical File of filename.
  - forceDelete
```
public static void forceDelete(String file)
                        throws IOException
```
    Delete a file. If file is directory delete it and all sub-directories.
    
    抛出:
    
    IOException
  - forceDelete
```
public static void forceDelete(File file)
                        throws IOException
```
    Delete a file. If file is directory delete it and all sub-directories.
    
    抛出:
    
    IOException
  - deleteDirectory
```
public static void deleteDirectory(String directory)
                            throws IOException
```
    Recursively delete a directory.
    
    抛出:
    
    IOException
  - deleteDirectory
```
public static void deleteDirectory(File directory)
                            throws IOException
```
    Recursively delete a directory.
    
    抛出:
    
    IOException
  - cleanDirectory
```
public static void cleanDirectory(String directory)
                           throws IOException
```
    Clean a directory without deleting it.
    
    抛出:
    
    IOException
  - cleanDirectory
```
public static void cleanDirectory(File directory)
                           throws IOException
```
    Clean a directory without deleting it.
    
    抛出:
    
    IOException
  - sizeOfDirectory
```
public static long sizeOfDirectory(String directory)
```
    Recursively count size of a directory.
    
    返回:
    
    size of directory in bytes.
  - sizeOfDirectory
```
public static long sizeOfDirectory(File directory)
```
    Recursively count size of a directory.
    
    返回:
    
    size of directory in bytes.
  - getUniquePath
```
public static File getUniquePath(String basePath,
                                 String subPath)
```
    Get an unique path file
    
    参数:
    
    basePath - base path
    
    subPath - sub directory name
    
    返回:
    
    an unique path file that not exists
  - getUniqueFile
```
public static File getUniqueFile(String dir,
                                 String originFile)
```
    Get an unique file
    
    参数:
    
    dir - the path where the file in
    
    originFile - origin file name
    
    返回:
    
    an unique file that not exists

类 FileUtility

Path-related methods

File-related methods

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DISKFILE_OTHER

DISKFILE_DOC

DISKFILE_PIC

DISKFILE_MUSIC

DISKFILE_VIDEO

DISKFILE_ZIP

DISKFILE_SWF

DISKFILE_PDF

DISKFILE_JPG

DISKFILE_PNG

方法详细资料

contentEquals

toFile

toURLs

removeExtention

removeExtension

getExtension

removePath

removePath

getPath

getFileType

checkOfficeType

checkPictureType

checkVideoFileType

getPath

copyFileToDirectory

copyFileToDirectory

copyFile

copyURLToFile

normalize

catPath

resolveFile

forceDelete

forceDelete

deleteDirectory

deleteDirectory

cleanDirectory

cleanDirectory

sizeOfDirectory

sizeOfDirectory

getUniquePath

getUniqueFile