FileTools (intarsys runtime library)

java.lang.Object
- de.intarsys.tools.file.FileTools

```
public class FileTools
extends Object
```
Some utility methods to ease life with File instances.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileTools.Lock

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileTools.Lock`

Field Summary

Fields
Modifier and Type Field and Description

static String DIRECTORY_LOCK

Fields
Modifier and Type	Field and Description
`static String`	`DIRECTORY_LOCK`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`appendFile(File source, File destination)` Concatenate the two files given in `source` and `destination`.
`static File`	`checkDirectory(File dir, boolean create, boolean checkCanRead, boolean checkCanWrite)` Utility method for checking the availablity of a directory.
`static File`	`checkDirectory(String path, boolean create, boolean checkCanRead, boolean checkCanWrite)`
`static void`	`copyBinaryFile(File source, File destination)` Copy the byte content of `source` to `destination`.
`static void`	`copyFile(File source, File destination)`
`static void`	`copyFile(File source, String sourceEncoding, File destination, String destinationEncoding)` Copy the character content of `source` to `destination`.
`static void`	`copyRecursively(File source, File destination)`
`static File`	`copyRecursivelyInto(File source, File destinationParent, String newName)`
`static void`	`createEmptyFile(File file)` Create an empty file.
`static File`	`createTempFile(File file)` Create a file object representing a temporary file in the user's temp dir with the same name as the given file.
`static File`	`createTempFile(String filename)` Create a file object representing a temporary file in the user's temp dir with the given filename.
`static void`	`delete(File master)` The delete operation that Java should have provided....
`static void`	`deleteAfter(File directory, long millis, boolean recursiveScan)` Delete any file in `directory` that is older than `millis` milliseconds.
`static void`	`deleteEmptyDirectories(File root, File file)` Delete all empty directories in the parent hierarchy of file, up to and excluding root.
`static boolean`	`deleteRecursivly(File file)` Deletes a file or directory, if necessary recursivly.
`static boolean`	`deleteRecursivly(File file, boolean deleteRoot)` Deletes a file or directory, if necessary recursivly.
`static boolean`	`equalsOnSystem(File source, File destination)` `true` when the two files represent the same physical file in the file system.
`static String`	`getBaseName(File file)` Get the local name of the file in its directory without the extension.
`static String`	`getBaseName(String filename)` Get the local name of the file in its directory without the extension.
`static String`	`getBaseName(String filename, String extensionPrefix, String defaultName)` Get the local name of the file in its directory without the extension.
`static String`	`getEncoding()`
`static String`	`getExtension(File file)` Get the extension of the file name.
`static String`	`getExtension(String filename)` Get the extension of the file name.
`static String`	`getExtension(String filename, String extensionPrefix, String defaultName)` Get the extension of the file name.
`static String`	`getFileName(File file)`
`static String`	`getFileName(String filename)` Get the local name of the file in its directory (with extension).
`static String`	`getFileName(String filename, String defaultName)` Get the local name of the file in its directory (with extension).
`static File`	`getParentFile(File file)` Try to get a valid parent for file.
`static String`	`getPathName(File file)`
`static String`	`getPathName(String filename)` Get the path name of the file.
`static String`	`getPathName(String filename, String defaultName)` Get the path part of the file name.
`static String`	`getPathRelativeTo(File file, File base)` get relative path of "file" with respect to "base" directory example : `base = /a/b/c; file = /a/d/e/x.txt; getRelativePath(file, base) == ../..`
`static String`	`getPathRelativeTo(File file, File base, boolean ifAncestor)`
`static boolean`	`hasLeadingSeparator(String path)`
`static boolean`	`hasTrailingSeparator(String path)`
`static boolean`	`isAncestor(File parent, File descendant)`
`static boolean`	`isExtensionMatch(File file, String extensions)`
`static boolean`	`isLegalPath(String filename)`
`static boolean`	`isLocked(File file)` Answer true if a cooperative `FileTools.Lock` is held on file.
`static boolean`	`isReadOnly(File file)`
`static boolean`	`isWindows()`
`static String`	`joinPath(String... segment)` Join all segments to a valid file path.
`static FileTools.Lock`	`lock(File file)` Create a cooperative `FileTools.Lock` for file.
`static void`	`renameFile(File source, File destination)`
`static void`	`renameFile(File source, String sourceEncoding, File destination, String destinationEncoding)` "Rename" a file.
`static File`	`resolvePath(File parent, String path)` Return a new `File` instance for "path".
`static byte[]`	`toBytes(File file)` Create a byte array with the files content.
`static String`	`toString(File file)` Read a file's content at once and return as a string.
`static String`	`toString(File file, String encoding)` Read a file's content at once and return as a string in the correct encoding.
`static String`	`trimPath(String param)` Replaces all characters that are generally not allowed or considered useful in filenames with underscore.
`static void`	`wait(File file, long timeout, long delay)` Wait for a file to arrive.
`static String`	`withoutTrailingSeparator(String path)` Ensure path has no trailing file separator char.
`static String`	`withTrailingSeparator(String path)` Ensure path has a trailing file separator char.
`static void`	`write(File file, byte[] bytes)` Create a file from the byte content.
`static void`	`write(File file, String text)` Create a file from the string content.
`static void`	`write(File file, String text, boolean append)` Create a file from the string content.
`static void`	`write(File file, String text, String encoding)` Create a file from the string content.
`static void`	`write(File file, String text, String encoding, boolean append)` Create a file from the string content / append a string to a file

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

- Field Detail
  - DIRECTORY_LOCK
```
public static final String DIRECTORY_LOCK
```
    See Also:
    Constant Field Values
- Method Detail
  - appendFile
```
public static void appendFile(File source,
              File destination)
                       throws IOException
