FileUtils (Cobble Lang 4.3.1 API)

java.lang.Object
- net.hasor.cobble.io.FileUtils

```
public class FileUtils
extends Object
```
文件工具

版本:

: 2011-6-3

作者:

赵永春 (zyc@hasor.net)

构造器概要

构造器
构造器和说明

FileUtils()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`cleanDirectory(File directory)` Cleans a directory without deleting it.
`static void`	`deleteDirectory(File directory)` Deletes a directory recursively.
`static boolean`	`deleteQuietly(File file)` Deletes a file, never throwing an exception.
`static void`	`forceDelete(File file)` Deletes a file.
`static void`	`forceDeleteOnExit(File file)` Schedules a file to be deleted when JVM exits.
`static boolean`	`isSymlink(File file)` Determines whether the specified file is a Symbolic Link rather than an actual file.
`static LineIterator`	`lineIterator(File file)` Returns an Iterator for the lines in a `File` using the default encoding for the VM.
`static LineIterator`	`lineIterator(File file, String encoding)` Returns an Iterator for the lines in a `File`.
`static FileInputStream`	`openInputStream(File file)` Opens a `FileInputStream` for the specified file, providing better error messages than simply calling `new FileInputStream(file)`.
`static FileOutputStream`	`openOutputStream(File file)` Opens a `FileOutputStream` for the specified file, checking and creating the parent directory if it does not exist.
`static FileOutputStream`	`openOutputStream(File file, boolean append)` Opens a `FileOutputStream` for the specified file, checking and creating the parent directory if it does not exist.
`static byte[]`	`readFileToByteArray(File file)` Reads the contents of a file into a byte array.
`static String`	`readFileToString(File file)` Reads the contents of a file into a String using the default encoding for the VM.
`static String`	`readFileToString(File file, String encoding)` Reads the contents of a file into a String.
`static List<String>`	`readLines(File file)` Reads the contents of a file line by line to a List of Strings using the default encoding for the VM.
`static List<String>`	`readLines(File file, String encoding)` Reads the contents of a file line by line to a List of Strings.
`static void`	`write(File file, CharSequence data)` Writes a CharSequence to a file creating the file if it does not exist using the default encoding for the VM.
`static void`	`write(File file, CharSequence data, boolean append)` Writes a CharSequence to a file creating the file if it does not exist using the default encoding for the VM.
`static void`	`write(File file, CharSequence data, String encoding)` Writes a CharSequence to a file creating the file if it does not exist.
`static void`	`write(File file, CharSequence data, String encoding, boolean append)` Writes a CharSequence to a file creating the file if it does not exist.
`static void`	`writeByteArrayToFile(File file, byte[] data)` Writes a byte array to a file creating the file if it does not exist.
`static void`	`writeByteArrayToFile(File file, byte[] data, boolean append)` Writes a byte array to a file creating the file if it does not exist.
`static void`	`writeLines(File file, Collection<?> lines)` Writes the `toString()` value of each item in a collection to the specified `File` line by line.
`static void`	`writeLines(File file, Collection<?> lines, boolean append)` Writes the `toString()` value of each item in a collection to the specified `File` line by line.
`static void`	`writeLines(File file, Collection<?> lines, String lineEnding)` Writes the `toString()` value of each item in a collection to the specified `File` line by line.
`static void`	`writeLines(File file, Collection<?> lines, String lineEnding, boolean append)` Writes the `toString()` value of each item in a collection to the specified `File` line by line.
`static void`	`writeLines(File file, String encoding, Collection<?> lines)` Writes the `toString()` value of each item in a collection to the specified `File` line by line.
`static void`	`writeLines(File file, String encoding, Collection<?> lines, boolean append)` Writes the `toString()` value of each item in a collection to the specified `File` line by line, optionally appending.
`static void`	`writeLines(File file, String encoding, Collection<?> lines, String lineEnding)` Writes the `toString()` value of each item in a collection to the specified `File` line by line.
`static void`	`writeLines(File file, String encoding, Collection<?> lines, String lineEnding, boolean append)` Writes the `toString()` value of each item in a collection to the specified `File` line by line.
`static void`	`writeStringToFile(File file, String data)` Writes a String to a file creating the file if it does not exist using the default encoding for the VM.
`static void`	`writeStringToFile(File file, String data, boolean append)` Writes a String to a file creating the file if it does not exist using the default encoding for the VM.
`static void`	`writeStringToFile(File file, String data, String encoding)` Writes a String to a file creating the file if it does not exist.
`static void`	`writeStringToFile(File file, String data, String encoding, boolean append)` 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

