FileUtils (WebLaF core library 1.2.13 API)

java.lang.Object
- com.alee.utils.FileUtils

```
public final class FileUtils
extends Object
```
This class provides a set of utilities to work with files, file names and their extensions.
Note that methods which request information about files from the system has their own caches to improve performance. If you will need to clear that cache simply call the corresponding clearCache method, for example: For method "isHidden" you will need to call "clearIsHiddenCache" and all cached values will be reset.

Author:

Mikle Garin

Field Summary

Fields
Modifier and Type	Field and Description
`static FileComparator`	`FILE_COMPARATOR` File comparator.
`static long`	`GB` Number of bytes in 1 gigabyte.
`static long`	`KB` Number of bytes in 1 kilobyte.
`static long`	`MB` Number of bytes in 1 megabyte.
`static long`	`PB` Number of bytes in 1 petabyte.
`static long`	`TB` Number of bytes in 1 terabyte.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`appropriateFileName(String text)` Returns appropriate file name based on provided text.
`static String`	`appropriateFileName(String text, String replacement)` Returns appropriate file name based on provided text.
`static String`	`canonicalPath(File file)` Returns file canonical path if its possible or absolute path otherwise.
`static void`	`clearDirectory(File dir)` Deletes all child files and directories for specified directory.
`static void`	`clearDisplayFileCreationDateCache()` Clears cache for "getDisplayFileCreationDate" method.
`static void`	`clearDisplayFileCreationDateCache(String absolutePath)` Clears cache for "getDisplayFileCreationDate" method for specified file path.
`static void`	`clearDisplayFileModificationDateCache()` Clears cache for "getDisplayFileModificationDate" method.
`static void`	`clearDisplayFileModificationDateCache(String absolutePath)` Clears cache for "getDisplayFileModificationDate" method for specified file path.
`static void`	`clearDisplayFileNameCache()` Clears cache for "getDisplayFileName" method.
`static void`	`clearDisplayFileNameCache(String absolutePath)` Clears cache for "getDisplayFileName" method for specified file path.
`static void`	`clearFileCaches(File file)` Clears all caches for specified file.
`static void`	`clearFileCaches(String path)` Clears all caches for file under the specified path.
`static void`	`clearFileDescriptionCache()` Clears cache for "getFileDescription" method.
`static void`	`clearFileDescriptionCache(String absolutePath)` Clears cache for "getFileDescription" method for specified file path.
`static void`	`clearFilesCaches(File... files)` Clears all caches for specified files.
`static void`	`clearFileTypeDescriptionCache()` Clears cache for "getFileTypeDescription" method.
`static void`	`clearFileTypeDescriptionCache(String absolutePath)` Clears cache for "getFileTypeDescription" method for specified file path.
`static void`	`clearIsCdDriveCache()` Clears cache for "isCdDrive" method.
`static void`	`clearIsCdDriveCache(String absolutePath)` Clears cache for "isCdDrive" method for specified file path.
`static void`	`clearIsComputerCache()` Clears cache for "isComputer" method.
`static void`	`clearIsComputerCache(String absolutePath)` Clears cache for "isComputer" method for specified file path.
`static void`	`clearIsDirectoryCache()` Clears cache for "isDirectory" method.
`static void`	`clearIsDirectoryCache(String absolutePath)` Clears cache for "isDirectory" method for specified file path.
`static void`	`clearIsDriveCache()` Clears cache for "isDrive" method.
`static void`	`clearIsDriveCache(String absolutePath)` Clears cache for "isDrive" method for specified file path.
`static void`	`clearIsFileCache()` Clears cache for "isFile" method.
`static void`	`clearIsFileCache(String absolutePath)` Clears cache for "isFile" method for specified file path.
`static void`	`clearIsHiddenCache()` Clears cache for "isHidden" method.
`static void`	`clearIsHiddenCache(String absolutePath)` Clears cache for "isHidden" method for specified file path.
`static String`	`computeMD5(InputStream inputStream)` Returns MD5 for the data provided by `InputStream`.
`static String`	`computeMD5(InputStream inputStream, int bufferLength)` Returns MD5 for the data provided by `InputStream` and uses a buffer of the specified length.
`static String`	`computeMD5(Resource resource)` Returns MD5 for specified `File` content.
`static String`	`computeMD5(Resource resource, int bufferLength)` Returns MD5 for specified `File` content and uses a buffer of the specified length.
`static String`	`computeMD5(String data)` Returns MD5 for specified `String` data.
`static String`	`computeMD5(String data, int bufferLength)` Returns MD5 for specified `String` data and uses a buffer of the specified length.
`static boolean`	`containsFile(List files, File file)` Returns whether list of files or file paths contains the specified file or not.
`static boolean`	`copyDirectory(File srcDir, File dstDir)` Copies src directory content into dst directory and returns whether operation succeed or not.
`static boolean`	`copyDirectory(File srcDir, File dstDir, boolean stopOnFail)` Copies src directory content into dst directory and returns whether operation succeed or not.
`static boolean`	`copyDirectory(String src, String dst)` Copies src directory content into dst directory and returns whether operation succeed or not.
`static boolean`	`copyDirectory(String src, String dst, boolean stopOnFail)` Copies src directory content into dst directory and returns whether operation succeed or not.
`static boolean`	`copyFile(FileChannel srcFC, FileChannel dstFC)` Copies file data from source file channel into destination file channel.
`static boolean`	`copyFile(File srcFile, File dstFile)` Copies source file content into destination file.
`static boolean`	`copyFile(String src, String dst)` Copies source file content into destination file.
`static FileDescription`	`createFileDescription(File file, String fileSize)` Returns complete file description.
`static void`	`deleteFile(File file)` Deletes file or directory completely.
`static void`	`deleteFiles(List files)` Deletes all specified files.
`static void`	`deleteFiles(Object... files)` Deletes all specified files.
`static void`	`displayFileName(JTextComponent editor, File file)` Sets file name as text and selects its name part in any text component.
`static File`	`downloadFile(String url, File dstFile)` Downloads file from the specified url to destination file and returns it if download succeed.
`static File`	`downloadFile(String url, File dstFile, boolean encodeUrl, String contentType, int timeout)` Downloads file from the specified url to destination file and returns it if download succeed.
`static File`	`downloadFile(String url, File dstFile, boolean encodeUrl, String contentType, int timeout, FileDownloadListener listener)` Downloads file from the specified url to destination file and returns it if download succeed.
`static File`	`downloadFile(String url, File dstFile, FileDownloadListener listener)` Downloads file from the specified url to destination file and returns it if download succeed.
`static File`	`downloadFile(String url, String dst, boolean encodeUrl, String contentType, int timeout)` Downloads file from the specified url to destination file and returns it if download succeed.
`static File`	`downloadFile(String url, String dst, boolean encodeUrl, String contentType, int timeout, FileDownloadListener listener)` Downloads file from the specified url to destination file and returns it if download succeed.
`static boolean`	`ensureDirectoryExists(File dir)` Returns true if directory exists or was successfully created during this check, false otherwise.
`static boolean`	`ensureDirectoryExists(String dir)` Returns true if directory exists or was successfully created during this check, false otherwise.
`static boolean`	`equals(File file1, File file2)` Returns whether both files represent the same path in file system or not.
`static boolean`	`equals(List<File> files1, List<File> files2)` Returns whether both list of files have equal files in the same positions or not.
`static List<File>`	`filterFiles(Collection<File> files, AbstractFileFilter fileFilter)` Returns filtered files list.
`static List<File>`	`filterFiles(Collection<File> files, Filter<File> fileFilter)` Returns filtered files list.
`static List<File>`	`findFilesRecursively(File dir, FileFilter filter)` Returns list of files accepted by file filter found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(File dir, FileFilter filter, List<File> found)` Returns list of files accepted by file filter found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(File dir, List<String> extension)` Returns list of files with specified extensions found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(File dir, List<String> extension, boolean withDot)` Returns list of files with specified extensions found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(File dir, List<String> extension, boolean withDot, List<File> found)` Returns list of files with specified extensions found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(String dir, FileFilter filter)` Returns list of files accepted by file filter found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(String dir, FileFilter filter, List<File> found)` Returns list of files accepted by file filter found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(String dir, List<String> extension)` Returns list of files with specified extensions found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(String dir, List<String> extension, boolean withDot)` Returns list of files with specified extensions found in the specified directory and its subdirectories.
`static List<File>`	`findFilesRecursively(String dir, List<String> extension, boolean withDot, List<File> found)` Returns list of files with specified extensions found in the specified directory and its subdirectories.
`static String`	`getAvailableName(File dir, String name)` Returns available file name in the specified directory and which is similar the specified name.
`static String`	`getAvailableName(List<String> existingNames, String name)` Returns available file name that is not contained in the existing names list.
`static String`	`getAvailableName(String dir, String name)` Returns available file name in the specified directory and which is similar the specified name.
`static File`	`getDesktop()` Returns desktop directory if one can be found.
`static String`	`getDesktopPath()` Returns desktop directory path if one can be found.
`static File[]`	`getDiskRoots()` Returns array of available system disks.
`static String`	`getDisplayFileCreationDate(File file)` Returns file modification date to display.
`static String`	`getDisplayFileModificationDate(File file)` Returns file modification date to display.
`static String`	`getDisplayFileName(File file)` Returns file name to display.
`static String`	`getDisplayFileSize(File file)` Returns file size to display.
`static String`	`getDisplayFileSize(File file, int digits)` Returns file size to display.
`static FileDescription`	`getFileDescription(File file, String fileSize)` Returns complete file description.
`static String`	`getFileExtPart(File file, boolean withDot)` Returns file extension either with or without dot.
`static String`	`getFileExtPart(String name, boolean withDot)` Returns file extension either with or without dot.
`static Icon`	`getFileIcon(File file)` Returns system file icon.
`static Icon`	`getFileIcon(File file, boolean large)` Returns either large or small system file icon.
`static String`	`getFileNamePart(File file)` Returns file name without extension.
`static String`	`getFileNamePart(String name)` Returns file name without extension.
`static List<File>`	`getFilePath(File file)` Returns list of files contained in path of the specified file.
`static int`	`getFileSize(String url)` Returns file size, located at the specified url.
`static int`	`getFileSize(URL url)` Returns file size, located at the specified url.
`static String`	`getFileSizeString(long size)` Returns file size to display.
`static String`	`getFileSizeString(long size, int digits)` Returns file size to display.
`static String`	`getFileTypeDescription(File file)` Returns file type description.
`static Icon`	`getIconResource(Class nearClass, String resource)` Returns resource icon.
`static Icon`	`getIconResource(Class nearClass, String resource, float opacity)` Returns resource icon with the specified opacity.
`static File`	`getJarLocationFile(Class jarClass)` Returns JAR location File for the specified class.
`static URL`	`getJarLocationURL(Class jarClass)` Returns JAR location URL for the specified class.
`static File`	`getParent(File file)` Returns parent `File`.
`static String`	`getProperFileName(String name)` Returns a valid for any file system file name based on specified name.
`static String`	`getRelativePath(File file, File folder)` Returns file path relative to specified folder or canonical path if file is not inside that folder.
`static String`	`getShortFileName(String name)` Returns shortened file name.
`static String`	`getShortFileName(String name, int length)` Returns shortened to the specified length file name.
`static Icon`	`getStandardFileIcon(boolean large, String extension, float opacity)` Returns either large or small icon for the specified extension from a standard icons set.
`static Icon`	`getStandardFileIcon(File file, boolean large)` Returns either large or small file icon from a standard icons set.
`static Icon`	`getStandardFileIcon(File file, boolean large, boolean enabled)` Returns either large or small file icon from a standard icons set.
`static List<String>`	`getSubPaths(File dir)` Returns list of all file paths in this directory and all subdirectories.
`static List<String>`	`getSubPaths(File dir, String path)` Returns list of all file paths in this directory and all subdirectories.
`static List<String>`	`getSubPaths(File dir, String path, List<String> paths)` Returns list of all file paths in this directory and all subdirectories.
`static List<String>`	`getSubPaths(String dir)` Returns list of all file paths in this directory and all subdirectories.
`static FileFilter`	`getSwingFileFilter(AbstractFileFilter fileFilter)` Returns actual Swing file filter from the specified filter.
`static File`	`getSystemRoot()` Returns first available file system root.
`static File[]`	`getSystemRoots()` Returns array of available file system roots.
`static File`	`getSystemTemp()` Returns system directory for temporary files.
`static String`	`getSystemTempPath()` Returns path to system directory for temporary files.
`static File`	`getTopParent(File file)` Returns top not-null parent for the specified file.
`static File`	`getUserHome()` Returns user home directory.
`static String`	`getUserHomePath()` Returns path to user home directory.
`static File`	`getWorkingDirectory()` Returns application working directory.
`static String`	`getWorkingDirectoryPath()` Returns application working directory.
`static boolean`	`grantExecutePermissions(File file)` Grants file execution permission for all users for specified file.
`static boolean`	`isCdDrive(File file)` Returns whether the specified file points to system CD/DVD/Bluray drive or not.
`static boolean`	`isComputer(File file)` Returns whether the specified file points to system hard drive or not.
`static boolean`	`isDirectory(File file)` Returns whether the specified file is directory or not.
`static boolean`	`isDrive(File file)` Returns whether the specified file points to system hard drive or not.
`static boolean`	`isFile(File file)` Returns whether the specified file is actually a file (and not a directory, disk or some system folder) or not.
`static boolean`	`isFileAccepted(File file, List<AbstractFileFilter> filters)` Returns whether any of the specified file filters accept the file or not.
`static boolean`	`isHidden(File file)` Returns whether the specified file is hidden or not.
`static boolean`	`isIllegalFileNameChar(char c)` Returns whether the specified character is illegal or not.
`static boolean`	`isNameEditable(File file)` Returns whether specified file's name can be edited.
`static boolean`	`isParent(File parent, File child)` Returns whether the specified child file is one of parent file children or not.
`static File[]`	`listFiles(File directory)` Returns directory files array or empty array (instead of null) if no files present.
`static File[]`	`listFiles(File directory, FileFilter fileFilter)` Returns directory files array or empty array (instead of null) if no files present.
`static File[]`	`listFiles(File directory, Filter<File> fileFilter)` Returns directory files array or empty array (instead of null) if no files present.
`static File`	`normalize(File file)` Returns normalized file without redundant parts in its path.
`static String`	`readToString(InputStream inputStream)` Returns content read from the input stream.
`static String`	`readToString(InputStream inputStream, String encoding)` Returns content read from the input stream.
`static String`	`readToString(Reader reader)` Returns content read from the specified reader.
`static String`	`readToString(Resource resource)` Returns `String` content read from the `Resource`.
`static String`	`readToString(Resource resource, String encoding)` Returns `String` content read from the `Resource`.
`static File[]`	`sortFiles(File[] files)` Returns sorted array of files.
`static List<File>`	`sortFiles(List<File> files)` Returns sorted list of files.
`static List<File>`	`toFilesList(Object... object)` Converts objects array into list of files.
`static WebTimer`	`trackFile(File file, SystemFileListener listener)` Starts tracking file for possible changes.
`static WebTimer`	`trackFile(File file, SystemFileListener listener, long delay)` Starts tracking file for possible changes.
`static AbstractFileFilter`	`transformFileFilter(FileFilter fileFilter)` Returns transformed file filter.
`static AbstractFileFilter`	`transformFileFilter(FileFilter fileFilter)` Returns transformed file filter.
`static void`	`writeStringToFile(String text, File file)` Writes text to the specified file overwriting any content inside the file.
`static void`	`writeStringToFile(String text, File file, String encoding)` Writes text to the specified file overwriting any content inside the file.

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

