IOHelper (java-common-helper 2.3 API)

java.lang.Object
- com.library.common.IOHelper

```
public class IOHelper
extends Object
```
A generic IO Utility based on Apache Commons-IO library

构造器概要

构造器
构造器和说明

IOHelper()

构造器
构造器和说明
`IOHelper()`

方法概要

All Methods Static Methods Concrete Methods
限定符和类型	方法和说明
`static void`	`cleanDirectory(String strDirPath)` Cleans a directory without deleting it.
`static boolean`	`contentEquals(String strSourcePath, String strDirPath)` Compares the contents of two files to determine if they are equal or not.
`static void`	`copyDirectory(String strSrcDirPath, String strDestDirPath)` Copies a whole directory to a new location
`static void`	`copyDirectoryUnderDirectory(String strSrcDirPath, String strDestDirPath)` Copies a whole directory to within another directory
`static void`	`copyFile(File src, File dest)` Copies a file to a new location.
`static void`	`copyFile(String strSrcFilePath, String strDestFilePath)` Copies a file to a new location.
`static void`	`copyFileToDirectory(String strSrcFilePath, String strDestDirPath)` Copies a file to a directory
`static void`	`createNestDirectory(String strDir)` Makes a directory, including any necessary but nonexistent parent directories.
`static void`	`creatFile(String filePath)` Creat file.
`static void`	`deleteDirectory(String strDirPath)` Deletes a directory recursively.
`static void`	`deleteFile(String strFilePath)` Deletes a file
`static void`	`downFileFromUrl(String url, String strLocalFilePath)` Download URL file to local file
`static void`	`downSourceFromUrl(String strURL, String strFilePath)` Copies bytes from the URL source to a file destination.
`static String`	`getBaseName(String strFileName)` Gets the base name, minus the full path and extension, from a full filename.
`static String`	`getExtension(String strFileName)` Gets the extension of a filename.
`static long`	`getFreeSpace()` Returns the disk size of the volume which holds the working directory.
`static long`	`getFreeSpace(String strDrivePath)` Get the free space on a drive
`static String`	`getFullPath(String strFileName)` Gets the full path from a full filename, which is the prefix + path.
`static String`	`getFullPathNoEndSeparator(String strFileName)` Gets the full path from a full filename, which is the prefix + path, and also excluding the final directory separator.
`static String`	`getName(String strFileName)` Gets the name minus the path from a full filename.
`static String`	`getPath(String strFileName)` Gets the path from a full filename, which excludes the prefix.
`static String`	`getPathNoEndSeparator(String strFileName)` Gets the path from a full filename, which excludes the prefix, and also excluding the final directory separator.
`static String`	`getPrefix(String strFileName)` Gets the prefix from a full filename C:\dev\project\file.txt - C:\
`static long`	`getSizeOfDirectory(String strdirpath)` Counts the size of a directory recursively (sum of the length of all files).
`static long`	`getSizeOfFile(String strfilepath)` Get the size of the specified file
`static String`	`getSourceFromUrl(String url)` Convert from a URL to a String
`static String`	`getTempDirectory()` Returns the path to the system temporary directory.
`static String`	`getUserDirectory()` Returns the path to the user's home directory.
`static List<String>`	`listFileNamesInDirectoryRecursive(String strdirpath, String WildcardFileFilter)` Finds file names within a given directory (and its all subdirectories).
`static List<String>`	`listFilesInDirectory(String strdirpath)` Finds files within a given directory.
`static List<String>`	`listFilesInDirectory(String strdirpath, String WildcardFileFilter)` Finds files within a given directory.
`static List<String>`	`listFilesInDirectory(String strdirpath, String[] extensions)` Finds files within a given directory which match an array of extensions.
`static List<String>`	`listFilesInDirectoryRecursive(String strdirpath)` Finds files within a given directory (and its subdirectories).
`static List<String>`	`listFilesInDirectoryRecursive(String strdirpath, String WildcardFileFilter)` Finds files within a given directory (and its all subdirectories).
`static List<String>`	`listFilesInDirectoryRecursive(String strdirpath, String[] extensions)` Finds files within a given directory (and its subdirectories) which match an array of extensions.
`static List<String>`	`listFilesInDirectoryRecursive(String strdirpath, String WildcardFileFilter, String WildcardDirFilter)` Finds files within a given directory (and its specified subdirectories).
`static void`	`main(String[] args)` The entry point of application.
`static void`	`moveDirectoryUnderDirectory(String strSrcDirPath, String strDestDirPath)` Moves a directory to the destination directory.
`static void`	`moveFile(String strSrcFilePath, String strDestFilePath)` Moves a file
`static void`	`moveFileToDirectory(String strSrcFilePath, String strDestDirPath)` Moves a file to a directory.
`static String`	`readFileToString(String strFilePath)` Reads the contents of a file into a String
`static List<String>`	`readLinesToList(String strfilepath)` Reads the contents of a file line by line to a List of Strings
`static boolean`	`wildcardMatch(String filename, String wildcardMatcher)` Checks a filename to see if it matches the specified wildcard matcher, always testing case-sensitive.
`static boolean`	`wildcardMatch(String filename, String wildcardMatcher, org.apache.commons.io.IOCase caseSensitivity)` Checks a filename to see if it matches the specified wildcard matcher, always testing case-sensitive.
`static void`	`writeLinesToFile(String strfilepath, List<String> lines)` Writes a List of Strings to the specified File line by line.
`static void`	`writeStringToFile(String str, String strFilePath)` Writes a String to a file creating the file if it does not exist.

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