```
    Concatenate the two files given in source and destination.
    
    Parameters:
    source - The file to be appended.
    destination - The file to append to.
    
    Throws:
    
    IOException
  - checkDirectory
```
public static File checkDirectory(File dir,
                  boolean create,
                  boolean checkCanRead,
                  boolean checkCanWrite)
                           throws IOException
```
    Utility method for checking the availablity of a directory.
    
    Parameters:
    dir - The directory to check.
    create - Flag if we should create if dir not already exists.
    checkCanRead - Flag if we should check read permission.
    checkCanWrite - Flag if we should check write permission.
    
    Returns:
    The checked directory.
    
    Throws:
    
    IOException
  - checkDirectory
```
public static File checkDirectory(String path,
                  boolean create,
                  boolean checkCanRead,
                  boolean checkCanWrite)
                           throws IOException
```
    Throws:
    
    IOException
    See Also:
    checkDirectory(File, boolean, boolean, boolean)
  - copyBinaryFile
```
public static void copyBinaryFile(File source,
                  File destination)
                           throws IOException
```
    Copy the byte content of source to destination.
    
    Parameters:
    source - The file whose contents we should copy.
    destination - The file where the contents are copied to.
    
    Throws:
    
    IOException
  - copyFile
```
public static void copyFile(File source,
            File destination)
                     throws IOException
```
    Throws:
    
    IOException
    See Also:
    copyBinaryFile(File, File)
  - copyFile
```
public static void copyFile(File source,
            String sourceEncoding,
            File destination,
            String destinationEncoding)
                     throws IOException
```
    Copy the character content of source to destination.
    
    Parameters:
    source - The file whose contents we should copy.
    sourceEncoding - The encoding of the source byte stream.
    destination - The file where the contents are copied to.
    destinationEncoding - The encoding of the destination byte stream.
    
    Throws:
    
    IOException
  - copyRecursively
```
public static void copyRecursively(File source,
                   File destination)
                            throws IOException
```
    Throws:
    
    IOException
  - copyRecursivelyInto
```
public static File copyRecursivelyInto(File source,
                       File destinationParent,
                       String newName)
                                throws IOException
```
    Throws:
    
    IOException
  - createEmptyFile
```
public static void createEmptyFile(File file)
                            throws IOException
```
    Create an empty file.
    
    Parameters:
    file -
    
    Throws:
    
    IOException
  - createTempFile
```
public static File createTempFile(File file)
                           throws IOException
```
    Create a file object representing a temporary file in the user's temp dir with the same name as the given file.
    
    Parameters:
    file - file to use
    
    Returns:
    file object representing a temporary file
    
    Throws:
    
    IOException
  - createTempFile
```
public static File createTempFile(String filename)
                           throws IOException
```
    Create a file object representing a temporary file in the user's temp dir with the given filename.
    This does not actually create a file in the file system.
    
    Parameters:
    filename - filename to use
    
    Returns:
    file object representing a temporary file
    
    Throws:
    
    IOException
  - delete
```
public static void delete(File master)
                   throws IOException
