com.tplan.robot.util

Class FileUtils

java.lang.Object

com.tplan.robot.util.FileUtils

Direct Known Subclasses:

Utils

public class FileUtils
extends Object

File utilities - move, copy and delete one or more files and/or directories.

Since:

3.5

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<File,Boolean>	canCreateFileMap Map used to improve performance of the canCreateNewFile(java.io.File) method.

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	canCreateNewFile(File f) Test whether the argument file can be created for writing.
static boolean	contains(File dir, File f) Find out if a directory is parent of a file meaning that the directory is either the direct or indirect (more top-level) file parent.
static void	copy(InputStream in, File out) Write the input stream to a file.
static void	copy(InputStream in, OutputStream out, boolean close) Write the input stream to the output one.
static void	copy(InputStream in, OutputStream out, boolean closeIn, boolean closeOut) Write the input stream to the output one.
static boolean	copyDirectoryContent(File sourceDir, File targetDir, List<File> exclude, Map<File,File> changes, boolean rewrite) Copy the directory content to another directory.The method is interactive meaning it displays an option message when the target file exists.
static boolean	copyDirectoryContent(File sourceDir, File targetDir, Map<File,File> changes, boolean rewrite) Copy the directory content to another directory.
static boolean	copyDirectoryContent(File sourceDir, File targetDir, Window owner, Map<File,File> changes) Copy the directory content to another directory.
static void	copyFile(File in, File out) Copy a file.
static void	delete(File f, int[] cnt, boolean dryRun) Delete the selected file.
static void	deleteEmptyDirs(File dir) Delete empty directories in the argument dir recursively.
static File	extract(File zipFile, String pathInZip, boolean search, File target) Extract a file from a ZIP archive.
static List<File>	findFile(File dir, String name, List<File> outList, boolean useRegularExpression, boolean ignoreCase, boolean[] stop, String[] currentDir) Search for a file path recursively for a file whose name matches a particular string or a Pattern compliant regular expression.
static List<File>	findFile(File dir, String name, List<File> outList, boolean useRegularExpression, boolean ignoreCase, boolean[] stop, String[] currentDir, VetoableChangeListener listener) Search for a file path recursively for a file whose name matches a particular string or a Pattern compliant regular expression.
static String	getExtension(File f) Get the lower case extension of a file.
static String	getExtension(String f) Get the extension of a file.
static File	getFileFromURL(String link, StringBuilder frag) Extract the file part from a URL.
static String	getFullPath(File f) Get the file full path (exception free).
static String	getInstallPath() Get the Robot install path, i.e.
static String	getInstallPath(Class clazz) Get the class (install) path of the file the argument class was loaded from.
static File	getJarFile() Get the robot.jar file.
static File	getJarFile(Class clazz) Get the JAR file the argument class was loaded from.
static String	getJarManifestField(String clazz, String... fields) Get a field from a manifest file of a JAR file.
static String	getRelativePath(File file, File relativeTo) Get relative path to a file resolved to another file or directory.
static boolean	isLink(File file) Check if the argument is a link.
static boolean	isParent(File f, File parentFile) Find out if a directory is parent of a file meaning that the directory is either the direct or indirect (more top-level) file parent.
static boolean	moveOrCopy(Component owner, File[] files, File targetPath, boolean copy, boolean interactive, boolean treatAsOne, Map<File,File> changes) Move or copy the specified files and/or directories to the specified target path.
static File	parseFile(String file) Create a file from a String.
static StringBuilder	read(File f, Charset encoding) Read a text file into a string builder.Suitable for small plain text files.
static StringBuilder	read(InputStream is, Charset encoding) Read an input stream into a string builder.
static boolean	rename(Component owner, File source, File target, boolean copy, boolean interactive, Map<File,File> changes) Rename (move) or copy the specified file (directory) to the specified target file (directory).
static void	write(File f, String content) Create a file with the specified text content.
static void	write(File f, String content, String encoding) Create a file with the specified text content.
static void	writeSafely(File f, String content, String encoding) Create a file with the specified text content.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