Field Detail
- KB
```
public static final long KB
```
  Number of bytes in 1 kilobyte.
  
  See Also:
  
  Constant Field Values
- MB
```
public static final long MB
```
  Number of bytes in 1 megabyte.
  
  See Also:
  
  Constant Field Values
- GB
```
public static final long GB
```
  Number of bytes in 1 gigabyte.
  
  See Also:
  
  Constant Field Values
- TB
```
public static final long TB
```
  Number of bytes in 1 terabyte.
  
  See Also:
  
  Constant Field Values
- PB
```
public static final long PB
```
  Number of bytes in 1 petabyte.
  
  See Also:
  
  Constant Field Values
- FILE_COMPARATOR
```
public static final FileComparator FILE_COMPARATOR
```
  File comparator.

Method Detail

getJarLocationURL

@Nullable
public static URL getJarLocationURL(@NotNull
                                              Class jarClass)

Returns JAR location URL for the specified class.

Parameters:: jarClass - any class from that JAR
Returns:: JAR location URL

getJarLocationFile

@Nullable
public static File getJarLocationFile(@NotNull
                                                Class jarClass)

Returns JAR location File for the specified class.

Parameters:: jarClass - any class from that JAR
Returns:: JAR location File

clearFilesCaches

public static void clearFilesCaches(@Nullable
                                    File... files)

