Files (j(s)-lib Commons 1.3.0 API)

java.lang.Object
- js.util.Files

```
public class Files
extends Object
```
Functions for files, byte and character streams copy and file path manipulation. This class supplies methods for byte and character streams transfer and files copy. If not otherwise specified, in order to simplify caller logic, streams methods close streams before returning, including on error. Also for files copy, target file is created if does not exist; if target file creation fails, perhaps because of missing rights or target exists and is a directory, file methods throw FileNotFoundException. Please note that in all cases target content is overwritten.
Finally, there are method working with temporary files as target. These methods return newly created temporary file and is caller responsibility to remove it when is not longer necessary. This library does not keep record of created temporary file and there is no attempt to remove then, not even at virtual machine exit.
This utility class allows for sub-classing. See js.util for utility sub-classing description.

Version:

final

Author:

Iulian Rotaru

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Files.FileNotify
File notification types used by inotify(java.io.File, FileNotify, int) utility method.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Files.FileNotify` File notification types used by `inotify(java.io.File, FileNotify, int)` utility method.

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`BUFFER_SIZE` The size of buffer used by copy operations.
`static String`	`CURRENT_DIR` Current directory file name.
`private static Pattern`	`DOT_PATTERN` Regular expression pattern for dot (.) character.
`static char`	`EXTENSION_SEPARATOR` The extension separator character.
`private static List<String>`	`IMAGE_FILE_EXTENSIONS` Standard extensions for image files.
`private static Map<Files.FileNotify,Predicate>`	`INOTIFY_PREDICATES` Predefined predicates used by `inotify(File, FileNotify, int)`.
`static String`	`LINE_SEPARATOR` System dependent line separator used to separate text lines into character streams.
`private static Log`	`log` Class logger.
`private static String`	`PARTIAL_FILE_SUFFIX` Partially transfered file name for `download(URL, File)`.
`private static String`	`SEPARATOR_CHAR_REX` Regular expression for path separator.
`private static String`	`TMP_FILE_EXTENSION` Extension for temporary files.
`private static String`	`TMP_FILE_PREFIX` Prefix for temporary files.
`private static char`	`UNIX_SEPARATOR` The Unix separator character.
`private static String`	`URL_PATH_SEPARATOR` URL path separator.
`private static char`	`WINDOWS_SEPARATOR` The Windows separator character.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Files()
Prevent default constructor synthesis but allow sub-classing.

Constructors
Modifier	Constructor and Description
`protected`	`Files()` Prevent default constructor synthesis but allow sub-classing.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`basename(File file)` Return file name without extension.
`static String`	`basename(String path)` Return base name for given file path.
`static void`	`close(Closeable closeable)` Close given `closeable` if not null but ignoring IO exception generated by failing close operation.
`static long`	`copy(File source, File target)` Copy source file to target.
`static long`	`copy(File file, OutputStream outputStream)` Copy source file bytes to requested output stream.
`static File`	`copy(InputStream stream)` Binary copy to temporary file.
`static long`	`copy(InputStream inputStream, File file)` Copy bytes from requested input stream to given target file.
`static long`	`copy(InputStream inputStream, File baseDir, String fileName)` Copy bytes from given input stream to file denoted by requested base directory and file name.
`static long`	`copy(InputStream inputStream, OutputStream outputStream)` Copy bytes from input to given output stream then close both byte streams.
`static File`	`copy(InputStream stream, String encoding)` Copy text from byte stream using specified encoding to temporary file then close both input stream and temporary file.
`static File`	`copy(Reader reader)` Copy text from character stream to temporary file then close both the source reader and temporary file.
`static int`	`copy(Reader reader, Writer writer)` Copy characters from a reader to a given writer then close both character streams.
`static File`	`copy(URL url)` Binary copy from URL to local temporary file.
`static long`	`copy(URL url, File file)` Copy bytes from remote file denoted by given URL to specified local file.
`static long`	`copy(URL url, File baseDir, String fileName)` Copy remote binary file denoted by requested URL to local file identified by given base directory and file name.
`static long`	`copy(URL url, OutputStream outputStream)` Copy bytes from remote file denoted by given URL to requested output stream.
`static File`	`copy(URL url, String encoding)` Copy text from URL using specified encoding to local temporary file then close both URL input stream and temporary file.
`static BufferedReader`	`createBufferedReader(InputStream stream)` Create buffered reader from bytes stream using UTF-8 charset.
`static BufferedWriter`	`createBufferedWriter(OutputStream stream)` Create buffered writer from bytes stream using UTF-8 charset.
`private static File`	`createTempFile()` Create temporary file using library specific prefix and extension.
`static void`	`delete(File file)` Delete file if exists throwing exception if delete fails.
`static String`	`dot2path(String qualifiedName)` Replace all dots from given qualified name with platform specific path separator.
`static String`	`dot2path(String qualifiedName, String fileExtension)` Convert qualified name to platform specific path and add given extension.
`static String`	`dot2urlpath(String qualifiedName)` Same as `dot2path(String)` but always uses forward slash as path separator, as used by URLs.
`static void`	`download(URL url, File file)` Atomic download file from specified URL to local target file.
`static void`	`dump(InputStream inputStream)` Dump byte input stream content to standard output till end of input stream.
`static void`	`dump(Reader reader)` Dump UTF-8 character stream content to standard out.
`static String`	`getExtension(File file)` Get file extension as lower case or empty string.
`static String`	`getExtension(String path)` Get the lower case extension of the file denoted by given path or empty string if not extension.
`static String`	`getExtension(URL url)` Get extension of the file denoted by given URL or empty string if not extension.
`static byte[]`	`getFileDigest(File file)` Create MD5 message digest for requested file content.
`static byte[]`	`getFileDigest(InputStream inputStream)` Create MD5 message digest for bytes produced by given input stream till its end.
`static List<String>`	`getPathComponents(File file)` Get file path components.
`static String`	`getRelativePath(File baseDir, File file, boolean... forceURLPath)` Get file access path relative to a base directory.
`static boolean`	`inotify(File file, Files.FileNotify notify, int timeout)` Wait for requested action to happen on given file.
`static boolean`	`isImage(File file)` Guess if file is an image file based on file extension.
`static boolean`	`isImage(String extension)` Convenient alternative for `isImage(File)` method.
`static File`	`mkdirs(File file)` Create all ancestor directories for a requested file path.
`static boolean`	`move(String sourcePath, String targetPath)` Move source file to requested destination but do not overwrite.
`static String`	`normalizePath(String path)` Ensure that path separators are compatible with current operating system.
`static String`	`path2dot(String path)` Convert a file path to a dot separated list of words.
`static String`	`path2unix(File file)` Convert a file to an Unix like path string.
`static String`	`path2unix(String path)` Convert file path to an Unix like path string.
`private static void`	`removeDirectory(File directory)` Utility method invoked recursively to remove directory files.
`static File`	`removeExtension(File file)` Remove extension from given file and create a new one with resulting path.
`static String`	`removeExtension(String path)` Remove extension from given file path and return resulting path.
`static File`	`removeFilesHierarchy(File baseDir)` Remove ALL files and directories from a given base directory.
`static void`	`renameTo(File source, File destination)` Thin wrapper for `File.renameTo(File)` throwing exception on fail.
`static File`	`replaceExtension(File file, String newExtension)` Replace extension on given file and return resulting file.
`static String`	`replaceExtension(String path, String newExtension)` Replace extension on given file path and return resulting path.

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

- Field Detail
  - log
```
private static Log log
```
    Class logger.
  - CURRENT_DIR
```
public static final String CURRENT_DIR
```
    Current directory file name.
    
    See Also:
    
    Constant Field Values
  - LINE_SEPARATOR
```
public static final String LINE_SEPARATOR
```
    System dependent line separator used to separate text lines into character streams.
  - BUFFER_SIZE
```
private static final int BUFFER_SIZE
```
    The size of buffer used by copy operations.
    
    See Also:
    
    Constant Field Values
  - PARTIAL_FILE_SUFFIX
```
private static final String PARTIAL_FILE_SUFFIX
```
    Partially transfered file name for download(URL, File).
    
    See Also:
    
    Constant Field Values
  - SEPARATOR_CHAR_REX
```
private static final String SEPARATOR_CHAR_REX
```
    Regular expression for path separator.
  - DOT_PATTERN
```
private static final Pattern DOT_PATTERN
```
    Regular expression pattern for dot (.) character.
  - URL_PATH_SEPARATOR
```
private static final String URL_PATH_SEPARATOR
```
    URL path separator.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_SEPARATOR
```
public static final char EXTENSION_SEPARATOR
```
    The extension separator character.
    
    See Also:
    
    Constant Field Values
  - UNIX_SEPARATOR
```
private static final char UNIX_SEPARATOR
```
    The Unix separator character.
    
    See Also:
    
    Constant Field Values
  - WINDOWS_SEPARATOR
```
private static final char WINDOWS_SEPARATOR
```
    The Windows separator character.
    
    See Also:
    
    Constant Field Values
  - TMP_FILE_PREFIX
```
private static final String TMP_FILE_PREFIX
```
    Prefix for temporary files.
    
    See Also:
    
    Constant Field Values
  - TMP_FILE_EXTENSION
```
private static final String TMP_FILE_EXTENSION
```
    Extension for temporary files.
    
    See Also:
    
    Constant Field Values
  - IMAGE_FILE_EXTENSIONS
```
private static final List<String> IMAGE_FILE_EXTENSIONS
```
    Standard extensions for image files. Used by isImage(File).
  - INOTIFY_PREDICATES
```
private static final Map<Files.FileNotify,Predicate> INOTIFY_PREDICATES
```
    Predefined predicates used by inotify(File, FileNotify, int).
- Constructor Detail
  - Files
```
protected Files()
```
    Prevent default constructor synthesis but allow sub-classing.
- Method Detail
  - createBufferedReader
```
public static BufferedReader createBufferedReader(InputStream stream)
```
    Create buffered reader from bytes stream using UTF-8 charset. This library always uses UTF-8 encoding and this method does not rely on JVM default since there is no standard way to enforce it. JRE specification states that file.encoding is not the standard way to set default charset and to use host settings.
    
    Parameters:
    
    stream - input stream.
    
    Returns:
    
    newly created buffered reader.
  - createBufferedWriter
```
public static BufferedWriter createBufferedWriter(OutputStream stream)
```
    Create buffered writer from bytes stream using UTF-8 charset. This library always uses UTF-8 encoding and this method does not rely on JVM default since there is no standard way to enforce it. JRE specification states that file.encoding is not the standard way to set default charset and to use host settings.
    
    Parameters:
    
    stream - input stream.
    
    Returns:
    
    newly created buffered reader.
  - copy
```
public static File copy(URL url)
                 throws IOException,
                        IllegalArgumentException