```
    The delete operation that Java should have provided.... If deletion fails, an IOException is thrown.
    
    Parameters:
    master -
    
    Throws:
    
    IOException
  - deleteAfter
```
public static void deleteAfter(File directory,
               long millis,
               boolean recursiveScan)
                        throws IOException
```
    Delete any file in directory that is older than millis milliseconds. When recursiveScan is true the directory lookup is made recursive.
    
    Parameters:
    directory - The directory to scan.
    millis - The number of milliseconds a file is allowed to live.
    recursiveScan - Flag if we should handle directories recursive.
    
    Throws:
    
    IOException
  - deleteEmptyDirectories
```
public static void deleteEmptyDirectories(File root,
                          File file)
```
    Delete all empty directories in the parent hierarchy of file, up to and excluding root.
    
    Parameters:
    root -
    file -
  - deleteRecursivly
```
public static boolean deleteRecursivly(File file)
```
    Deletes a file or directory, if necessary recursivly.
    Returns true if file could be deleted inclusive its components, otherwise false.
    
    Parameters:
    file - The file or directory to delete.
    
    Returns:
    true if file could be deleted inclusive its components, otherwise false.
  - deleteRecursivly
```
public static boolean deleteRecursivly(File file,
                       boolean deleteRoot)
```
    Deletes a file or directory, if necessary recursivly.
    Returns true if file could be deleted inclusive its components, otherwise false.
    
    Parameters:
    file - The file or directory to delete.
    deleteRoot - Flag if the root directory should be deleted itself.
    
    Returns:
    true if file could be deleted inclusive its components, otherwise false.
  - equalsOnSystem
```
public static boolean equalsOnSystem(File source,
                     File destination)
```
    true when the two files represent the same physical file in the file system.
    
    Parameters:
    source - The first file to be checked.
    destination - The second file to be checked.
    
    Returns:
    true when the two files represent the same physical file in the file system.
  - getBaseName
```
public static String getBaseName(File file)
```
    Get the local name of the file in its directory without the extension.
    
    Parameters:
    file - The file whose base name is requested.
    
    Returns:
    The local name of the file in its directory without the extension.
  - getBaseName
```
public static String getBaseName(String filename)
```
    Get the local name of the file in its directory without the extension.
    
    Parameters:
    filename - The filename whose base name is requested.
    
    Returns:
    The local name of the file in its directory without the extension.
  - getBaseName
```
public static String getBaseName(String filename,
                 String extensionPrefix,
                 String defaultName)
```
    Get the local name of the file in its directory without the extension. The extensionPrefix may be used to designate a static prefix that should be considered part of the extension, not the base name. This is useful for handling "2nd order" extensions like "document.txt.p7s". The special case ".name" is not treated like an extension and returned as the basename.
    
    Parameters:
    filename - The filename whose base name is requested.
    extensionPrefix - An optional static prefix that should be considered part of the extension, not the basename.
    defaultName - returned if filename is null or a empty String
    
    Returns:
    The local name of the file in its directory without the extension.
  - getEncoding
```
public static String getEncoding()
```
  - getExtension
```
public static String getExtension(File file)
```
    Get the extension of the file name. If no extension is present, the empty string is returned.
    
    Parameters:
    file - The file whose extension is requested.
    
    Returns:
    The extension of the file name. If no extension is present, the empty string is returned.
  - getExtension
```
public static String getExtension(String filename)
```
    Get the extension of the file name. If no extension is present, the empty string is returned.
    
    Parameters:
    filename - The filename whose extension is requested.
    
    Returns:
    The extension of the file name. If no extension is present, the empty string is returned.
  - getExtension
```
public static String getExtension(String filename,
                  String extensionPrefix,
                  String defaultName)
```
    Get the extension of the file name. If no extension is present, the defaultName is returned.
    
    Parameters:
    filename - The filename whose extension is requested.
    extensionPrefix - An extension may use a prefix (by some unique timestamp e.g.) like .., where prefix is considered being part of the extension. If the filename is .. or ., the prefix is considered being the filename!
    defaultName - returned if the filename is empty or null or there is no extension
    
    Returns:
    The extension of the file name. If no extension is present, the empty string is returned.
  - getFileName
```
public static String getFileName(File file)
```
  - getFileName
```
public static String getFileName(String filename)
```
    Get the local name of the file in its directory (with extension).
    
    Parameters:
    filename - The filename whose name is requested.
    
    Returns:
    The local name of the file in its directory (with extension)
  - getFileName
```
public static String getFileName(String filename,
                 String defaultName)