Clears all caches for specified files.

Parameters:: files - files to process

clearFileCaches

public static void clearFileCaches(@Nullable
                                   File file)

Clears all caches for specified file.

Parameters:: file - file to process

clearFileCaches

public static void clearFileCaches(@NotNull
                                   String path)

Clears all caches for file under the specified path.

Parameters:: path - file path

getFilePath
```
@NotNull
public static List<File> getFilePath(@Nullable
                                              File file)
```
Returns list of files contained in path of the specified file.
For example if you have some file that points to some local file: "C:\folder\file.txt" You will get this list of files: "C:\", "C:\folder\", "C:\folder\file.txt"

Parameters:

file - file to process

Returns:

list of files contained in path of the specified file

getRelativePath

@NotNull
public static String getRelativePath(@NotNull
                                              File file,
                                              @NotNull
                                              File folder)

Returns file path relative to specified folder or canonical path if file is not inside that folder.

Parameters:: file - file to get relative path to; folder - one of file's parent folders
Returns:: file path relative to specified folder or canonical path if file is not inside that folder

isNameEditable
```
public static boolean isNameEditable(@NotNull
                                     File file)
```
Returns whether specified file's name can be edited.

Parameters:

file - file to edit

Returns:

true if specified file's name can be edited, false otherwise