canCreateFileMap

public static Map<File,Boolean> canCreateFileMap

Map used to improve performance of the canCreateNewFile(java.io.File) method.

Constructor Detail

FileUtils

public FileUtils()

Method Detail

moveOrCopy

public static boolean moveOrCopy(Component owner,
                                 File[] files,
                                 File targetPath,
                                 boolean copy,
                                 boolean interactive,
                                 boolean treatAsOne,
                                 Map<File,File> changes)

Move or copy the specified files and/or directories to the specified target path.

Parameters:

owner - the owning window. It will be used as a parent of the question and error messages.

files - the files to copy/move.

targetPath - the target path to copy/move the files to.

copy - true performs a copy, false a move.

interactive - true will enable the error messages, false will fall back to defaults (overwrite all, restore on an error).

treatAsOne - true will treat the file list as a single file in terms of the overwrite questions. This allows to move multiple files such as for example a template image and its meta data file in a way that the user thinks he/she is handling just one file.

changes - optional map for the performed changes ([newFile, oldFile] pairs).

Returns:

true if everything completes OK, false if not.

rename

public static boolean rename(Component owner,
                             File source,
                             File target,
                             boolean copy,
                             boolean interactive,
                             Map<File,File> changes)

Rename (move) or copy the specified file (directory) to the specified target file (directory).

Parameters:

owner - the owning window. It will be used as a parent of the question and error messages.

source - the file to copy/move.

target - the target path to copy/move the file to.

copy - true performs a copy, false a rename (move).

interactive - true will enable the error messages, false will fall back to defaults (overwrite all, restore on an error).

changes - optional map for the performed changes ([newFile, oldFile] pairs).

Returns:

true if everything completes OK, false if not.

delete

public static void delete(File f,
                          int[] cnt,
                          boolean dryRun)
                   throws IOException

Delete the selected file. If the file is a directory it will be deleted recursively.

Parameters:

f - the file to delete.

cnt - optional int array to store the number of deleted files to. It may be used by an asynchronous process to report the progress.

dryRun - the value of true will run through the file(s) but it will not delete the files. This mode can be used together with the cnt counter to count the number of files that can be deleted.

Throws:

IOException - when a file/directory fails to delete.

copyFile

public static void copyFile(File in,
                            File out)
                     throws IOException

Copy a file.

Parameters:

in - the input file.

out - the output file.

Throws:

IOException - on an I/O error.

copyDirectoryContent

public static boolean copyDirectoryContent(File sourceDir,
                                           File targetDir,
                                           Window owner,
                                           Map<File,File> changes)
                                    throws Exception

Copy the directory content to another directory. The method is interactive meaning it displays an option message when the target file exists. Unlike the moveOrCopy(java.awt.Component, java.io.File[], java.io.File, boolean, boolean, boolean, java.util.Map) method this one doesn't resolve the conflicts up front and copies the files one by one directly. If the action gets canceled by the user the files copied so far are not removed.

Parameters:

sourceDir - the source directory.

targetDir - the target directory.

owner - the window owner (used as a parent of the messages).

changes - an optional output map of [sourceFile, targetFile] pairs to capture the files that were copied successfully..

Returns:

true if the files were copied, false if not.

Throws:

Exception - on an I/O error.

copyDirectoryContent

public static boolean copyDirectoryContent(File sourceDir,
                                           File targetDir,
                                           Map<File,File> changes,
                                           boolean rewrite)
                                    throws Exception

Copy the directory content to another directory. The method is interactive meaning it displays an option message when the target file exists. Unlike the moveOrCopy(java.awt.Component, java.io.File[], java.io.File, boolean, boolean, boolean, java.util.Map) method this one doesn't resolve the conflicts up front and copies the files one by one directly. If the action gets canceled by the user the files copied so far are not removed.