- 构造器详细资料
  - IOHelper
```
public IOHelper()
```
- 方法详细资料
  - main
```
public static void main(String[] args)
                 throws Exception
```
    The entry point of application.
    
    参数:
    
    args - the input arguments
    
    抛出:
    
    Exception - the exception
  - cleanDirectory
```
public static void cleanDirectory(String strDirPath)
```
    Cleans a directory without deleting it.
    
    参数:
    
    strDirPath - the str dir path
  - contentEquals
```
public static boolean contentEquals(String strSourcePath,
                                    String strDirPath)
```
    Compares the contents of two files to determine if they are equal or not.
    
    参数:
    
    strSourcePath - the str source path
    
    strDirPath - the str dir path
    
    返回:
    
    boolean boolean
  - copyFile
```
public static void copyFile(String strSrcFilePath,
                            String strDestFilePath)
```
    Copies a file to a new location.
    
    参数:
    
    strSrcFilePath - the str src file path
    
    strDestFilePath - the str dest file path
  - copyFile
```
public static void copyFile(File src,
                            File dest)
```
    Copies a file to a new location.
    
    参数:
    
    src - the src
    
    dest - the dest
  - copyFileToDirectory
```
public static void copyFileToDirectory(String strSrcFilePath,
                                       String strDestDirPath)
```
    Copies a file to a directory
    
    参数:
    
    strSrcFilePath - the str src file path
    
    strDestDirPath - the str dest dir path
  - copyDirectory
```
public static void copyDirectory(String strSrcDirPath,
                                 String strDestDirPath)
```
    Copies a whole directory to a new location
    
    参数:
    
    strSrcDirPath - the str src dir path
    
    strDestDirPath - the str dest dir path
  - copyDirectoryUnderDirectory
```
public static void copyDirectoryUnderDirectory(String strSrcDirPath,
                                               String strDestDirPath)
```
    Copies a whole directory to within another directory
    
    参数:
    
    strSrcDirPath - the str src dir path
    
    strDestDirPath - the str dest dir path
  - getSourceFromUrl
```
public static String getSourceFromUrl(String url)
```
    Convert from a URL to a String
    
    参数:
    
    url - the url
    
    返回:
    
    source from url
  - downSourceFromUrl
```
public static void downSourceFromUrl(String strURL,
                                     String strFilePath)
```
    Copies bytes from the URL source to a file destination.
    
    参数:
    
    strURL - the str url
    
    strFilePath - the str file path
  - downFileFromUrl
```
public static void downFileFromUrl(String url,
                                   String strLocalFilePath)
```
    Download URL file to local file
    
    参数:
    
    url - the url
    
    strLocalFilePath - the str local file path
  - deleteDirectory
```
public static void deleteDirectory(String strDirPath)
```
    Deletes a directory recursively.
    
    参数:
    
    strDirPath - the str dir path
  - deleteFile
```
public static void deleteFile(String strFilePath)
```
    Deletes a file
    
    参数:
    
    strFilePath - the str file path
  - getTempDirectory
```
public static String getTempDirectory()
```
    Returns the path to the system temporary directory.
    
    返回:
    
    temp directory
  - getUserDirectory
```
public static String getUserDirectory()
```
    Returns the path to the user's home directory.
    
    返回:
    
    user directory
  - creatFile
```
public static void creatFile(String filePath)
```
    Creat file.
    
    参数:
    
    filePath - the file path
  - createNestDirectory
```
public static void createNestDirectory(String strDir)
```
    Makes a directory, including any necessary but nonexistent parent directories.
    
    参数:
    
    strDir - the str dir
  - getBaseName
```
public static String getBaseName(String strFileName)
```
    Gets the base name, minus the full path and extension, from a full filename. C:\dev\project\file.txt - file
    
    参数:
    
    strFileName - the str file name
    
    返回:
    
    base name
  - getExtension