displayFileName

public static void displayFileName(@NotNull
                                   JTextComponent editor,
                                   @NotNull
                                   File file)

Sets file name as text and selects its name part in any text component.

Parameters:: editor - text editor to process; file - file to process

getSystemTemp
```
@NotNull
public static File getSystemTemp()
```
Returns system directory for temporary files.

Returns:

system directory for temporary files

getSystemTempPath
```
@NotNull
public static String getSystemTempPath()
```
Returns path to system directory for temporary files.

Returns:

path to system directory for temporary files

grantExecutePermissions
```
public static boolean grantExecutePermissions(@NotNull
                                              File file)
```
Grants file execution permission for all users for specified file.

Parameters:

file - file for permissions change

Returns:

true if permissions change operation succeed, false otherwise

normalize

@Nullable
public static File normalize(@Nullable
                                       File file)

Returns normalized file without redundant parts in its path.

Parameters:: file - file to normalize
Returns:: normalized file

getSystemRoot
```
@Nullable
public static File getSystemRoot()
```
Returns first available file system root.

Returns:

first available file system root

getSystemRoots
```
@NotNull
public static File[] getSystemRoots()
```
Returns array of available file system roots.

Returns:

array of available file system roots

getDiskRoots
```
@NotNull
public static File[] getDiskRoots()
```
Returns array of available system disks.

Returns:

array of available system disks

listFiles
```
@NotNull
public static File[] listFiles(@NotNull
                                        File directory)
```
Returns directory files array or empty array (instead of null) if no files present.

Parameters:

directory - directory to look into

Returns:

directory files array or empty array (instead of null) if no files present