```
    Get the local name of the file in its directory (with extension).
    
    Parameters:
    filename - The filename whose name is requested.
    defaultName - returned if filename is null or a empty String
    
    Returns:
    The local name of the file in its directory (with extension)
  - getParentFile
```
public static File getParentFile(File file)
```
    Try to get a valid parent for file.
    
    Parameters:
    file -
  - getPathName
```
public static String getPathName(File file)
```
    Parameters:
    filename - The filename whose path is requested.
    defaultName - returned if filename is null or a empty String
    
    Returns:
    The path name of the file
  - getPathName
```
public static String getPathName(String filename)
```
    Get the path name of the file.
    
    Parameters:
    filename - The filename whose path is requested.
    defaultName - returned if filename is null or a empty String
    
    Returns:
    The path name of the file
  - getPathName
```
public static String getPathName(String filename,
                 String defaultName)
```
    Get the path part of the file name. The path never ends with a File.separator, except when it designates the root. Example
```
 "gnu.txt" -> ""
 
```
```
 "/gnu.txt" -> "/"
 
```
```
 "a/gnu.txt" -> "a"
 
```
```
 "/a/gnu.txt" -> "/a"
 
```
    Parameters:
    filename - The filename whose path is requested.
    defaultName - returned if filename is null or a empty String
    
    Returns:
    The path name of the file
  - getPathRelativeTo
```
public static String getPathRelativeTo(File file,
                       File base)
                                throws IOException
```
    get relative path of "file" with respect to "base" directory example : base = /a/b/c; file = /a/d/e/x.txt; getRelativePath(file, base) == ../../d/e/x.txt;
    
    Parameters:
    base - base path, should be a directory, not a file, or it doesn't make sense
    file - file to generate path for
    
    Returns:
    path from home to f as a string
    
    Throws:
    
    IOException
  - getPathRelativeTo
```
public static String getPathRelativeTo(File file,
                       File base,
                       boolean ifAncestor)
```
  - hasLeadingSeparator
```
public static boolean hasLeadingSeparator(String path)
```
  - hasTrailingSeparator
```
public static boolean hasTrailingSeparator(String path)
```
  - isAncestor
```
public static boolean isAncestor(File parent,
                 File descendant)
```
  - isExtensionMatch
```
public static boolean isExtensionMatch(File file,
                       String extensions)
```
  - isLegalPath
```
public static boolean isLegalPath(String filename)
```
  - isLocked
```
public static boolean isLocked(File file)
```
    Answer true if a cooperative FileTools.Lock is held on file.
    
    Parameters:
    file -
    
    Returns:
  - isReadOnly
```
public static boolean isReadOnly(File file)
```
  - isWindows
```
public static boolean isWindows()
```
  - joinPath
```
public static String joinPath(String... segment)
```
    Join all segments to a valid file path.
    
    Parameters:
    segment - Array of path segments
    
    Returns:
  - lock
```
public static FileTools.Lock lock(File file)
```
    Create a cooperative FileTools.Lock for file. This is not appropriate for synchronization with partners that are not aware of this special protocol as no real synchronization is done on the target file. The cooperating system must agree on this special protocol implemented here. The lock is implemented using an explicit standin file. For a file this is ".lock", for a directory this is "/directory.lock".
    
    Parameters:
    file -
    
    Returns:
  - renameFile
```
public static void renameFile(File source,
              File destination)
                       throws IOException
```
    Throws:
    
    IOException
    See Also:
    renameFile(File, String, File, String)
  - renameFile
```
public static void renameFile(File source,
              String sourceEncoding,
              File destination,
              String destinationEncoding)
                       throws IOException
```
    "Rename" a file.
    The effect is that there is a new file destination, encoded in destinationEncoding, the old file source is deleted.
    
    Parameters:
    source - The source name of the file.
    sourceEncoding - The encoding of the source file.
    destination - The destination name of the file.
    destinationEncoding - The encoding of the destination file.
    
    Throws:
    
    IOException
  - resolvePath
```
public static File resolvePath(File parent,
               String path)