```
    Binary copy from URL to local temporary file.
    
    Parameters:
    
    url - source file URL.
    
    Returns:
    
    temporarily created file.
    
    Throws:
    
    IOException - if copy operation fails.
    
    IllegalArgumentException - if url parameter is null.
  - copy
```
public static File copy(InputStream stream)
                 throws IOException
```
    Binary copy to temporary file. Be aware that temporary file is removed at JVM exit.
    
    Parameters:
    
    stream - source stream.
    
    Returns:
    
    temporarily created file.
    
    Throws:
    
    IOException - if copy operation fails.
  - copy
```
public static File copy(URL url,
                        String encoding)
                 throws IOException,
                        IllegalArgumentException
```
    Copy text from URL using specified encoding to local temporary file then close both URL input stream and temporary file.
    
    Parameters:
    
    url - source file URL,
    
    encoding - character encoding to use.
    
    Returns:
    
    temporarily created file.
    
    Throws:
    
    IOException - if copy operation fails.
    
    IllegalArgumentException - if url parameter is null.
  - copy
```
public static File copy(InputStream stream,
                        String encoding)
                 throws IOException
```
    Copy text from byte stream using specified encoding to temporary file then close both input stream and temporary file. Be aware that temporary file is removed at JVM exit.
    
    Parameters:
    
    stream - input stream to read from,
    
    encoding - used character encoding.
    
    Returns:
    
    temporarily created file.
    
    Throws:
    
    IOException - if copy operation fails.
  - copy
```
public static File copy(Reader reader)
                 throws IOException