listFiles

@NotNull
public static File[] listFiles(@NotNull
                                        File directory,
                                        @Nullable
                                        Filter<File> fileFilter)

Returns directory files array or empty array (instead of null) if no files present.

Parameters:: directory - directory to look into; fileFilter - file filter
Returns:: directory files array or empty array (instead of null) if no files present

listFiles

@NotNull
public static File[] listFiles(@NotNull
                                        File directory,
                                        @Nullable
                                        FileFilter fileFilter)

Returns directory files array or empty array (instead of null) if no files present.

Parameters:: directory - directory to look into; fileFilter - file filter
Returns:: directory files array or empty array (instead of null) if no files present

computeMD5

@NotNull
public static String computeMD5(@NotNull
                                         String data)

Returns MD5 for specified String data.

Parameters:: data - file to process
Returns:: MD5 for specified String data

computeMD5

@NotNull
public static String computeMD5(@NotNull
                                         String data,
                                         int bufferLength)

Returns MD5 for specified String data and uses a buffer of the specified length.

Parameters:: data - file to process; bufferLength - buffer length
Returns:: MD5 for specified String data

computeMD5

@NotNull
public static String computeMD5(@NotNull
                                         Resource resource)

Returns MD5 for specified File content.

Parameters:: resource - Resource to process
Returns:: MD5 for specified File content

computeMD5

@NotNull
public static String computeMD5(@NotNull
                                         Resource resource,
                                         int bufferLength)

Returns MD5 for specified File content and uses a buffer of the specified length.

Parameters:: resource - Resource to process; bufferLength - buffer length
Returns:: MD5 for specified File content

computeMD5

@NotNull
public static String computeMD5(@NotNull
                                         InputStream inputStream)

Returns MD5 for the data provided by InputStream.

Parameters:: inputStream - data stream to process
Returns:: MD5 for the data provided by InputStream

computeMD5

@NotNull
public static String computeMD5(@NotNull
                                         InputStream inputStream,
                                         int bufferLength)

Returns MD5 for the data provided by InputStream and uses a buffer of the specified length.

Parameters:: inputStream - data stream to process; bufferLength - buffer length
Returns:: MD5 for the data provided by InputStream

getWorkingDirectory
```
@NotNull
public static File getWorkingDirectory()
```
Returns application working directory.

Returns:

application working directory

getWorkingDirectoryPath
```
@NotNull
public static String getWorkingDirectoryPath()
```
Returns application working directory.

Returns:

application working directory

getUserHome
```
@NotNull
public static File getUserHome()
```
Returns user home directory.

Returns:

user home directory

getUserHomePath
```
@NotNull
public static String getUserHomePath()
```
Returns path to user home directory.

Returns:

path to user home directory

getDesktop
```
@Nullable
public static File getDesktop()
```
Returns desktop directory if one can be found.

Returns:

desktop directory if one can be found

getDesktopPath
```
@Nullable
public static String getDesktopPath()
```
Returns desktop directory path if one can be found.

Returns:

desktop directory path if one can be found

equals

public static boolean equals(@Nullable
                             File file1,
                             @Nullable
                             File file2)

Returns whether both files represent the same path in file system or not.

Parameters:: file1 - first file to be compared; file2 - second file to be compared
Returns:: true if both files represent the same path in file system, false otherwise

equals
```
public static boolean equals(@NotNull
                             List<File> files1,
                             @NotNull
                             List<File> files2)
```
Returns whether both list of files have equal files in the same positions or not.

Parameters:

files1 - first files list to be compared

files2 - second files list to be compared

Returns:

true if both list of files have equal files in the same positions, false otherwise

containsFile

public static boolean containsFile(@NotNull
                                   List files,
                                   @NotNull
                                   File file)

Returns whether list of files or file paths contains the specified file or not.

Parameters:: files - list of files to search in; file - file to look for
Returns:: true if list of files or file paths contains the specified file, false otherwise

isFileAccepted

public static boolean isFileAccepted(@NotNull
                                     File file,
                                     @Nullable
                                     List<AbstractFileFilter> filters)

Returns whether any of the specified file filters accept the file or not.

Parameters:: file - file to process; filters - file filters list
Returns:: true if any of the specified file filters accept the file, false otherwise

getProperFileName

@NotNull
public static String getProperFileName(@NotNull
                                                String name)

Returns a valid for any file system file name based on specified name.

Parameters:: name - name to process
Returns:: file name valid for any file system

isIllegalFileNameChar
```
public static boolean isIllegalFileNameChar(char c)
```
Returns whether the specified character is illegal or not.

Parameters:

c - character to process

Returns:

true the specified character is illegal, false otherwise

canonicalPath
```
@NotNull
public static String canonicalPath(File file)
```
Returns file canonical path if its possible or absolute path otherwise.

Parameters:

file - file to process

Returns:

file canonical path if its possible or absolute path otherwise

getParent
```
@Nullable
public static File getParent(@NotNull
                                       File file)
```
Returns parent File. Unlike File.getParentFile() it doesn't fail on cases when native parent is null. Whenever native parent is null this method will fallback to File.getParent() path usage.