- 构造器详细资料
  - FileUtils
```
public FileUtils()
```
- 方法详细资料
  - readFileToString
```
public static String readFileToString(File file,
                                      String encoding)
                               throws IOException
```
    Reads the contents of a file into a String. The file is always closed.
    
    参数:
    
    file - the file to read, must not be null
    
    encoding - the encoding to use, null means platform default
    
    返回:
    
    the file contents, never null
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
  - readFileToString
```
public static String readFileToString(File file)
                               throws IOException
```
    Reads the contents of a file into a String using the default encoding for the VM. The file is always closed.
    
    参数:
    
    file - the file to read, must not be null
    
    返回:
    
    the file contents, never null
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 1.3.1
  - readFileToByteArray
```
public static byte[] readFileToByteArray(File file)
                                  throws IOException
```
    Reads the contents of a file into a byte array. The file is always closed.
    
    参数:
    
    file - the file to read, must not be null
    
    返回:
    
    the file contents, never null
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 1.1
  - readLines
```
public static List<String> readLines(File file,
                                     String encoding)
                              throws IOException
```
    Reads the contents of a file line by line to a List of Strings. The file is always closed.
    
    参数:
    
    file - the file to read, must not be null
    
    encoding - the encoding to use, null means platform default
    
    返回:
    
    the list of Strings representing each line in the file, never null
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    从以下版本开始:
    
    Commons IO 1.1
  - readLines
```
public static List<String> readLines(File file)
                              throws IOException
```
    Reads the contents of a file line by line to a List of Strings using the default encoding for the VM. The file is always closed.
    
    参数:
    
    file - the file to read, must not be null
    
    返回:
    
    the list of Strings representing each line in the file, never null
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 1.3
  - lineIterator
```
public static LineIterator lineIterator(File file,
                                        String encoding)
                                 throws IOException
```
    Returns an Iterator for the lines in a File.
    This method opens an InputStream for the file. When you have finished with the iterator you should close the stream to free internal resources. This can be done by calling the LineIterator.close() or LineIterator.closeQuietly(LineIterator) method.
    The recommended usage pattern is:
```
 LineIterator it = FileUtils.lineIterator(file, "UTF-8");
 try {
   while (it.hasNext()) {
     String line = it.nextLine();
     /// do something with line
   }
 } finally {
   LineIterator.closeQuietly(iterator);
 }
 
```
    If an exception occurs during the creation of the iterator, the underlying stream is closed.
    参数:
    
    file - the file to open for input, must not be null
    
    encoding - the encoding to use, null means platform default
    
    返回:
    
    an Iterator of the lines in the file, never null
    
    抛出:
    
    IOException - in case of an I/O error (file closed)
    
    从以下版本开始:
    
    Commons IO 1.2
  - lineIterator
```
public static LineIterator lineIterator(File file)
                                 throws IOException
```
    Returns an Iterator for the lines in a File using the default encoding for the VM.
    
    参数:
    
    file - the file to open for input, must not be null
    
    返回:
    
    an Iterator of the lines in the file, never null
    
    抛出:
    
    IOException - in case of an I/O error (file closed)
    
    从以下版本开始:
    
    Commons IO 1.3
    
    另请参阅:
    
    lineIterator(File, String)
  - writeStringToFile
```
public static void writeStringToFile(File file,
                                     String data,
                                     String encoding)
                              throws IOException
```
    Writes a String to a file creating the file if it does not exist. NOTE: As from v1.3, the parent directories of the file will be created if they do not exist.
    
    参数:
    
    file - the file to write
    
    data - the content to write to the file
    
    encoding - the encoding to use, null means platform default
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
  - writeStringToFile