```
    Copy text from character stream to temporary file then close both the source reader and temporary file. Be aware that temporary file is removed at JVM exit.
    
    Parameters:
    
    reader - source character reader.
    
    Returns:
    
    the newly created temporarily file.
    
    Throws:
    
    IOException - if copy operation fails.
  - copy
```
public static long copy(File source,
                        File target)
                 throws FileNotFoundException,
                        IOException
```
    Copy source file to target. Copy destination should be a file and this method throws access denied if attempt to write to a directory. Source file should exist but target is created by this method, but if not already exist.
    
    Parameters:
    
    source - file to read from, should exist,
    
    target - file to write to.
    
    Returns:
    
    the number of bytes transfered.
    
    Throws:
    
    FileNotFoundException - if source file does not exist or target file does not exist and cannot be created.
    
    IOException - if copy operation fails, including if target is a directory.
  - copy
```
public static int copy(Reader reader,
                       Writer writer)
                throws IOException
```
    Copy characters from a reader to a given writer then close both character streams.
    
    Parameters:
    
    reader - character stream to read from,
    
    writer - character stream to write to.
    
    Returns:
    
    the number of characters processed.
    
    Throws:
    
    IOException - if read or write operation fails.
    
    IllegalArgumentException - if reader or writer is null.
  - copy
```
public static long copy(URL url,
                        File baseDir,
                        String fileName)
                 throws FileNotFoundException,
                        IOException,
                        IllegalArgumentException