```
public static String getExtension(String strFileName)
```
    Gets the extension of a filename. C:\dev\project\file.txt - txt
    
    参数:
    
    strFileName - the str file name
    
    返回:
    
    extension extension
  - getFullPath
```
public static String getFullPath(String strFileName)
```
    Gets the full path from a full filename, which is the prefix + path. C:\dev\project\file.txt - C:\dev\project\
    
    参数:
    
    strFileName - the str file name
    
    返回:
    
    full path
  - getFullPathNoEndSeparator
```
public static String getFullPathNoEndSeparator(String strFileName)
```
    Gets the full path from a full filename, which is the prefix + path, and also excluding the final directory separator. C:\dev\project\file.txt - C:\dev\project
    
    参数:
    
    strFileName - the str file name
    
    返回:
    
    full path no end separator
  - getName
```
public static String getName(String strFileName)
```
    Gets the name minus the path from a full filename. C:\dev\project\file.txt - file.txt
    
    参数:
    
    strFileName - the str file name
    
    返回:
    
    name name
  - getPath
```
public static String getPath(String strFileName)
```
    Gets the path from a full filename, which excludes the prefix. C:\dev\project\file.txt - dev\project\
    
    参数:
    
    strFileName - the str file name
    
    返回:
    
    path path
  - getPathNoEndSeparator
```
public static String getPathNoEndSeparator(String strFileName)
```
    Gets the path from a full filename, which excludes the prefix, and also excluding the final directory separator. C:\dev\project\file.txt - dev\project
    
    参数:
    
    strFileName - the str file name
    
    返回:
    
    path no end separator
  - getPrefix
```
public static String getPrefix(String strFileName)
```
    Gets the prefix from a full filename C:\dev\project\file.txt - C:\
    
    参数:
    
    strFileName - the str file name
    
    返回:
    
    prefix prefix
  - wildcardMatch
```
public static boolean wildcardMatch(String filename,
                                    String wildcardMatcher,
                                    org.apache.commons.io.IOCase caseSensitivity)
```
    Checks a filename to see if it matches the specified wildcard matcher, always testing case-sensitive.
    
    参数:
    
    filename - - the filename to match on
    
    wildcardMatcher - - the wildcard string to match against
    
    caseSensitivity - - what case sensitivity rule to use, null means case-sensitive
    
    返回:
    
    boolean boolean
  - wildcardMatch
```
public static boolean wildcardMatch(String filename,
                                    String wildcardMatcher)
```
    Checks a filename to see if it matches the specified wildcard matcher, always testing case-sensitive.
    
    参数:
    
    filename - - the filename to match on
    
    wildcardMatcher - - the wildcard string to match against
    
    返回:
    
    boolean boolean
  - getSizeOfFile
```
public static long getSizeOfFile(String strfilepath)
```
    Get the size of the specified file
    
    参数:
    
    strfilepath - the strfilepath
    
    返回:
    
    size of file
  - getSizeOfDirectory
```
public static long getSizeOfDirectory(String strdirpath)
```
    Counts the size of a directory recursively (sum of the length of all files).
    
    参数:
    
    strdirpath - the strdirpath
    
    返回:
    
    size of directory
  - getFreeSpace
```
public static long getFreeSpace(String strDrivePath)
                         throws IOException
```
    Get the free space on a drive
    
    参数:
    
    strDrivePath - the str drive path
    
    返回:
    
    free spacethe io exception
    
    抛出:
    
    IOException - the io exception
  - getFreeSpace
```
public static long getFreeSpace()
                         throws IOException
```
    Returns the disk size of the volume which holds the working directory.
    
    返回:
    
    free space
    
    抛出:
    
    IOException - the io exception
  - listFilesInDirectory
```
public static List<String> listFilesInDirectory(String strdirpath)
```
    Finds files within a given directory.
    
    参数:
    
    strdirpath - the strdirpath
    
    返回:
    
    list list
  - listFilesInDirectory
```
public static List<String> listFilesInDirectory(String strdirpath,
                                                String WildcardFileFilter)
```
    Finds files within a given directory. All files found are filtered by an IOFileFilter.
    
    参数:
    
    strdirpath - the strdirpath
    
    WildcardFileFilter - filter to apply when finding files. such as "*.*"
    
    返回:
    
    list list
  - listFilesInDirectory
```
public static List<String> listFilesInDirectory(String strdirpath,
                                                String[] extensions)
```
    Finds files within a given directory which match an array of extensions.
    
    参数:
    
    strdirpath - the strdirpath
    
    extensions - an array of extensions.such as new String[]{"java","xml"}
    
    返回:
    
    list list
  - listFilesInDirectoryRecursive
```
public static List<String> listFilesInDirectoryRecursive(String strdirpath)
```
    Finds files within a given directory (and its subdirectories).
    
    参数:
    
    strdirpath - the strdirpath
    
    返回:
    
    list list
  - listFilesInDirectoryRecursive