```
public static void writeStringToFile(File file,
                                     String data,
                                     String encoding,
                                     boolean append)
                              throws IOException
```
    Writes a String to a file creating the file if it does not exist.
    
    参数:
    
    file - the file to write
    
    data - the content to write to the file
    
    encoding - the encoding to use, null means platform default
    
    append - if true, then the String will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    从以下版本开始:
    
    Commons IO 2.1
  - writeStringToFile
```
public static void writeStringToFile(File file,
                                     String data)
                              throws IOException
```
    Writes a String to a file creating the file if it does not exist using the default encoding for the VM.
    
    参数:
    
    file - the file to write
    
    data - the content to write to the file
    
    抛出:
    
    IOException - in case of an I/O error
  - writeStringToFile
```
public static void writeStringToFile(File file,
                                     String data,
                                     boolean append)
                              throws IOException
```
    Writes a String to a file creating the file if it does not exist using the default encoding for the VM.
    
    参数:
    
    file - the file to write
    
    data - the content to write to the file
    
    append - if true, then the String will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 2.1
  - write
```
public static void write(File file,
                         CharSequence data)
                  throws IOException
```
    Writes a CharSequence to a file creating the file if it does not exist using the default encoding for the VM.
    
    参数:
    
    file - the file to write
    
    data - the content to write to the file
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 2.0
  - write
```
public static void write(File file,
                         CharSequence data,
                         boolean append)
                  throws IOException
```
    Writes a CharSequence to a file creating the file if it does not exist using the default encoding for the VM.
    
    参数:
    
    file - the file to write
    
    data - the content to write to the file
    
    append - if true, then the data will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 2.1
  - write
```
public static void write(File file,
                         CharSequence data,
                         String encoding)
                  throws IOException
```
    Writes a CharSequence to a file creating the file if it does not exist.
    
    参数:
    
    file - the file to write
    
    data - the content to write to the file
    
    encoding - the encoding to use, null means platform default
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    从以下版本开始:
    
    Commons IO 2.0
  - write
```
public static void write(File file,
                         CharSequence data,
                         String encoding,
                         boolean append)
                  throws IOException
```
    Writes a CharSequence to a file creating the file if it does not exist.
    
    参数:
    
    file - the file to write
    
    data - the content to write to the file
    
    encoding - the encoding to use, null means platform default
    
    append - if true, then the data will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    从以下版本开始:
    
    IO 2.1
  - writeByteArrayToFile
```
public static void writeByteArrayToFile(File file,
                                        byte[] data)
                                 throws IOException
```
    Writes a byte array to a file creating the file if it does not exist.
    NOTE: As from v1.3, the parent directories of the file will be created if they do not exist.
    
    参数:
    
    file - the file to write to
    
    data - the content to write to the file
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 1.1
  - writeByteArrayToFile
```
public static void writeByteArrayToFile(File file,
                                        byte[] data,
                                        boolean append)
                                 throws IOException
```
    Writes a byte array to a file creating the file if it does not exist.
    
    参数:
    
    file - the file to write to
    
    data - the content to write to the file
    
    append - if true, then bytes will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    IO 2.1
  - writeLines
```
public static void writeLines(File file,
                              String encoding,
                              Collection<?> lines)
                       throws IOException
```
    Writes the toString() value of each item in a collection to the specified File line by line. The specified character encoding and the default line ending will be used.
    NOTE: As from v1.3, the parent directories of the file will be created if they do not exist.
    
    参数:
    
    file - the file to write to
    
    encoding - the encoding to use, null means platform default
    
    lines - the lines to write, null entries produce blank lines
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    从以下版本开始:
    
    Commons IO 1.1
  - writeLines
```
public static void writeLines(File file,
                              String encoding,
                              Collection<?> lines,
                              boolean append)
                       throws IOException
```
    Writes the toString() value of each item in a collection to the specified File line by line, optionally appending. The specified character encoding and the default line ending will be used.
    
    参数:
    
    file - the file to write to
    
    encoding - the encoding to use, null means platform default
    
    lines - the lines to write, null entries produce blank lines
    
    append - if true, then the lines will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    从以下版本开始:
    
    Commons IO 2.1
  - writeLines
```
public static void writeLines(File file,
                              Collection<?> lines)
                       throws IOException
```
    Writes the toString() value of each item in a collection to the specified File line by line. The default VM encoding and the default line ending will be used.
    
    参数:
    
    file - the file to write to
    
    lines - the lines to write, null entries produce blank lines
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 1.3
  - writeLines