```
    Copy remote binary file denoted by requested URL to local file identified by given base directory and file name. Local file is created by File.File(File, String). This method creates local file if it does already exist.
    
    Parameters:
    
    url - remote file URL,
    
    baseDir - local file base directory,
    
    fileName - local file name.
    
    Returns:
    
    the number of bytes transfered.
    
    Throws:
    
    FileNotFoundException - if given local file does not exist and cannot be created.
    
    IOException - if transfer fails.
    
    IllegalArgumentException - if url is null.
  - copy
```
public static long copy(InputStream inputStream,
                        File baseDir,
                        String fileName)
                 throws FileNotFoundException,
                        IOException
```
    Copy bytes from given input stream to file denoted by requested base directory and file name. Destination file is create by File.File(File, String). This method tries to create destination file and throws exception if fails.
    
    Parameters:
    
    inputStream - source bytes stream,
    
    baseDir - destination base directory,
    
    fileName - destination file name.
    
    Returns:
    
    the number of bytes processed.
    
    Throws:
    
    FileNotFoundException - if given baseDir and fileName does not denote and existing file and cannot be created.
    
    IOException - if bytes transfer fails.
  - copy
```
public static long copy(InputStream inputStream,
                        File file)
                 throws FileNotFoundException,
                        IOException
```
    Copy bytes from requested input stream to given target file. This method creates the target file if does not already exist.
    
    Parameters:
    
    inputStream - source input stream,
    
    file - target file.
    
    Returns:
    
    the number of bytes processed.
    
    Throws:
    
    FileNotFoundException - if given file does not exist and cannot be created.
    
    IOException - if bytes transfer fails.
  - copy
```
public static long copy(URL url,
                        File file)
                 throws FileNotFoundException,
                        IOException
```
    Copy bytes from remote file denoted by given URL to specified local file. This method creates local file if not already exists.
    
    Parameters:
    
    url - source remote file URL,
    
    file - target local file.
    
    Returns:
    
    the number of bytes transfered.
    
    Throws:
    
    FileNotFoundException - if given file does not exist and cannot be created.
    
    IOException - if bytes transfer fails.
  - copy
```
public static long copy(URL url,
                        OutputStream outputStream)
                 throws IOException,
                        IllegalArgumentException