Parameters:

sourceDir - the source directory.

targetDir - the target directory.

changes - an optional output map of [sourceFile, targetFile] pairs to capture the files that were copied successfully..

rewrite - true to force rewrite the files or false to skip.

Returns:

true if the files were copied, false if not.

Throws:

Exception - on an I/O error.

Since:

4.4

copyDirectoryContent

public static boolean copyDirectoryContent(File sourceDir,
                                           File targetDir,
                                           List<File> exclude,
                                           Map<File,File> changes,
                                           boolean rewrite)
                                    throws Exception

Copy the directory content to another directory.The method is interactive meaning it displays an option message when the target file exists. Unlike the moveOrCopy(java.awt.Component, java.io.File[], java.io.File, boolean, boolean, boolean, java.util.Map) method this one doesn't resolve the conflicts up front and copies the files one by one directly. If the action gets canceled by the user the files copied so far are not removed.

Parameters:

sourceDir - the source directory.

targetDir - the target directory.

exclude - the list of files or directories to be excluded (skipped).

changes - an optional output map of [sourceFile, targetFile] pairs to capture the files that were copied successfully..

rewrite - true to force rewrite the files or false to skip.

Returns:

true if the files were copied, false if not.

Throws:

Exception - on an I/O error.

Since:

7.0

copy

public static void copy(InputStream in,
                        File out)
                 throws IOException

Write the input stream to a file.

Parameters:

in - an input stream.

out - the output file.

Throws:

IOException - on an I/O error.

copy

public static void copy(InputStream in,
                        OutputStream out,
                        boolean close)
                 throws IOException

Write the input stream to the output one.

Parameters:

in - the input stream.

out - the output stream.

close - true will close the output stream after the data transfer is completed or an I/O error is thrown. The input stream gets closed always regardless of this flag.

Throws:

IOException - on an I/O error.

copy

public static void copy(InputStream in,
                        OutputStream out,
                        boolean closeIn,
                        boolean closeOut)
                 throws IOException

Write the input stream to the output one.

Parameters:

in - the input stream.

out - the output stream.

closeIn - true will close the input stream after the data transfer is completed or an I/O error is thrown.

closeOut - true will close the output stream after the data transfer is completed or an I/O error is thrown.

Throws:

IOException - on an I/O error.

Since:

7.0

getExtension

public static String getExtension(File f)

Get the lower case extension of a file.

Parameters:

f - a file.

Returns:

file extension in lowercase or null if the file has no extension.

getExtension

public static String getExtension(String f)

Get the extension of a file.

Parameters:

f - a file.

Returns:

file extension null if the file has no extension.

getFullPath

public static String getFullPath(File f)

Get the file full path (exception free). The method makes an attempt to resolve the canonical path by calling File.getCanonicalPath() and falls back to the absolute one (File.getAbsolutePath()) when the resolution fails.

Parameters:

f - a file.

Returns:

the full (canonical or absolute) file path.

getRelativePath

public static String getRelativePath(File file,
                                     File relativeTo)
                              throws IOException

Get relative path to a file resolved to another file or directory.

Parameters:

file - file to get the relative path for.

relativeTo - file or directory to resolve against.

Returns:

relative file path as String (for example, "../../test/myfile.txt"). The method may return null where relative referencing is not possible, for example where the files are on different drives (disks) on Windows.

Throws:

IOException - when the File.getCanonicalPath() method throws an I/O exception.

contains

public static boolean contains(File dir,
                               File f)

Find out if a directory is parent of a file meaning that the directory is either the direct or indirect (more top-level) file parent.

Parameters:

dir - a directory.

f - a file.

Returns:

true if the directory contains the file or the file is located under one of its subdirectories.

isParent

public static boolean isParent(File f,
                               File parentFile)

Find out if a directory is parent of a file meaning that the directory is either the direct or indirect (more top-level) file parent.

Parameters:

f - a file.

parentFile - the file parent.

Returns:

true if the parentFile is parent of f.

canCreateNewFile

public static boolean canCreateNewFile(File f)
                                throws IOException

Test whether the argument file can be created for writing. If the file already exists, the method returns result of the File.canWrite() method. If the file doesn't exist, the method makes an attempt to create it together with any necessary directories to test whether it is possible or not. Any newly created objects are deleted in the end of the test.

Note that for performance reasons the files tested by this method are cached together with the result. If the method is called repeatedly with the same file, the file is not really tested in the file system and the cached result is returned instead. Should you need to clear the cache, see the canCreateFileMap map. To disable caching simply set the map to null; to reenable it assign it a new hash map.

Parameters:

f - a file.

Returns:

true if it already exists and is writable or if it can be created for writing.

Throws:

IOException - if any of the directory or file create operations throw an IO exception, it is rethrown.

findFile

public static List<File> findFile(File dir,
                                  String name,
                                  List<File> outList,
                                  boolean useRegularExpression,
                                  boolean ignoreCase,
                                  boolean[] stop,
                                  String[] currentDir,
                                  VetoableChangeListener listener)

Search for a file path recursively for a file whose name matches a particular string or a Pattern compliant regular expression.

Parameters:

dir - root directory to start the search from.

name - the name or regular expression to match.

outList - output list for the located files. A new one will be created and returned when it is null.

useRegularExpression - true will handle the name as a regular expression. If the argument is false, a regular string comparison will be done.

ignoreCase - only used when useRegularExpression=false. If this flag is true, the file name will be compared to the string specified by name using String.equalsIgnoreCase(java.lang.String) rather than String.equals(java.lang.Object).

stop - if a non-null boolean array with the length>=1 is specified, the value of stop[0] will be periodically checked and when it becomes "true", the file search will stop immediately. This functionality may be used for example for a "Stop search" button in the GUI.

currentDir - if a non-null String array with the length>=1 is specified, the file search will populate currentDir[0] with the absolute directory path whenever a new directory is entered. This functionality may be used for example for a GUI component which shows the currently processed folder.

listener - an optional listener to be called whenever a matching file is discovered. The property event will have the name set to "file", the old value will be null and the new value will be set to the file (File instance). If the listener throws a PropertyVetoException the search will continue but the file will not be added to the returned list.

Returns:

list of files matching the entry criteria. If no file is found, the method returns an empty list.

findFile

public static List<File> findFile(File dir,
                                  String name,
                                  List<File> outList,
                                  boolean useRegularExpression,
                                  boolean ignoreCase,
                                  boolean[] stop,
                                  String[] currentDir)

Search for a file path recursively for a file whose name matches a particular string or a Pattern compliant regular expression.

Parameters:

dir - root directory to start the search from.

name - the name or regular expression to match.

outList - output list for the located files. A new one will be created and returned when it is null.

useRegularExpression - true will handle the name as a regular expression. If the argument is false, a regular string comparison will be done.

ignoreCase - only used when useRegularExpression=false. If this flag is true, the file name will be compared to the string specified by name using String.equalsIgnoreCase(java.lang.String) rather than String.equals(java.lang.Object).

stop - if a non-null boolean array with the length>=1 is specified, the value of stop[0] will be periodically checked and when it becomes "true", the file search will stop immediately. This functionality may be used for example for a "Stop search" button in the GUI.

currentDir - if a non-null String array with the length>=1 is specified, the file search will populate currentDir[0] with the absolute directory path whenever a new directory is entered. This functionality may be used for example for a GUI component which shows the currently processed folder..

Returns:

list of files matching the entry criteria. If no file is found, the method returns an empty list.

isLink

public static boolean isLink(File file)

Check if the argument is a link.

Parameters:

file - a file.

Returns:

true if the file is a link, false if not.

getInstallPath

public static String getInstallPath()

Get the Robot install path, i.e. the folder that contains the robot.jar file.