```
public static void writeLines(File file,
                              Collection<?> lines,
                              boolean append)
                       throws IOException
```
    Writes the toString() value of each item in a collection to the specified File line by line. The default VM encoding and the default line ending will be used.
    
    参数:
    
    file - the file to write to
    
    lines - the lines to write, null entries produce blank lines
    
    append - if true, then the lines will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 2.1
  - writeLines
```
public static void writeLines(File file,
                              String encoding,
                              Collection<?> lines,
                              String lineEnding)
                       throws IOException
```
    Writes the toString() value of each item in a collection to the specified File line by line. The specified character encoding and the line ending will be used.
    NOTE: As from v1.3, the parent directories of the file will be created if they do not exist.
    
    参数:
    
    file - the file to write to
    
    encoding - the encoding to use, null means platform default
    
    lines - the lines to write, null entries produce blank lines
    
    lineEnding - the line separator to use, null is system default
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    从以下版本开始:
    
    Commons IO 1.1
  - writeLines
```
public static void writeLines(File file,
                              String encoding,
                              Collection<?> lines,
                              String lineEnding,
                              boolean append)
                       throws IOException
```
    Writes the toString() value of each item in a collection to the specified File line by line. The specified character encoding and the line ending will be used.
    
    参数:
    
    file - the file to write to
    
    encoding - the encoding to use, null means platform default
    
    lines - the lines to write, null entries produce blank lines
    
    lineEnding - the line separator to use, null is system default
    
    append - if true, then the lines will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    从以下版本开始:
    
    Commons IO 2.1
  - writeLines
```
public static void writeLines(File file,
                              Collection<?> lines,
                              String lineEnding)
                       throws IOException
```
    Writes the toString() value of each item in a collection to the specified File line by line. The default VM encoding and the specified line ending will be used.
    
    参数:
    
    file - the file to write to
    
    lines - the lines to write, null entries produce blank lines
    
    lineEnding - the line separator to use, null is system default
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 1.3
  - writeLines
```
public static void writeLines(File file,
                              Collection<?> lines,
                              String lineEnding,
                              boolean append)
                       throws IOException
```
    Writes the toString() value of each item in a collection to the specified File line by line. The default VM encoding and the specified line ending will be used.
    
    参数:
    
    file - the file to write to
    
    lines - the lines to write, null entries produce blank lines
    
    lineEnding - the line separator to use, null is system default
    
    append - if true, then the lines will be added to the end of the file rather than overwriting
    
    抛出:
    
    IOException - in case of an I/O error
    
    从以下版本开始:
    
    Commons IO 2.1
  - openInputStream
```
public static FileInputStream openInputStream(File file)
                                       throws IOException
```
    Opens a FileInputStream for the specified file, providing better error messages than simply calling new FileInputStream(file).
    At the end of the method either the stream will be successfully opened, or an exception will have been thrown.
    An exception is thrown if the file does not exist. An exception is thrown if the file object exists but is a directory. An exception is thrown if the file exists but cannot be read.
    
    参数:
    
    file - the file to open for input, must not be null
    
    返回:
    
    a new FileInputStream for the specified file
    
    抛出:
    
    FileNotFoundException - if the file does not exist
    
    IOException - if the file object is a directory
    
    IOException - if the file cannot be read
    
    从以下版本开始:
    
    Commons IO 1.3
  - openOutputStream
```
public static FileOutputStream openOutputStream(File file)
                                         throws IOException
```
    Opens a FileOutputStream for the specified file, checking and creating the parent directory if it does not exist.
    At the end of the method either the stream will be successfully opened, or an exception will have been thrown.
    The parent directory will be created if it does not exist. The file will be created if it does not exist. An exception is thrown if the file object exists but is a directory. An exception is thrown if the file exists but cannot be written to. An exception is thrown if the parent directory cannot be created.
    
    参数:
    
    file - the file to open for output, must not be null
    
    返回:
    
    a new FileOutputStream for the specified file
    
    抛出:
    
    IOException - if the file object is a directory
    
    IOException - if the file cannot be written to
    
    IOException - if a parent directory needs creating but that fails
    
    从以下版本开始:
    
    Commons IO 1.3
  - openOutputStream