```
    Copy bytes from remote file denoted by given URL to requested output stream. Destination stream is closed before this method returning.
    
    Parameters:
    
    url - URL of the source remote file,
    
    outputStream - destination output stream.
    
    Returns:
    
    the number of bytes transfered.
    
    Throws:
    
    IOException - the number of bytes transfered.
    
    IllegalArgumentException - if url is null.
  - copy
```
public static long copy(File file,
                        OutputStream outputStream)
                 throws IOException
```
    Copy source file bytes to requested output stream. Note that output stream is closed after transfer completes, including on error.
    
    Parameters:
    
    file - source file,
    
    outputStream - destination output stream.
    
    Returns:
    
    the number of bytes processed.
    
    Throws:
    
    FileNotFoundException - if file does not exist.
    
    IOException - bytes processing fails.
    
    IllegalArgumentException - if input file or output stream is null.
  - copy
```
public static long copy(InputStream inputStream,
                        OutputStream outputStream)
                 throws IOException,
                        IllegalArgumentException
```
    Copy bytes from input to given output stream then close both byte streams. Please be aware this method closes both input and output streams. This is especially important if work with ZIP streams; trying to get/put next ZIP entry after this method completes will fail with stream closed exception.
    
    Parameters:
    
    inputStream - bytes input stream,
    
    outputStream - bytes output stream.
    
    Returns:
    
    the number of bytes processed.
    
    Throws:
    
    IOException - if reading or writing fails.
    
    IllegalArgumentException - if input or output stream is null or ZIP stream.
  - download
```
public static void download(URL url,
                            File file)
                     throws IOException
```
    Atomic download file from specified URL to local target file. This method guarantee atomic operation: file is actually created only if transfer completes with success. For this purpose download is performed to a temporary file that is renamed after transfer complete. Of course, if transfer fails rename does not occur.
    
    Parameters:
    
    url - source file URL,
    
    file - local target file.
    
    Throws:
    
    IOException - if transfer or local write fails.
  - dump
```
public static void dump(InputStream inputStream)
                 throws IOException
```
    Dump byte input stream content to standard output till end of input stream. Input stream is closed.
    
    Parameters:
    
    inputStream - source byte input stream.
    
    Throws:
    
    IOException - if reading from input stream fails.
  - dump
```
public static void dump(Reader reader)
                 throws IOException
```
    Dump UTF-8 character stream content to standard out.
    
    Parameters:
    
    reader - source UTF-8 character stream.
    
    Throws:
    
    IOException - if reading from character stream fails.
  - close
```
public static void close(Closeable closeable)
```
    Close given closeable if not null but ignoring IO exception generated by failing close operation. Please note that this helper method does not throw IOException if close operation fails but still record the event to error logger.
    
    Parameters:
    
    closeable - closeable to close.
  - renameTo
```
public static void renameTo(File source,
                            File destination)
                     throws IOException
```
    Thin wrapper for File.renameTo(File) throwing exception on fail. This method ensures destination file parent directories exist. If destination file already exist its content is silently overwritten.
    Warning: if destination file exists, it is overwritten and its old content lost.
    
    Parameters:
    
    source - source file,
    
    destination - destination file.
    
    Throws:
    
    IOException - if rename operation fails.
  - move
```
public static boolean move(String sourcePath,
                           String targetPath)
                    throws IllegalArgumentException
```
    Move source file to requested destination but do not overwrite. This method takes care to not overwrite destination file and returns false if it already exists. Note that this method does not throw exceptions if move fails and caller should always test returned boolean to determine if operation completes.
    
    Parameters:
    
    sourcePath - source file path,
    
    targetPath - target file path.
    
    Returns:
    
    true if move completes, false if source does not exist, destination already exists or move fails.
    
    Throws:
    
    IllegalArgumentException - if source or target path parameter is null.
  - getRelativePath
```
public static String getRelativePath(File baseDir,
                                     File file,
                                     boolean... forceURLPath)