Parameters:

file - File to return parent File for

Returns:

parent File

getTopParent
```
@Nullable
public static File getTopParent(@NotNull
                                          File file)
```
Returns top not-null parent for the specified file. If file has no parents at all simply returns null.

Parameters:

file - file to process

Returns:

top not-null parent for the specified file or null if it has no parent files

isParent

public static boolean isParent(@Nullable
                               File parent,
                               @Nullable
                               File child)

Returns whether the specified child file is one of parent file children or not.

Parameters:: parent - parent file; child - child file
Returns:: true if the specified child file is one of parent file children, false otherwise

getFileNamePart

@NotNull
public static String getFileNamePart(@Nullable
                                              File file)

Returns file name without extension.

Parameters:: file - file to process
Returns:: file name without extension

getFileNamePart

@NotNull
public static String getFileNamePart(@Nullable
                                              String name)

Returns file name without extension.

Parameters:: name - file name to trim
Returns:: file name without extension

getFileExtPart

@NotNull
public static String getFileExtPart(@Nullable
                                             File file,
                                             boolean withDot)

Returns file extension either with or without dot.

Parameters:: file - file to process; withDot - whether return the extension with dot, or not
Returns:: file extension

getFileExtPart

@NotNull
public static String getFileExtPart(@Nullable
                                             String name,
                                             boolean withDot)

Returns file extension either with or without dot.

Parameters:: name - file name to process; withDot - whether return the extension with dot, or not
Returns:: file extension

getShortFileName

@NotNull
public static String getShortFileName(@Nullable
                                               String name)

Returns shortened file name.

Parameters:: name - file name to shorten
Returns:: shortened file name

getShortFileName

@NotNull
public static String getShortFileName(@Nullable
                                               String name,
                                               int length)

Returns shortened to the specified length file name. Note that file extension length is not counted.

Parameters:: name - file name to shorten; length - maximum allowed file name length
Returns:: shortened file name

sortFiles

@Nullable
public static List<File> sortFiles(@Nullable
                                             List<File> files)

Returns sorted list of files.

Parameters:: files - list of files to sort
Returns:: sorted list of files

sortFiles

@Nullable
public static File[] sortFiles(@Nullable
                                         File[] files)

Returns sorted array of files.

Parameters:: files - array of files to sort
Returns:: sorted array of files

getAvailableName

@NotNull
public static String getAvailableName(@NotNull
                                               String dir,
                                               @NotNull
                                               String name)

Returns available file name in the specified directory and which is similar the specified name.

Parameters:: dir - directory path to check; name - file name to check
Returns:: available file name

getAvailableName

@NotNull
public static String getAvailableName(@NotNull
                                               File dir,
                                               @NotNull
                                               String name)

Returns available file name in the specified directory and which is similar the specified name.

Parameters:: dir - directory to check; name - file name to check
Returns:: available file name

getAvailableName

@NotNull
public static String getAvailableName(@NotNull
                                               List<String> existingNames,
                                               @NotNull
                                               String name)

Returns available file name that is not contained in the existing names list.

Parameters:: existingNames - list of existing file names; name - file name to check
Returns:: available file name that is not contained in the existing names list

toFilesList

@NotNull
public static List<File> toFilesList(@Nullable
                                              Object... object)

Converts objects array into list of files. Non-file type objects will be simply ignored.

Parameters:: object - file object
Returns:: list of files

deleteFiles

public static void deleteFiles(@NotNull
                               Object... files)

Deletes all specified files.

Parameters:: files - files to delete

deleteFiles

public static void deleteFiles(@NotNull
                               List files)

Deletes all specified files.

Parameters:: files - files to delete

deleteFile
```
public static void deleteFile(@NotNull
                              File file)
```
Deletes file or directory completely. All child files and directories will be removed first in case directory is deleted.

Parameters:

file - file to delete

clearDirectory
```
public static void clearDirectory(@NotNull
                                  File dir)
```
Deletes all child files and directories for specified directory. Directory itself will not be deleted.

Parameters:

dir - directory to clear

transformFileFilter

@NotNull
public static AbstractFileFilter transformFileFilter(@NotNull
                                                              FileFilter fileFilter)

Returns transformed file filter.

Parameters:: fileFilter - IO file filter
Returns:: transformed file filter

transformFileFilter

@NotNull
public static AbstractFileFilter transformFileFilter(@NotNull
                                                              FileFilter fileFilter)

Returns transformed file filter.

Parameters:: fileFilter - Swing file filter
Returns:: transformed file filter.

getSwingFileFilter

@Nullable
public static FileFilter getSwingFileFilter(@Nullable
                                                      AbstractFileFilter fileFilter)

Returns actual Swing file filter from the specified filter.

Parameters:: fileFilter - WebLaF file filter
Returns:: actual Swing file filter from the specified filter

filterFiles

@NotNull
public static List<File> filterFiles(@NotNull
                                              Collection<File> files,
                                              @NotNull
                                              AbstractFileFilter fileFilter)

Returns filtered files list.