```
public static FileOutputStream openOutputStream(File file,
                                                boolean append)
                                         throws IOException
```
    Opens a FileOutputStream for the specified file, checking and creating the parent directory if it does not exist.
    At the end of the method either the stream will be successfully opened, or an exception will have been thrown.
    The parent directory will be created if it does not exist. The file will be created if it does not exist. An exception is thrown if the file object exists but is a directory. An exception is thrown if the file exists but cannot be written to. An exception is thrown if the parent directory cannot be created.
    
    参数:
    
    file - the file to open for output, must not be null
    
    append - if true, then bytes will be added to the end of the file rather than overwriting
    
    返回:
    
    a new FileOutputStream for the specified file
    
    抛出:
    
    IOException - if the file object is a directory
    
    IOException - if the file cannot be written to
    
    IOException - if a parent directory needs creating but that fails
    
    从以下版本开始:
    
    Commons IO 2.1
  - deleteDirectory
```
public static void deleteDirectory(File directory)
                            throws IOException
```
    Deletes a directory recursively.
    
    参数:
    
    directory - directory to delete
    
    抛出:
    
    IOException - in case deletion is unsuccessful
  - cleanDirectory
```
public static void cleanDirectory(File directory)
                           throws IOException
```
    Cleans a directory without deleting it.
    
    参数:
    
    directory - directory to clean
    
    抛出:
    
    IOException - in case cleaning is unsuccessful
  - deleteQuietly
```
public static boolean deleteQuietly(File file)
```
    Deletes a file, never throwing an exception. If file is a directory, delete it and all sub-directories.
    The difference between File.delete() and this method are:
    - A directory to be deleted does not have to be empty.
    - No exceptions are thrown when a file or directory cannot be deleted.
    参数:
    
    file - file or directory to delete, can be null
    
    返回:
    
    true if the file or directory was deleted, otherwise false
    
    从以下版本开始:
    
    1.4
  - isSymlink
```
public static boolean isSymlink(File file)
                         throws IOException
```
    Determines whether the specified file is a Symbolic Link rather than an actual file.
    Will not return true if there is a Symbolic Link anywhere in the path, only if the specific file is.
    Note: the current implementation always returns false if the system is detected as Windows using FilenameUtils.isSystemWindows()
    
    参数:
    
    file - the file to check
    
    返回:
    
    true if the file is a Symbolic Link
    
    抛出:
    
    IOException - if an IO error occurs while checking the file
    
    从以下版本开始:
    
    2.0
  - forceDelete
```
public static void forceDelete(File file)
                        throws IOException
```
    Deletes a file. If file is a directory, delete it and all sub-directories.
    The difference between File.delete() and this method are:
    - A directory to be deleted does not have to be empty.
    - You get exceptions when a file or directory cannot be deleted. (java.io.File methods returns a boolean)
    参数:
    
    file - file or directory to delete, must not be null
    
    抛出:
    
    NullPointerException - if the directory is null
    
    FileNotFoundException - if the file was not found
    
    IOException - in case deletion is unsuccessful
  - forceDeleteOnExit
```
public static void forceDeleteOnExit(File file)
                              throws IOException
```
    Schedules a file to be deleted when JVM exits. If file is directory delete it and all sub-directories.
    
    参数:
    
    file - file or directory to delete, must not be null
    
    抛出:
    
    NullPointerException - if the file is null
    
    IOException - in case deletion is unsuccessful

类 FileUtils

构造器概要

方法概要

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

构造器详细资料

FileUtils

方法详细资料

readFileToString

readFileToString

readFileToByteArray

readLines

readLines

lineIterator

lineIterator

writeStringToFile

writeStringToFile

writeStringToFile

writeStringToFile

write

write

write

write

writeByteArrayToFile

writeByteArrayToFile

writeLines

writeLines

writeLines

writeLines

writeLines

writeLines

writeLines

writeLines

openInputStream

openOutputStream

openOutputStream

deleteDirectory

cleanDirectory

deleteQuietly

isSymlink

forceDelete

forceDeleteOnExit