```
    Get file access path relative to a base directory. This is the relative path that allows to access given file starting from the base directory. But be warned: both base directory and file should reside on the same root. Also, file argument can be a directory too but base directory must be a directory indeed.
    Resulting relative path uses system separator unless optional forceURLPath is supplied and is false; in this case always use /, no matter platform running JVM.
    Known limitations: this method always assume that both base directory and file are on the same root; failing to satisfy this condition render not predictable results.
    
    Parameters:
    
    baseDir - base directory,
    
    file - file or directory to compute relative path,
    
    forceURLPath - flag to force resulting path as URL path, i.e. always uses '/' for path components separator.
    
    Returns:
    
    file access path regarding base directory.
    
    Throws:
    
    IllegalArgumentException - if any argument is null or empty.
  - getPathComponents
```
public static List<String> getPathComponents(File file)
```
    Get file path components. Return a list of path components in their natural order. List first item is path root stored as an empty string; if file argument is empty returned list contains only root. If file argument is null returns empty list.
    
    Parameters:
    
    file - file to retrieve path components.
    
    Returns:
    
    file path components.
  - removeExtension
```
public static String removeExtension(String path)
                              throws IllegalArgumentException
```
    Remove extension from given file path and return resulting path.
    
    Parameters:
    
    path - file path to remove extension from.
    
    Returns:
    
    newly created path without extension.
    
    Throws:
    
    IllegalArgumentException - if path parameter is null.
  - removeExtension
```
public static File removeExtension(File file)
                            throws IllegalArgumentException
```
    Remove extension from given file and create a new one with resulting path.
    
    Parameters:
    
    file - file to remove extension from.
    
    Returns:
    
    newly created file without extension.
    
    Throws:
    
    IllegalArgumentException - if file parameter is null.
  - replaceExtension
```
public static String replaceExtension(String path,
                                      String newExtension)
                               throws IllegalArgumentException
```
    Replace extension on given file path and return resulting path. Is legal for new extension parameter to start with dot extension separator, but is not mandatory.
    
    Parameters:
    
    path - file path to replace extension,
    
    newExtension - newly extension, with optional dot separator prefix.
    
    Returns:
    
    newly created file path.
    
    Throws:
    
    IllegalArgumentException - if path or new extension parameter is null.
  - replaceExtension
```
public static File replaceExtension(File file,
                                    String newExtension)
                             throws IllegalArgumentException
```
    Replace extension on given file and return resulting file.
    
    Parameters:
    
    file - file to replace extension,
    
    newExtension - newly extension.
    
    Returns:
    
    newly created file.
    
    Throws:
    
    IllegalArgumentException - if file parameter is null.
  - path2dot
```
public static String path2dot(String path)
```
    Convert a file path to a dot separated list of words. This utility is handy, for example, on converting file paths to Java packages, provided file path contains Java valid characters. Returns null if path parameter is null.
    
    Parameters:
    
    path - file path to convert.
    
    Returns:
    
    dot separated list of words or null.
  - path2unix
```
public static String path2unix(File file)
```
    Convert a file to an Unix like path string. This method just delegates path2unix(String). Returns null if file parameter is null.
    
    Parameters:
    
    file - file to convert.
    
    Returns:
    
    Unix like path string.
  - path2unix
```
public static String path2unix(String path)
```
    Convert file path to an Unix like path string. If given path is Windows like replaces drive letter with Unix path root and all Windows path separators to Unix counterpart.
```
    D:\\temp\file.txt -> /temp/file.txt
 
```
    If path is already Unix like this method leave it as it is but remove trailing path separator, if any. Returns null if path parameter is null.
    Parameters:
    
    path - path to convert, trailing path separator ignored.
    
    Returns:
    
    Unix like path string or null.
  - dot2path
```
public static String dot2path(String qualifiedName)
```
    Replace all dots from given qualified name with platform specific path separator.
```
    js.net.Transaction -> js/net/Transaction or js\net\Transaction
 
```
    Returns null if qualifiedName parameter is null.
    Parameters:
    
    qualifiedName - qualified name.
    
    Returns:
    
    resulting path or null.
  - dot2urlpath
```
public static String dot2urlpath(String qualifiedName)
```
    Same as dot2path(String) but always uses forward slash as path separator, as used by URLs. Returns null if qualifiedName parameter is null.
    
    Parameters:
    
    qualifiedName - qualified name.
    
    Returns:
    
    resulting URL path or null.
  - dot2path
```
public static String dot2path(String qualifiedName,
                              String fileExtension)