Parameters:: files - files collection to filter; fileFilter - file filter
Returns:: filtered files list

filterFiles

@NotNull
public static List<File> filterFiles(@NotNull
                                              Collection<File> files,
                                              @NotNull
                                              Filter<File> fileFilter)

Returns filtered files list.

Parameters:: files - files collection to filter; fileFilter - file filter
Returns:: filtered files list

createFileDescription

@NotNull
public static FileDescription createFileDescription(@NotNull
                                                             File file,
                                                             @Nullable
                                                             String fileSize)

Returns complete file description.

Parameters:: file - file to process; fileSize - file size
Returns:: complete file description

getDisplayFileSize

@NotNull
public static String getDisplayFileSize(@NotNull
                                                 File file)

Returns file size to display.

Parameters:: file - file to process
Returns:: file size to display

getDisplayFileSize

@NotNull
public static String getDisplayFileSize(@NotNull
                                                 File file,
                                                 int digits)

Returns file size to display.

Parameters:: file - file to process; digits - number of digits after the dot
Returns:: file size to display

getFileSizeString
```
public static String getFileSizeString(long size)
```
Returns file size to display.

Parameters:

size - size of the file

Returns:

file size to display

getFileSizeString
```
@NotNull
public static String getFileSizeString(long size,
                                                int digits)
```
Returns file size to display.

Parameters:

size - size of the file

digits - number of digits after the dot

Returns:

file size to display

copyDirectory

public static boolean copyDirectory(@NotNull
                                    String src,
                                    @NotNull
                                    String dst)

Copies src directory content into dst directory and returns whether operation succeed or not. Also ignores any exceptions that might occur during the copy process.

Parameters:: src - source directory path; dst - destination directory path
Returns:: true if copy operation succeed, false otherwise

copyDirectory
```
public static boolean copyDirectory(@NotNull
                                    String src,
                                    @NotNull
                                    String dst,
                                    boolean stopOnFail)
```
Copies src directory content into dst directory and returns whether operation succeed or not. Whether to stop copy operation if any exception occurs or not is set by stopOnFail argument.

Parameters:

src - source directory path

dst - destination directory path

stopOnFail - whether to stop copy operation if any exception occurs or not

Returns:

true if copy operation succeed, false otherwise

copyDirectory

public static boolean copyDirectory(@NotNull
                                    File srcDir,
                                    @NotNull
                                    File dstDir)

Copies src directory content into dst directory and returns whether operation succeed or not. Also ignores any exceptions that might occur during the copy process.

Parameters:: srcDir - source directory; dstDir - destination directory
Returns:: true if copy operation succeed, false otherwise

copyDirectory
```
public static boolean copyDirectory(@NotNull
                                    File srcDir,
                                    @NotNull
                                    File dstDir,
                                    boolean stopOnFail)
```
Copies src directory content into dst directory and returns whether operation succeed or not. Whether to stop copy operation if any exception occurs or not is set by stopOnFail argument.

Parameters:

srcDir - source directory

dstDir - destination directory

stopOnFail - whether to stop copy operation if any exception occurs or not

Returns:

true if copy operation succeed, false otherwise

copyFile
```
public static boolean copyFile(@Nullable
                               String src,
                               @Nullable
                               String dst)
```
Copies source file content into destination file. If destination directory doesn't exist it will be created in the process. If destination file doesn't exist it will be also created in the process.

Parameters:

src - source file path

dst - destination file path

Returns:

true if copy operation succeed, false otherwise

copyFile
```
public static boolean copyFile(@Nullable
                               File srcFile,
                               @Nullable
                               File dstFile)
```
Copies source file content into destination file. If destination directory doesn't exist it will be created in the process. If destination file doesn't exist it will be also created in the process.

Parameters:

srcFile - source file

dstFile - destination file

Returns:

true if copy operation succeed, false otherwise

copyFile

public static boolean copyFile(@NotNull
                               FileChannel srcFC,
                               @NotNull
                               FileChannel dstFC)

Copies file data from source file channel into destination file channel.

Parameters:: srcFC - source file channel; dstFC - destination file channel
Returns:: true if copy operation succeed, false otherwise

readToString

@NotNull
public static String readToString(@NotNull
                                           Resource resource)

Returns String content read from the Resource.

Parameters:: resource - Resource
Returns:: String content read from the Resource

readToString

@NotNull
public static String readToString(@NotNull
                                           Resource resource,
                                           @NotNull
                                           String encoding)

Returns String content read from the Resource.

Parameters:: resource - Resource; encoding - content encoding
Returns:: String content read from the Resource

readToString

@NotNull
public static String readToString(@NotNull
                                           InputStream inputStream)

Returns content read from the input stream.

Parameters:: inputStream - text content input stream
Returns:: text content

readToString

@NotNull
public static String readToString(@NotNull
                                           InputStream inputStream,
                                           @NotNull
                                           String encoding)

Returns content read from the input stream.

Parameters:: inputStream - text content input stream; encoding - stream data encoding
Returns:: content

readToString

@NotNull
public static String readToString(@NotNull
                                           Reader reader)

