FileUtils (guagua-core 0.7.8 API)

java.lang.Object
- ml.shifu.guagua.util.FileUtils

public final class FileUtils
extends Object

Copied from apache common-io source code.

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`SYSTEM_SEPARATOR` The system separator character.
`static char`	`UNIX_SEPARATOR` The Unix separator character.
`static char`	`WINDOWS_SEPARATOR` The Windows separator character.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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 File`	`getTempDirectory()` Returns a `File` representing the system temporary directory.
`static String`	`getTempDirectoryPath()` Returns the path to the system temporary directory.
`static File`	`getUserDirectory()` Returns a `File` representing the user's home directory.
`static String`	`getUserDirectoryPath()` Returns the path to the user's home directory.
`static boolean`	`isSymlink(File file)` Determines whether the specified file is a Symbolic Link rather than an actual file.
`static FileInputStream`	`openInputStream(File file)` Opens a `FileInputStream` for the specified file, providing better error messages than simply calling `new FileInputStream(file)`.
`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 List<String>`	`readLines(InputStream input)` Get the contents of an `InputStream` as a list of Strings, one entry per line, using the default character encoding of the platform.
`static List<String>`	`readLines(InputStream input, String encoding)` Get the contents of an `InputStream` as a list of Strings, one entry per line, using the specified character encoding.
`static List<String>`	`readLines(Reader input)` Get the contents of a `Reader` as a list of Strings, one entry per line.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNIX_SEPARATOR
```
public static final char UNIX_SEPARATOR
```
    The Unix separator character.
    
    See Also:
    
    Constant Field Values
  - WINDOWS_SEPARATOR
```
public static final char WINDOWS_SEPARATOR
```
    The Windows separator character.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_SEPARATOR
```
public static final char SYSTEM_SEPARATOR
```
    The system separator character.
- Method Detail
  - getTempDirectoryPath
```
public static String getTempDirectoryPath()
```
    Returns the path to the system temporary directory.
    
    Returns:
    
    the path to the system temporary directory.
    
    Since:
    
    Commons IO 2.0
  - getTempDirectory
```
public static File getTempDirectory()
```
    Returns a File representing the system temporary directory.
    
    Returns:
    
    the system temporary directory.
    
    Since:
    
    Commons IO 2.0
  - getUserDirectoryPath
```
public static String getUserDirectoryPath()
```
    Returns the path to the user's home directory.
    
    Returns:
    
    the path to the user's home directory.
    
    Since:
    
    Commons IO 2.0
  - getUserDirectory
```
public static File getUserDirectory()
```
    Returns a File representing the user's home directory.
    
    Returns:
    
    the user's home directory.
    
    Since:
    
    Commons IO 2.0
  - deleteDirectory
```
public static void deleteDirectory(File directory)
                            throws IOException
```
    Deletes a directory recursively.
    
    Parameters:
    
    directory - directory to delete
    
    Throws:
    
    IOException - in case deletion 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.
    Parameters:
    
    file - file or directory to delete, can be null
    
    Returns:
    
    true if the file or directory was deleted, otherwise false
    
    Since:
    
    Commons IO 1.4
  - cleanDirectory
```
public static void cleanDirectory(File directory)
                           throws IOException
```
    Cleans a directory without deleting it.
    
    Parameters:
    
    directory - directory to clean
    
    Throws:
    
    IOException - in case cleaning is unsuccessful
  - 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)
    Parameters:
    
    file - file or directory to delete, must not be null
    
    Throws:
    
    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.
    
    Parameters:
    
    file - file or directory to delete, must not be null
    
    Throws:
    
    NullPointerException - if the file is null
    
    IOException - in case deletion is unsuccessful
  - 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.
    
    Parameters:
    
    file - the file to check
    
    Returns:
    
    true if the file is a Symbolic Link
    
    Throws:
    
    IOException - if an IO error occurs while checking the file
    
    Since:
    
    Commons IO 2.0
  - 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.
    
    Parameters:
    
    file - the file to read, must not be null
    
    encoding - the encoding to use, null means platform default
    
    Returns:
    
    the list of Strings representing each line in the file, never null
    
    Throws:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
    
    Since:
    
    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.
    
    Parameters:
    
    file - the file to read, must not be null
    
    Returns:
    
    the list of Strings representing each line in the file, never null
    
    Throws:
    
    IOException - in case of an I/O error
    
    Since:
    
    Commons IO 1.3
  - readLines
```
public static List<String> readLines(InputStream input)
                              throws IOException
```
    Get the contents of an InputStream as a list of Strings, one entry per line, using the default character encoding of the platform.
    This method buffers the input internally, so there is no need to use a BufferedInputStream.
    
    Parameters:
    
    input - the InputStream to read from, not null
    
    Returns:
    
    the list of Strings, never null
    
    Throws:
    
    NullPointerException - if the input is null
    
    IOException - if an I/O error occurs
    
    Since:
    
    Commons IO 1.1
  - readLines
```
public static List<String> readLines(InputStream input,
                                     String encoding)
                              throws IOException
```
    Get the contents of an InputStream as a list of Strings, one entry per line, using the specified character encoding.
    Character encoding names can be found at IANA.
    This method buffers the input internally, so there is no need to use a BufferedInputStream.
    
    Parameters:
    
    input - the InputStream to read from, not null
    
    encoding - the encoding to use, null means platform default
    
    Returns:
    
    the list of Strings, never null
    
    Throws:
    
    NullPointerException - if the input is null
    
    IOException - if an I/O error occurs
    
    Since:
    
    Commons IO 1.1
  - readLines
```
public static List<String> readLines(Reader input)
                              throws IOException
```
    Get the contents of a Reader as a list of Strings, one entry per line.
    This method buffers the input internally, so there is no need to use a BufferedReader.
    
    Parameters:
    
    input - the Reader to read from, not null
    
    Returns:
    
    the list of Strings, never null
    
    Throws:
    
    NullPointerException - if the input is null
    
    IOException - if an I/O error occurs
    
    Since:
    
    Commons IO 1.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.
    
    Parameters:
    
    file - the file to open for input, must not be null
    
    Returns:
    
    a new FileInputStream for the specified file
    
    Throws:
    
    FileNotFoundException - if the file does not exist
    
    IOException - if the file object is a directory
    
    IOException - if the file cannot be read
    
    Since:
    
    Commons IO 1.3

Class FileUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNIX_SEPARATOR

WINDOWS_SEPARATOR

SYSTEM_SEPARATOR

Method Detail

getTempDirectoryPath

getTempDirectory

getUserDirectoryPath

getUserDirectory

deleteDirectory

deleteQuietly

cleanDirectory

forceDelete

forceDeleteOnExit

isSymlink

readLines

readLines

readLines

readLines

readLines

openInputStream