```
    Convert qualified name to platform specific path and add given extension. Uses dot2path(String) to convert qualifiedName to file path then add give fileExtension. Is legal for fileExtension to start with dot.
```
    js.net.Transaction java -> js/net/Transaction.java or js\net\Transaction.java
    js.net.Transaction .java -> js/net/Transaction.java or js\net\Transaction.java
 
```
    Returns null if qualifiedName parameter is null. If fileExtension parameter is null resulting path has no extension.
    Parameters:
    
    qualifiedName - qualified name,
    
    fileExtension - requested file extension, leading dot accepted.
    
    Returns:
    
    resulting file path or null.
  - getExtension
```
public static String getExtension(URL url)
```
    Get extension of the file denoted by given URL or empty string if not extension. Returned extension does not contain dot separator, that is, htm not .htm. Returns null if url parameter is null.
    
    Parameters:
    
    url - the URL of file to return extension.
    
    Returns:
    
    file extension or empty string or null if url parameter is null.
  - getExtension
```
public static String getExtension(File file)
```
    Get file extension as lower case or empty string. Returned extension does not contain dot separator, that is, htm not .htm. Returns null if file parameter is null.
    
    Parameters:
    
    file - file to return extension of.
    
    Returns:
    
    file extension or empty string or null if file parameter is null.
  - getExtension
```
public static String getExtension(String path)
```
    Get the lower case extension of the file denoted by given path or empty string if not extension. Returned extension does not contain dot separator, that is, htm not .htm. Returns null if given path parameter is null.
    
    Parameters:
    
    path - the path of the file to return extension of.
    
    Returns:
    
    file extension, as lower case, or empty string if no extension.
  - basename
```
public static String basename(File file)
```
    Return file name without extension. Returns null if given file parameter is null.
    
    Parameters:
    
    file - file to return base name for.
    
    Returns:
    
    file name, without extension, or null.
  - basename
```
public static String basename(String path)
```
    Return base name for given file path. Returns null if given path parameter is null.
    
    Parameters:
    
    path - file path string.
    
    Returns:
    
    file name without extension or null.
  - createTempFile
```
private static File createTempFile()
                            throws IOException
```
    Create temporary file using library specific prefix and extension. Created file is removed at JVM exit.
    
    Returns:
    
    newly create temporary file.
    
    Throws:
    
    IOException - if file creation fails.
  - isImage
```
public static boolean isImage(File file)
```
    Guess if file is an image file based on file extension. This is a very trivial test relying on file extension and obviously cannot guarantee correct results.
    
    Parameters:
    
    file - file to test.
    
    Returns:
    
    true if given file is an image file.
  - isImage
```
public static boolean isImage(String extension)
```
    Convenient alternative for isImage(File) method.
    
    Parameters:
    
    extension - file extension to test.
    
    Returns:
    
    true if given file extension denotes an image file.
  - getFileDigest
```
public static byte[] getFileDigest(File file)
                            throws FileNotFoundException,
                                   IOException
```
    Create MD5 message digest for requested file content. This method returns a 16-bytes array with computed MD5 message digest value.
    
    Parameters:
    
    file - file to create message digest for.
    
    Returns:
    
    16-bytes array of message digest.
    
    Throws:
    
    FileNotFoundException - if file does not exist.
    
    IOException - if file read operation fails.
  - getFileDigest
```
public static byte[] getFileDigest(InputStream inputStream)
                            throws IOException
```
    Create MD5 message digest for bytes produced by given input stream till its end. This method returns a 16-bytes array with computed MD5 message digest value. Note that input stream is read till its end and is closed before this method returning, including on stream read error.
    
    Parameters:
    
    inputStream - input stream for source bytes.
    
    Returns:
    
    16-bytes array of message digest.
    
    Throws:
    
    IOException - if file read operation fails.
  - mkdirs
```
public static File mkdirs(File file)
                   throws IOException,
                          IllegalArgumentException