Returns content read from the specified reader.

Parameters:: reader - text content reader
Returns:: content

writeStringToFile

public static void writeStringToFile(@NotNull
                                     String text,
                                     @NotNull
                                     File file)

Writes text to the specified file overwriting any content inside the file. If file or even its directory doesn't exist - they will be created.

Parameters:: text - text to write; file - file to write text into

writeStringToFile

public static void writeStringToFile(@NotNull
                                     String text,
                                     @NotNull
                                     File file,
                                     @NotNull
                                     String encoding)

Writes text to the specified file overwriting any content inside the file. If file or even its directory doesn't exist - they will be created.

Parameters:: text - text to write; file - file to write text into; encoding - file encoding

getSubPaths

@NotNull
public static List<String> getSubPaths(@NotNull
                                                String dir)

Returns list of all file paths in this directory and all subdirectories.

Parameters:: dir - path of directory to process
Returns:: list of file paths

getSubPaths

@NotNull
public static List<String> getSubPaths(@NotNull
                                                File dir)

Returns list of all file paths in this directory and all subdirectories.

Parameters:: dir - directory to process
Returns:: list of file paths

getSubPaths

@NotNull
public static List<String> getSubPaths(@NotNull
                                                File dir,
                                                @NotNull
                                                String path)

Returns list of all file paths in this directory and all subdirectories.

Parameters:: dir - directory to process; path - path to current position
Returns:: list of file paths

getSubPaths

@NotNull
public static List<String> getSubPaths(@NotNull
                                                File dir,
                                                @NotNull
                                                String path,
                                                @NotNull
                                                List<String> paths)

Returns list of all file paths in this directory and all subdirectories.

Parameters:: dir - directory to process; path - path to current position; paths - list of collected paths
Returns:: list of file paths

downloadFile

@NotNull
public static File downloadFile(@NotNull
                                         String url,
                                         @NotNull
                                         File dstFile)

Downloads file from the specified url to destination file and returns it if download succeed. todo Instead of multiple methods create DownloadParameters class that would contain all of the settings

Parameters:: url - file source url; dstFile - destination file
Returns:: downloaded file if download succeed

downloadFile

@NotNull
public static File downloadFile(@NotNull
                                         String url,
                                         @NotNull
                                         File dstFile,
                                         @Nullable
                                         FileDownloadListener listener)

Downloads file from the specified url to destination file and returns it if download succeed. You can observe and manipulate the download process by providing a file download listener. todo Instead of multiple methods create DownloadParameters class that would contain all of the settings

Parameters:: url - file source url; dstFile - destination file; listener - file download process listener
Returns:: downloaded file if download succeed

downloadFile

@NotNull
public static File downloadFile(@NotNull
                                         String url,
                                         @NotNull
                                         String dst,
                                         boolean encodeUrl,
                                         @Nullable
                                         String contentType,
                                         int timeout)

Downloads file from the specified url to destination file and returns it if download succeed. todo Instead of multiple methods create DownloadParameters class that would contain all of the settings

Parameters:: url - file source url; dst - destination file path; encodeUrl - whether encode the source url or not; contentType - content type limitation; timeout - connection and read timeout
Returns:: downloaded file if download succeed

downloadFile

@NotNull
public static File downloadFile(@NotNull
                                         String url,
                                         @NotNull
                                         String dst,
                                         boolean encodeUrl,
                                         @Nullable
                                         String contentType,
                                         int timeout,
                                         @Nullable
                                         FileDownloadListener listener)

Parameters:: url - file source url; dst - destination file path; encodeUrl - whether encode the source url or not; contentType - content type limitation; timeout - connection and read timeout; listener - file download process listener
Returns:: downloaded file if download succeed

downloadFile

@NotNull
public static File downloadFile(@NotNull
                                         String url,
                                         @NotNull
                                         File dstFile,
                                         boolean encodeUrl,
                                         @Nullable
                                         String contentType,
                                         int timeout)

Downloads file from the specified url to destination file and returns it if download succeed. todo Instead of multiple methods create DownloadParameters class that would contain all of the settings

Parameters:: url - file source url; dstFile - destination file; encodeUrl - whether encode the source url or not; contentType - content type limitation; timeout - connection and read timeout
Returns:: downloaded file if download succeed

downloadFile

@NotNull
public static File downloadFile(@NotNull
                                         String url,
                                         @NotNull
                                         File dstFile,
                                         boolean encodeUrl,
                                         @Nullable
                                         String contentType,
                                         int timeout,
                                         @Nullable
                                         FileDownloadListener listener)

Parameters:: url - file source url; dstFile - destination file; encodeUrl - whether encode the source url or not; contentType - content type limitation; timeout - connection and read timeout; listener - file download process listener
Returns:: downloaded file if download succeed

getFileSize

public static int getFileSize(@NotNull
                              String url)

Returns file size, located at the specified url.

Parameters:: url - file location url
Returns:: file size

getFileSize

public static int getFileSize(@NotNull
                              URL url)

Returns file size, located at the specified url.

Parameters:: url - file location url
Returns:: file size