```
    Return a new File instance for "path". If path is relative, than it will be interpreted as a child of "parent", if it is absolute, it is returned as is.
    ATTENTION: On windows, if "path" is absolute but without drive or UNC prefix, this root information is NOT taken from "parent".
    
    Parameters:
    parent -
    path -
    
    Returns:
    Return a new File instance for "path".
  - toBytes
```
public static byte[] toBytes(File file)
                      throws IOException
```
    Create a byte array with the files content.
    
    Parameters:
    file - The file to read.
    
    Returns:
    Create a byte array with the files content.
    
    Throws:
    
    IOException
  - toString
```
public static String toString(File file)
                       throws IOException
```
    Read a file's content at once and return as a string.
    Use with care!
    
    Parameters:
    file - The file to read.
    
    Returns:
    The string content of the file.
    
    Throws:
    
    IOException
  - toString
```
public static String toString(File file,
              String encoding)
                       throws IOException
```
    Read a file's content at once and return as a string in the correct encoding.
    Use with care!
    
    Parameters:
    file - The file to read.
    encoding - The encoding to use.
    
    Returns:
    The string content of the file.
    
    Throws:
    
    IOException
  - trimPath
```
public static String trimPath(String param)
```
    Replaces all characters that are generally not allowed or considered useful in filenames with underscore.
    
    Parameters:
    param - java.lang.String
    
    Returns:
    java.lang.String
  - wait
```
public static void wait(File file,
        long timeout,
        long delay)
                 throws IOException
```
    Wait for a file to arrive.
    The method waits at most timeout milliseconds for a file to arrive. When delay is != 0 the method checks the file's size for changes until it reaches a stable size.
    
    Parameters:
    file - The file to wait for.
    timeout - The maximum time in milliseconds to wait for first occurence of file.
    delay - The number of milliseconds between two checks against the files size.
    
    Throws:
    
    IOException
  - withoutTrailingSeparator
```
public static String withoutTrailingSeparator(String path)
```
    Ensure path has no trailing file separator char.
    
    Parameters:
    path -
    
    Returns:
  - withTrailingSeparator
```
public static String withTrailingSeparator(String path)
```
    Ensure path has a trailing file separator char.
    
    Parameters:
    path -
    
    Returns:
  - write
```
public static void write(File file,
         byte[] bytes)
                  throws IOException
```
    Create a file from the byte content.
    
    Parameters:
    file - The file to write/create
    bytes - The data to be written into the file.
    
    Throws:
    
    IOException
  - write
```
public static void write(File file,
         String text)
                  throws IOException
```
    Create a file from the string content.
    
    Parameters:
    file - The file to write/create
    text - The text to be written into the file.
    
    Throws:
    
    IOException
  - write
```
public static void write(File file,
         String text,
         boolean append)
                  throws IOException
```
    Create a file from the string content.
    
    Parameters:
    file - The file to write/create
    text - The text to be written into the file.
    append - Flag to append to an existing file or create a new file.
    
    Throws:
    
    IOException
  - write
```
public static void write(File file,
         String text,
         String encoding)
                  throws IOException
```
    Create a file from the string content.
    
    Parameters:
    file - The file to write/create
    text - The text to be written into the file.
    
    Throws:
    
    IOException
  - write
```
public static void write(File file,
         String text,
         String encoding,
         boolean append)
                  throws IOException
```
    Create a file from the string content / append a string to a file
    
    Parameters:
    file - The file to write/create
    text - The text to be written into the file.
    append - Flag to append to an existing file or create a new file.
    
    Throws:
    
    IOException

Class FileTools

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIRECTORY_LOCK

Method Detail

appendFile

checkDirectory

checkDirectory

copyBinaryFile

copyFile

copyFile

copyRecursively

copyRecursivelyInto

createEmptyFile

createTempFile

createTempFile

delete

deleteAfter

deleteEmptyDirectories

deleteRecursivly

deleteRecursivly

equalsOnSystem

getBaseName

getBaseName

getBaseName

getEncoding

getExtension

getExtension

getExtension

getFileName

getFileName

getFileName

getParentFile

getPathName

getPathName

getPathName

getPathRelativeTo

getPathRelativeTo

hasLeadingSeparator

hasTrailingSeparator

isAncestor

isExtensionMatch

isLegalPath

isLocked

isReadOnly

isWindows

joinPath

lock

renameFile

renameFile

resolvePath

toBytes

toString

toString

trimPath

wait

withoutTrailingSeparator

withTrailingSeparator

write

write

write

write

write