Returns:

the install path.

getInstallPath

public static String getInstallPath(Class clazz)

Get the class (install) path of the file the argument class was loaded from.

Parameters:

clazz - a class.

Returns:

the class path (root path) of the given class was loaded from.

getJarFile

public static File getJarFile()

Get the robot.jar file.

Returns:

the product's robot.jar file or null if the application was not started from the JAR.

getJarFile

public static File getJarFile(Class clazz)

Get the JAR file the argument class was loaded from.

Parameters:

clazz - a class.

Returns:

the class' JAR file or null if the class was not loaded from a file.

getJarManifestField

public static String getJarManifestField(String clazz,
                                         String... fields)

Get a field from a manifest file of a JAR file.

Parameters:

clazz - a class loaded from the JAR file.

fields - one or more fields to look for ordered by the priority (if the first one is not found look for the second one etc.).

Returns:

the field value if found or null otherwise

Since:

5.0

getFileFromURL

public static File getFileFromURL(String link,
                                  StringBuilder frag)

Extract the file part from a URL. The method handles well both the standard file URLs (file://[file]) and the Java crippled ones (file:[file], for example file:/tmp/test.txt).

Parameters:

link - a URL.

frag - an optional buffer to write the fragment to (the anchor after the '#' sign).

Returns:

the file.

read

public static StringBuilder read(File f,
                                 Charset encoding)
                          throws IOException

Read a text file into a string builder.Suitable for small plain text files.

Parameters:

f - a file to read.

encoding - file encoding. If null the method will fall back to the default OS one.

Returns:

the file content.

Throws:

IOException - on an I/O error.

Since:

3.5.1

read

public static StringBuilder read(InputStream is,
                                 Charset encoding)
                          throws IOException

Read an input stream into a string builder. Suitable for streams delivering small amount of data.

Parameters:

is - an input stream to read.

encoding - file encoding. If null the method will fall back to the default OS one.

Returns:

the file content.

Throws:

IOException - on an I/O error.

Since:

4.1.3

write

public static void write(File f,
                         String content)
                  throws IOException

Create a file with the specified text content.

Parameters:

f - a file to create.

content - the text to write to the file.

Throws:

IOException - on an I/O error.

Since:

4.1.3

write

public static void write(File f,
                         String content,
                         String encoding)
                  throws IOException

Create a file with the specified text content.

Parameters:

f - a file to create.

content - the text to write to the file.

encoding - file encoding

Throws:

IOException - on an I/O error.

Since:

4.1.3

writeSafely

public static void writeSafely(File f,
                               String content,
                               String encoding)
                        throws IOException

Create a file with the specified text content.

Parameters:

f - a file to create.

content - the text to write to the file.

encoding - file encoding

Throws:

IOException - on an I/O error.

Since:

4.4

extract

public static File extract(File zipFile,
                           String pathInZip,
                           boolean search,
                           File target)
                    throws FileNotFoundException,
                           IOException

Extract a file from a ZIP archive.

Parameters:

zipFile - a ZIP or JAR file.

pathInZip - path to the file in the archive to be extracted.

search - true will make an attempt to find the first file of the same name.

target - where to extract the file to.

Returns:

the target file on success or null if the file is not present in the archive.

Throws:

FileNotFoundException - when the ZIP file is not found.

IOException - when the ZIP file can not be read or the the method can't write to the target file.

Since:

4.1

parseFile

public static File parseFile(String file)

Create a file from a String. Unlike the standard java.io.File(String) constructor the method checks whether the path looks like a Windows one and fixes the backslash characters if the current system is a Unix one.

Parameters:

file - a file path.

Returns:

a File instance.

deleteEmptyDirs

public static void deleteEmptyDirs(File dir)

Delete empty directories in the argument dir recursively. If the argument dir is empty at the end of the operation it gets deleted too.

Parameters:

dir - a directory.

Since:

7.0