```
    Create all ancestor directories for a requested file path. Given file is assumed to be a file path, not a directory; this method retrieve file parent and enact File.mkdirs(). If given file reside into file system root this method does nothing.
    For caller convenience this method returns file argument, see sample usage.
```
 save(text, new FileWriter(Files.mkdirs(file)));
 
```
    Parameters:
    
    file - file path.
    
    Returns:
    
    given file argument with guaranteed parent directories.
    
    Throws:
    
    IOException - if directories creation fails.
    
    IllegalArgumentException - if file parameter is null.
  - delete
```
public static void delete(File file)
                   throws IOException
```
    Delete file if exists throwing exception if delete fails. Note that this method does nothing if file does not exist; anyway, null parameter sanity check is still performed.
    
    Parameters:
    
    file - file path.
    
    Throws:
    
    IOException - if delete operation fails.
    
    IllegalArgumentException - if file parameter is null.
  - removeFilesHierarchy
```
public static File removeFilesHierarchy(File baseDir)
                                 throws IllegalArgumentException,
                                        IOException
```
    Remove ALL files and directories from a given base directory. This method remove ALL files and directory tree, child of given baseDir but directory itself is not removed. As a result baseDir becomes empty, that is, no children. If exception occur base directory state is not defined, that is, some files may be removed and other may still be there.
    For caller convenience this method returns given base directory. This allows to chain this method with File.delete() method, like Files.removeFilesHierarchy(dir).delete();.
    
    Parameters:
    
    baseDir - existing, not null, base directory to clean-up.
    
    Returns:
    
    base directory argument for method chaining, mainly for File.delete().
    
    Throws:
    
    IllegalArgumentException - if base directory argument is null or is not an existing directory.
    
    IOException - if remove operation fails.
  - removeDirectory
```
private static void removeDirectory(File directory)
                             throws IOException
```
    Utility method invoked recursively to remove directory files. This method traverses directory files and remove them, one by one. If a child file is happen to be a directory this method invoked itself with child directory as parameter. After child directory is clean-up iteration continue removing child directory itself. Note that given directory is not removed.
    On remove exception directory state is not defined, that is, some files may be removed while others may not.
    
    Parameters:
    
    directory - directory to remove files from.
    
    Throws:
    
    IOException - if remove operation fails.
  - inotify
```
public static boolean inotify(File file,
                              Files.FileNotify notify,
                              int timeout)
                       throws IllegalArgumentException
```
    Wait for requested action to happen on given file. If timeout is zero or negative this method returns false immediately.
    This implementation is a fallback solution for JVM without java.nio.file.WatchService. Please consider using watch service when available.
    
    Parameters:
    
    file - file to wait for its state change,
    
    notify - notify type,
    
    timeout - timeout value.
    
    Returns:
    
    true if file state change occurred before timeout or false otherwise.
    
    Throws:
    
    IllegalArgumentException - if file is null.
  - normalizePath
```
public static String normalizePath(String path)
```
    Ensure that path separators are compatible with current operating system.
    
    Parameters:
    
    path - path to normalize.
    
    Returns:
    
    normalized path.

Class Files

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

CURRENT_DIR

LINE_SEPARATOR

BUFFER_SIZE

PARTIAL_FILE_SUFFIX

SEPARATOR_CHAR_REX

DOT_PATTERN

URL_PATH_SEPARATOR

EXTENSION_SEPARATOR

UNIX_SEPARATOR

WINDOWS_SEPARATOR

TMP_FILE_PREFIX

TMP_FILE_EXTENSION

IMAGE_FILE_EXTENSIONS

INOTIFY_PREDICATES

Constructor Detail

Files

Method Detail

createBufferedReader

createBufferedWriter

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

download

dump

dump

close

renameTo

move

getRelativePath

getPathComponents

removeExtension

removeExtension

replaceExtension

replaceExtension

path2dot

path2unix

path2unix

dot2path

dot2urlpath

dot2path

getExtension

getExtension

getExtension

basename

basename

createTempFile

isImage

isImage

getFileDigest

getFileDigest

mkdirs

delete

removeFilesHierarchy

removeDirectory

inotify

normalizePath