FileUtils (JBoss Application Server: Build 7.1.2.Final API)

java.lang.Object
- org.h2.store.fs.FileUtils

```
public class FileUtils
extends Object
```
This utility class contains utility functions that use the file system abstraction.

Constructor Summary

Constructors
Constructor and Description

FileUtils()

Constructors
Constructor and Description
`FileUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`canWrite(String fileName)` Check if the file is writable.
`static void`	`copy(String original, String copy)` Copy a file from one directory to another, or to another file.
`static void`	`createDirectories(String dir)` Create the directory and all required parent directories.
`static void`	`createDirectory(String directoryName)` Create a directory (all required parent directories must already exist).
`static boolean`	`createFile(String fileName)` Create a new file.
`static String`	`createTempFile(String prefix, String suffix, boolean deleteOnExit, boolean inTempDir)` Create a new temporary file.
`static void`	`delete(String path)` Delete a file or directory if it exists.
`static void`	`deleteRecursive(String path, boolean tryOnly)` Delete a directory or file and all subdirectories and files.
`static boolean`	`exists(String fileName)` Checks if a file exists.
`static String`	`getName(String path)` Get the file or directory name (the last element of the path).
`static String`	`getParent(String fileName)` Get the parent directory of a file or directory.
`static boolean`	`isAbsolute(String fileName)` Check if the file name includes a path.
`static boolean`	`isDirectory(String fileName)` Check if it is a file or a directory.
`static long`	`lastModified(String fileName)` Get the last modified date of a file.
`static void`	`moveTo(String oldName, String newName)` Rename a file if this is allowed.
`static List<String>`	`newDirectoryStream(String path)` List the files and directories in the given directory.
`static InputStream`	`newInputStream(String fileName)` Create an input stream to read from the file.
`static OutputStream`	`newOutputStream(String fileName, boolean append)` Create an output stream to write into the file.
`static FileChannel`	`open(String fileName, String mode)` Open a random access file object.
`static void`	`readFully(FileChannel channel, ByteBuffer dst)` Fully read from the file.
`static boolean`	`setReadOnly(String fileName)` Disable the ability to write.
`static long`	`size(String fileName)` Get the size of a file in bytes This method is similar to Java 7 `java.nio.file.attribute.Attributes.`
`static String`	`toRealPath(String fileName)` Get the canonical file or directory name.
`static boolean`	`tryDelete(String fileName)` Try to delete a file (ignore errors).
`static String`	`unwrap(String fileName)` Get the unwrapped file name (without wrapper prefixes if wrapping / delegating file systems are used).
`static void`	`writeFully(FileChannel channel, ByteBuffer src)` Fully write to the file.

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

- Constructor Detail
  - FileUtils
```
public FileUtils()
```
- Method Detail
  - exists
```
public static boolean exists(String fileName)
```
    Checks if a file exists. This method is similar to Java 7 java.nio.file.Path.exists.
    
    Parameters:
    fileName - the file name
    
    Returns:
    true if it exists
  - createDirectory
```
public static void createDirectory(String directoryName)
```
    Create a directory (all required parent directories must already exist). This method is similar to Java 7 java.nio.file.Path.createDirectory.
    
    Parameters:
    directoryName - the directory name
  - createFile
```
public static boolean createFile(String fileName)
```
    Create a new file. This method is similar to Java 7 java.nio.file.Path.createFile, but returns false instead of throwing a exception if the file already existed.
    
    Parameters:
    fileName - the file name
    
    Returns:
    true if creating was successful
  - delete
```
public static void delete(String path)
```
    Delete a file or directory if it exists. Directories may only be deleted if they are empty. This method is similar to Java 7 java.nio.file.Path.deleteIfExists.
    
    Parameters:
    path - the file or directory name
  - toRealPath
```
public static String toRealPath(String fileName)
```
    Get the canonical file or directory name. This method is similar to Java 7 java.nio.file.Path.toRealPath.
    
    Parameters:
    fileName - the file name
    
    Returns:
    the normalized file name
  - getParent
```
public static String getParent(String fileName)
```
    Get the parent directory of a file or directory. This method returns null if there is no parent. This method is similar to Java 7 java.nio.file.Path.getParent.
    
    Parameters:
    fileName - the file or directory name
    
    Returns:
    the parent directory name
  - isAbsolute
```
public static boolean isAbsolute(String fileName)
```
    Check if the file name includes a path. This method is similar to Java 7 java.nio.file.Path.isAbsolute.
    
    Parameters:
    fileName - the file name
    
    Returns:
    if the file name is absolute
  - moveTo
```
public static void moveTo(String oldName,
          String newName)