```
public static List<String> listFilesInDirectoryRecursive(String strdirpath,
                                                         String WildcardFileFilter)
```
    Finds files within a given directory (and its all subdirectories). All files found are filtered by an IOFileFilter.
    
    参数:
    
    strdirpath - the strdirpath
    
    WildcardFileFilter - filter to apply when finding files. such as "*.*"
    
    返回:
    
    list list
  - listFileNamesInDirectoryRecursive
```
public static List<String> listFileNamesInDirectoryRecursive(String strdirpath,
                                                             String WildcardFileFilter)
```
    Finds file names within a given directory (and its all subdirectories). All files found are filtered by an IOFileFilter.
    
    参数:
    
    strdirpath - the strdirpath
    
    WildcardFileFilter - filter to apply when finding files. such as "*.*"
    
    返回:
    
    list list
  - listFilesInDirectoryRecursive
```
public static List<String> listFilesInDirectoryRecursive(String strdirpath,
                                                         String[] extensions)
```
    Finds files within a given directory (and its subdirectories) which match an array of extensions.
    
    参数:
    
    strdirpath - the strdirpath
    
    extensions - an array of extensions.such as new String[]{"java","xml"}
    
    返回:
    
    list list
  - listFilesInDirectoryRecursive
```
public static List<String> listFilesInDirectoryRecursive(String strdirpath,
                                                         String WildcardFileFilter,
                                                         String WildcardDirFilter)
```
    Finds files within a given directory (and its specified subdirectories). All files found are filtered by an IOFileFilter.
    
    参数:
    
    strdirpath - the strdirpath
    
    WildcardFileFilter - filter to apply when finding files. such as "*.*"
    
    WildcardDirFilter - filter to apply when finding directory. such as "*"
    
    返回:
    
    list list
  - moveFile
```
public static void moveFile(String strSrcFilePath,
                            String strDestFilePath)
```
    Moves a file
    
    参数:
    
    strSrcFilePath - the str src file path
    
    strDestFilePath - the str dest file path
  - moveFileToDirectory
```
public static void moveFileToDirectory(String strSrcFilePath,
                                       String strDestDirPath)
```
    Moves a file to a directory.
    
    参数:
    
    strSrcFilePath - the str src file path
    
    strDestDirPath - the str dest dir path
  - moveDirectoryUnderDirectory
```
public static void moveDirectoryUnderDirectory(String strSrcDirPath,
                                               String strDestDirPath)
```
    Moves a directory to the destination directory.
    
    参数:
    
    strSrcDirPath - the str src dir path
    
    strDestDirPath - the str dest dir path
  - readLinesToList
```
public static List<String> readLinesToList(String strfilepath)
```
    Reads the contents of a file line by line to a List of Strings
    
    参数:
    
    strfilepath - the strfilepath
    
    返回:
    
    list list
  - readFileToString
```
public static String readFileToString(String strFilePath)
```
    Reads the contents of a file into a String
    
    参数:
    
    strFilePath - the str file path
    
    返回:
    
    string string
  - writeLinesToFile
```
public static void writeLinesToFile(String strfilepath,
                                    List<String> lines)
```
    Writes a List of Strings to the specified File line by line.
    
    参数:
    
    strfilepath - the strfilepath
    
    lines - the lines
  - writeStringToFile
```
public static void writeStringToFile(String str,
                                     String strFilePath)
```
    Writes a String to a file creating the file if it does not exist.
    
    参数:
    
    str - the str
    
    strFilePath - the str file path

类 IOHelper

构造器概要

方法概要

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

构造器详细资料

IOHelper

方法详细资料

main

cleanDirectory

contentEquals

copyFile

copyFile

copyFileToDirectory

copyDirectory

copyDirectoryUnderDirectory

getSourceFromUrl

downSourceFromUrl

downFileFromUrl

deleteDirectory

deleteFile

getTempDirectory

getUserDirectory

creatFile

createNestDirectory

getBaseName

getExtension

getFullPath

getFullPathNoEndSeparator

getName

getPath

getPathNoEndSeparator

getPrefix

wildcardMatch

wildcardMatch

getSizeOfFile

getSizeOfDirectory

getFreeSpace

getFreeSpace

listFilesInDirectory

listFilesInDirectory

listFilesInDirectory

listFilesInDirectoryRecursive

listFilesInDirectoryRecursive

listFileNamesInDirectoryRecursive

listFilesInDirectoryRecursive

listFilesInDirectoryRecursive

moveFile

moveFileToDirectory

moveDirectoryUnderDirectory

readLinesToList

readFileToString

writeLinesToFile

writeStringToFile