```
    Rename a file if this is allowed. This method is similar to Java 7 java.nio.file.Path.moveTo.
    
    Parameters:
    oldName - the old fully qualified file name
    newName - the new fully qualified file name
  - getName
```
public static String getName(String path)
```
    Get the file or directory name (the last element of the path). This method is similar to Java 7 java.nio.file.Path.getName.
    
    Parameters:
    path - the directory and file name
    
    Returns:
    just the file name
  - newDirectoryStream
```
public static List<String> newDirectoryStream(String path)
```
    List the files and directories in the given directory. This method is similar to Java 7 java.nio.file.Path.newDirectoryStream.
    
    Parameters:
    path - the directory
    
    Returns:
    the list of fully qualified file names
  - lastModified
```
public static long lastModified(String fileName)
```
    Get the last modified date of a file. This method is similar to Java 7 java.nio.file.attribute.Attributes. readBasicFileAttributes(file).lastModified().toMillis()
    
    Parameters:
    fileName - the file name
    
    Returns:
    the last modified date
  - size
```
public static long size(String fileName)
```
    Get the size of a file in bytes This method is similar to Java 7 java.nio.file.attribute.Attributes. readBasicFileAttributes(file).size()
    
    Parameters:
    fileName - the file name
    
    Returns:
    the size in bytes
  - isDirectory
```
public static boolean isDirectory(String fileName)
```
    Check if it is a file or a directory. java.nio.file.attribute.Attributes. readBasicFileAttributes(file).isDirectory()
    
    Parameters:
    fileName - the file or directory name
    
    Returns:
    true if it is a directory
  - open
```
public static FileChannel open(String fileName,
               String mode)
                        throws IOException
```
    Open a random access file object. This method is similar to Java 7 java.nio.channels.FileChannel.open.
    
    Parameters:
    fileName - the file name
    mode - the access mode. Supported are r, rw, rws, rwd
    
    Returns:
    the file object
    
    Throws:
    
    IOException
  - newInputStream
```
public static InputStream newInputStream(String fileName)
                                  throws IOException
```
    Create an input stream to read from the file. This method is similar to Java 7 java.nio.file.Path.newInputStream.
    
    Parameters:
    fileName - the file name
    
    Returns:
    the input stream
    
    Throws:
    
    IOException
  - newOutputStream
```
public static OutputStream newOutputStream(String fileName,
                           boolean append)
```
    Create an output stream to write into the file. This method is similar to Java 7 java.nio.file.Path.newOutputStream.
    
    Parameters:
    fileName - the file name
    append - if true, the file will grow, if false, the file will be truncated first
    
    Returns:
    the output stream
  - canWrite
```
public static boolean canWrite(String fileName)
```
    Check if the file is writable. This method is similar to Java 7 java.nio.file.Path.checkAccess(AccessMode.WRITE)
    
    Parameters:
    fileName - the file name
    
    Returns:
    if the file is writable
  - setReadOnly
```
public static boolean setReadOnly(String fileName)
```
    Disable the ability to write. The file can still be deleted afterwards.
    
    Parameters:
    fileName - the file name
    
    Returns:
    true if the call was successful
  - unwrap
```
public static String unwrap(String fileName)
```
    Get the unwrapped file name (without wrapper prefixes if wrapping / delegating file systems are used).
    
    Parameters:
    fileName - the file name
    
    Returns:
    the unwrapped
  - deleteRecursive
```
public static void deleteRecursive(String path,
                   boolean tryOnly)
```
    Delete a directory or file and all subdirectories and files.
    
    Parameters:
    path - the path
    tryOnly - whether errors should be ignored
  - createDirectories
```
public static void createDirectories(String dir)
```
    Create the directory and all required parent directories.
    
    Parameters:
    dir - the directory name
  - copy
```
public static void copy(String original,
        String copy)
                 throws IOException
```
    Copy a file from one directory to another, or to another file.
    
    Parameters:
    original - the original file name
    copy - the file name of the copy
    
    Throws:
    
    IOException
  - tryDelete
```
public static boolean tryDelete(String fileName)
```
    Try to delete a file (ignore errors).
    
    Parameters:
    fileName - the file name
    
    Returns:
    true if it worked
  - createTempFile
```
public static String createTempFile(String prefix,
                    String suffix,
                    boolean deleteOnExit,
                    boolean inTempDir)
                             throws IOException
```
    Create a new temporary file.
    
    Parameters:
    prefix - the prefix of the file name (including directory name if required)
    suffix - the suffix
    deleteOnExit - if the file should be deleted when the virtual machine exists
    inTempDir - if the file should be stored in the temporary directory
    
    Returns:
    the name of the created file
    
    Throws:
    
    IOException
  - readFully
```
public static void readFully(FileChannel channel,
             ByteBuffer dst)
                      throws IOException
```
    Fully read from the file. This will read all remaining bytes, or throw an EOFException if not successful.
    
    Parameters:
    channel - the file channel
    dst - the byte buffer
    
    Throws:
    
    IOException
  - writeFully
```
public static void writeFully(FileChannel channel,
              ByteBuffer src)
                       throws IOException
```
    Fully write to the file. This will write all remaining bytes.
    
    Parameters:
    channel - the file channel
    src - the byte buffer
    
    Throws:
    
    IOException

Class FileUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileUtils

Method Detail

exists

createDirectory

createFile

delete

toRealPath

getParent

isAbsolute

moveTo

getName

newDirectoryStream

lastModified

size

isDirectory

open

newInputStream

newOutputStream

canWrite

setReadOnly

unwrap

deleteRecursive

createDirectories

copy

tryDelete

createTempFile

readFully

writeFully