FileFunctions

java.lang.Object
- org.vishia.util.FileFunctions

Direct Known Subclasses:

FileSystem
```
public class FileFunctions
extends java.lang.Object
```
This class contains some static file and command line functions. It is also a replacement for FileSystem.java This class supports some functions of file system access as enhancement of the class java.io.File independently of other classes of vishia packages, only based on Java standard. Some methods helps a simple using of functionality for standard cases.

Note that the Java-7-Version supplies particular adequate functionalities in its java.nio.file package. This functionality is not used here. This package was created before Java-7 was established.

Exception philosophy: The java.io.file classes use the exception concept explicitly. Thats right if an exception is not the normal case. But it is less practicable if the throwing of the exception is an answer of an expected situation which should be though tested in any case.

Some methods of this class doesn't throw an exception if the success can be checked with a simple comparison and it should be inquired in usual cases. For example getDirectory(File) returns the directory or null if the input file is not existing. It does not throw a FileNotFoundException. The result is expected, the user can do a null-check easily.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FileFunctions.AddFileToList`
`static class`	`FileFunctions.FileAndBasePath` This class holds a File with its Basepath.
`private static class`	`FileFunctions.FilesWithBasePath` Temporary class used only inside `addFilesWithBasePath(java.io.File, java.lang.String, java.util.List<org.vishia.util.FileFunctions.FileAndBasePath>)`.
`private static class`	`FileFunctions.ListWrapper` This class supports the call of `addFileToList(String, List)`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String sVersion
Version, history and license.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`sVersion` Version, history and license.

Constructor Summary

Constructors
Constructor and Description

FileFunctions()

Constructors
Constructor and Description
`FileFunctions()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.String`	`absolutePath(java.lang.String sFilePath, java.io.File currDir)` Converts to the absolute and normalized path if a relative path or HOME path is given.
`static boolean`	`addFilesWithBasePath(java.io.File baseDir, java.lang.String sPathArg, java.util.List<FileFunctions.FileAndBasePath> list)` Fills the list with found files to sPath.
`private static boolean`	`addFileToList(FileFunctions.AddFileToList listFiles, java.io.File dir, java.lang.String sPath, int posWildcard, java.io.FilenameFilter filterName, java.io.FilenameFilter filterAlldir, int recursivect)` Executes adding file to the given list.
`static boolean`	`addFileToList(java.io.File dir, java.lang.String sPath, FileFunctions.AddFileToList listFiles)` Add files
`static boolean`	`addFileToList(java.io.File dir, java.lang.String sPath, java.util.List<java.io.File> listFiles)` Add files.
`static boolean`	`addFileToList(java.lang.String sPath, FileFunctions.AddFileToList listFiles)` Adds Files with the wildcard-path to a given list.
`static boolean`	`addFileToList(java.lang.String sPath, java.util.List<java.io.File> listFiles)` Adds Files with the wildcard-path to a given list.
`private static java.io.File`	`buildDir(java.io.File dirParent, java.lang.String sPath, int posFile)` Builds a File which is a directory of
`static int`	`checkNewless(java.io.File src, java.io.File dst, boolean removeDstIfOlder)` Checks whether a file is newer as the other, maybe delete dst.
`static java.lang.String`	`cleanAbsolutePath(java.lang.String inp)` Cleans ".." and "." from an absolute path.
`static boolean`	`cleandir(java.io.File dir_file)` Removes all files inside the directory and all sub directories with its files.
`static boolean`	`cleandirForced(java.io.File dir_file)` Removes all files inside the directory and all sub directories with its files.
`static boolean`	`close(java.io.Closeable file)` Close operation without exception.
`static boolean`	`copyDir(java.io.File src, java.io.File dst)` Removes all files inside the directory and all sub directories with its files.
`static int`	`copyFile(java.io.File src, java.io.File dst)` Copy a file.
`static int`	`copyFile(java.io.File src, java.io.File dst, boolean bKeepTimestamp, boolean bOverwrite, boolean bOverwriteReadonly)` Copy a file.
`static boolean`	`delete(java.lang.String path)`
`static boolean`	`exists(java.io.File file)` Returns true if the given file exists.
`static java.lang.String`	`getCanonicalPath(java.io.File file)` Gets the canonical path of a file without exception and with unique slashes.
`static java.io.File`	`getDir(java.io.File file)` Returns the directory of the given file.
`static java.lang.CharSequence`	`getDirCharseq(java.io.File file, java.io.File currdir)` Returns the directory of the given file in CharSequence format with canonical path.
`static java.io.File`	`getDirectory(java.io.File file)` Returns the directory of the given file.
`static java.io.File`	`getDirOld(java.io.File file)`
`static java.io.File[]`	`getFiles(java.io.File dir, java.lang.CharSequence nameWithWildcard)` Returns all matching files of the directory.
`static java.io.File`	`getFirstFileWildcard(java.io.File file)` Returns the first file with the matching name in the given directory.
`static java.lang.String`	`grep1line(java.io.File file, java.lang.String what)` Searches the first line with given text in 1 file, returns the line or null.
`static boolean`	`isAbsolutePath(java.lang.CharSequence filePath)` Returns true if the String which describes a file path is recognized as an absolute path.
`static boolean`	`isAbsolutePathOrDrive(java.lang.CharSequence filePath)` Returns true if the String which describes a file path is recognized as an absolute path or as a path with drive letter which may be relative on the drive.
`static boolean`	`isRoot(java.lang.CharSequence sName)`
`static boolean`	`isRoot(java.io.File file)` Returns true if this file describes a root directory.
`static boolean`	`isSymbolicLink(java.io.File file)` Returns true if the file is symbolic linked.
`static java.io.File`	`mkDir(java.io.File dir)` checks if the directory path exists or execute mkdir for all not existing directory levels.
`static void`	`mkDirPath(java.io.File file)` checks if a path exists or execute mkdir for all not existing directory levels.
`static java.io.File`	`mkDirPath(java.lang.String sPath)` checks if a path exists or execute mkdir for all not existing directory levels.
`static java.io.File`	`newFile(java.lang.String sPath)` Creates a File object from a given Path.
`static java.lang.CharSequence`	`normalizePath(java.lang.CharSequence inp)` Cleans any /../ and /./ from a path, it makes it normalized.
`static java.lang.CharSequence`	`normalizePath(java.io.File file)` Returns the normalized absolute path from a file.
`static byte[]`	`readBinFile(java.io.File file)` Reads the content of a whole file into a byte array.
`static int`	`readBinFile(java.io.File file, byte[] buffer)` Reads the content of a file into a byte array.
`static java.lang.String`	`readFile(java.io.File file)` Reads the content of a whole file into a String.
`static java.lang.String`	`readFile(java.io.File file, java.lang.Appendable dst, int[] zdst)` Reads the content of a whole file into a Appendable dst.
`static java.lang.CharSequence`	`readInJar(java.lang.Class clazz, java.lang.String pathInJar, java.lang.String encoding)` Read a file ('Resource') located in a jar file or inside the compiled class files.
`static java.lang.String`	`relativatePath(java.lang.String sInput, java.lang.String sRefPath)` Builds a relative path from a given directory, from an input path and the reference directory.
`static boolean`	`renameCreate(java.io.File dir, java.lang.String src, java.lang.String dst, boolean bException)` Renames from src or creates the dst file.
`static boolean`	`rmdir(java.io.File dir)` Removes all files inside the directory and all sub directories with its files.
`static java.io.File`	`searchFileInParent(java.io.File start, java.lang.String... pattern)` Searches a file given with local path in this directory and in all parent directories.
`static java.lang.String[]`	`searchInFiles(java.util.List<java.io.File> files, java.lang.String what, java.lang.Appendable searchOutput)` This is equal the usual grep, but with given files.
`static java.io.File`	`searchInParent(java.io.File start, java.lang.String... path)` Deprecated. not currently tested, use `searchFileInParent(File, String...)` for simple files with wildcard-mask.
`static java.lang.CharSequence[]`	`separateDirName(java.lang.CharSequence sPath)` Separates dir and name from a given path
`static boolean`	`setCurrdirFromFile(java.lang.String file)` Sets the current dir from the stored String in a file.
`private static void`	`stop()`
`static int`	`writeBinFile(java.io.File file, byte[] buffer)` Writes the content of a whole file from a byte array.
`static boolean`	`writeFile(java.lang.String content, java.io.File file)` Writes the given String as content to a file without exception throwing.
`static boolean`	`writeFile(java.lang.String content, java.lang.String sFile)` Writes the given String as content to a file without exception throwing.

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

Field Detail
- sVersion
```
public static final java.lang.String sVersion
```
  Version, history and license. Changes:
  - 2023-03-15 Hartmut bugfix addFilesWithBasePath(File, String, List) used in JZtxtcmdFileset: If the basepath is given with 'basepath/:' or especially './:' then this should be admissible. Without fix, the first character of local path was missing. It was obviously in Header2Reflection generation.
  - 2023-03-15 Hartmut enhancements on absolutePath(String, File).
  - 2023-01-25 Hartmut new WildcardFilter now in test, was never used before.
  - 2022-01-18 Hartmut new newFile(String) regards System.getProperty("user.dir") set by change dir in JZtxtcmd. should be used overall instead new File(String).
  - 2022-01-18 Hartmut enhancement: absolutePath(String, File) now resolves also environment variables in the path.
  - 2022-01-01 Hartmut bugfix: getDir(File) was not proper in special cases. Hence it is refactored and tested. Additional getDirCharseq(File, File) is created newly which returns an unique path.
  - 2021-06-28 Hartmut feature absolutePath(String, File) accepts "/tmp/..." and look for an environment variable TMP or TEMP. It is important also for shell scripts in windows. In the shell script /tmp/ may be known, but not in the windows file system.
  - 2021-06-28 Hartmut bugfix addFilesWithBasePath(File, String, List) with given directory
  - 2021-06-28 Hartmut new feature: normalizePath(CharSequence) regareds ':'
  - 2021-06-21 Hartmut new renameCreate(File, String, String, boolean), new mkDir(File)
  - 2020-06-08 Hartmut Move from FileSystem to this class, FileSystem is used in FileSystem too. Prevent name clash.
  - 2020-03-20 Hartmut new absolutePath(String, File) refactored, some problems on Zip with jar.
  - 2020-03-05 Hartmut new readFile(File, Appendable, int[]) into a buffer.
  - 2020-02-11 Hartmut new: #searchFileInParent(File, String...)) used for git GUI to search the .git or *.gitRepository from an inner file in the working area.
  - 2019-12-06 Hartmut new: readInJar(Class, String, String) as simple read possibility of a text file.
  - 2017-09-09 Hartmut new: cleandirForced(File), copyDir(File, File)
  - 2016-01-17 Hartmut new: getFirstFileWildcard(File)
  - 2015-09-06 JcHartmut chg: instead inner class WildcardFilter the new FilepathFilter used.
  - 2015-05-25 new copyFile(File, File, boolean, boolean, boolean)
  - 2015-05-04 bugfix close in readFile(File)
  - 2015-05-03 new searchInParent(File, String...)
  - 2014-09-05 Hartmut bugfix: searchInFiles(List, String, Appendable) missing close().
  - 2014-08-01 Hartmut bugfix in grep1line(File, String): Should close the file. Nobody does it elsewhere.
  - 2014-06-03 Hartmut bugfix in normalizePath(CharSequence): it has not deleted path/folder/folder/../../ because faulty following start search position.
  - 2014-05-10 Hartmut new: delete(String)
  - 2013-10-27 Hartmut chg: normalizePath(CharSequence) now uses a given StringBuilder to adjust the path inside itself. normalizePath(myStringBuilder) does not need the return value. But normalizePath(myStringBuilder.toString()) normalizes in a new StringBuilder. Rule: A CharSequence can't be seen as persistent. Only a String as CharSequence is persistent.
  - 2013-08-29 Hartmut bugfix: normalizePath(CharSequence), isAbsolutePath(CharSequence)
  - 2013-06-27 Hartmut new: close(Closeable)
  - 2013-05-04 Hartmut chg: normalizePath(CharSequence) uses and returns a CharSequence yet.
  - 2013-03-31 Hartmut bugfix: addFileToList(AddFileToList, File, String, int, FilenameFilter, FilenameFilter, int) had gotten the content of path/** /sub twice.
  - 2013-03-29 Hartmut new: cleandir(File)
  - 2013-02-13 Hartmut chg: addFileToList(String, AddFileToList) new better algorithm
  - 2013-02-03 Hartmut chg: the addFileToList(String, AddFileToList) does not throw a FileNotFoundException instead it returns false. All try-catch Blocks of a user calling environment may be changed to catch(Exception e) instead of catch(FileNotFoundException e) as simple work arround.
  - 2013-02-03 Hartmut new: #normalizePath(String)
  - 2013-02-03 Hartmut chg: addFilesWithBasePath(File, String, List) improved
  - 2013-01-20 Hartmut bugfix: addFilesWithBasePath(File, String, List):If a /../ is used in the path, it was faulty. Usage of canonicalpath instead absolute path. addFileToList(File, String, AddFileToList): Sometimes dir not regarded.
  - 2013-01-12 Hartmut new: Method checkNewless(src, dst, deleteIt)
  - 2012-12-30 Hartmut chg: addFilesWithBasePath(File, String, List) now gets a base directory.
  - 2012-12-25 Hartmut chg: mkDirPath(String) now returns the directory which is designated by the argument and checks whether it is a directory, not a file. It is more stronger, elsewhere compatible.
  - 2012-08-12 Hartmut chg: addFileToList(File, String, List) some changes to support zipfiles.
  - 2012-01-26 Hartmut new: isSymbolicLink(File) and cleanAbsolutePath(String).
  - 2012-01-05 Hartmut new: rmdir(File)
  - 2011-08-13 Hartmut chg: #addFilesWithBasePath(String, List) now stores the localPath with '/' instead backslash on windows too. Strategy: Use slash generally in Java-applications. Only a java.lang.File instance can contain backslash, because it is gotten from basic file routines such as File.listFiles() called in addFileToList(..). TODO use File.list() instead File.listFiles() and build the File-instance after replace('/', '\\'). The advantage of only have slash: The user should not be search to both backslash and slash while evaluating a file path. In Java a path with slash works proper any time. Only if a line for execution of the windows operation systems command shell is generated, all slash have to be converted to backslash lastly. See change 2011-06-22 of this file: getCanonicalPath(File) returns slash in operation system MS-Windows too.
  - 2011-07-10 Hartmut new: absolutePath(String, File). The requirement was: Usage of "~/path" to select in the users home in linux.
  - 2011-06-22 getCanonicalPath(File) returns slash in operation system MS-Windows too.
  - 2011-07-10 Hartmut
  - 2009-12-29 Hartmut bugfix: addFilesWithBasePath(...): If the sPath contains a ':' on second pos (Windows Drive), than the method hadn't accepted a ':' inside, fixed.
  - 2009-12-29 Hartmut bugfix: mkDirPath(...): not it accepts '\' too (Windows)
  - 2009-12-29 Hartmut corr: addFileToList(...): uses now currentDir, if param dir== null.
  - 2009-12-29 Hartmut new: method relativatePath(String sInput, String sRefDir)
  - 2009-05-06 Hartmut new: writeFile(content, file);
  - 2009-05-06 Hartmut bugfix: addFileToList(): A directory was also added like a file if wildcards are used. It is false, now filtered file.isFile().
  - 2009-03-24 Hartmut new: isAbsolutePathOrDrive()
  - 2008-04-02 Hartmut corr: some changes
  - 2007-10-15 Hartmut: creation
  - 2007 Hartmut: created
  Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means: You can use this source without any restriction for any desired purpose. You can redistribute copies of this source to everybody. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file. If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.
  See Also: Constant Field Values







Constructor Detail





FileFunctions
public FileFunctions()









Method Detail





addFilesWithBasePath
public static boolean addFilesWithBasePath(java.io.File baseDir,
                                           java.lang.String sPathArg,
                                           java.util.List<FileFunctions.FileAndBasePath> list)
Fills the list with found files to sPath.
 
 The complex example:  addFilesWithBasePath("..\\example/dir:localdir/ ** /*.h", list);
 
 fills ../example/dir/ in all elements basePath of list,
 and fills all files with mask *.h from localdir and all sub folders,
 with the local name part starting with localdir/... 
 in all elements localPath.

Parameters:
baseDir - A base directoy which is the base of sPath, or which is the current directory to resolve relative
        to absolute paths. It can be null, then sPath should describe a valid 
        file path, if relative then starting from the system's current directory new File(".").getAbsolutePath).
sPathArg - may contain a : on position >2 instead of / 
        to separate the base path from a local path (@since 2012, old feature).
        
If a ':' is not found, the last `/`or `\\` before the first '*' separates the base from the local path.
        
A ':' on second position is not recognized as path separation, it is usual the drive separator in windows
            on absolute paths.  
        The sPath may contain backslashes for windows using, it will be converted to slash.
list - The list to fill in files with the basepath. 
        The basepath is "" if no basepath is given in sPath.
Returns:
false if no file is found.
Throws:
java.io.FileNotFoundException
Since:
2019, this operation calls the old addFileToList(File, String, AddFileToList)
   but the intension was using an own algorithm with Files.walk(java.nio.file.Path, java.nio.file.FileVisitOption...).
   later todo.








setCurrdirFromFile
public static boolean setCurrdirFromFile(java.lang.String file)
Sets the current dir from the stored String in a file.
 This is a variant to change the current dir for example for tests using a file on a known position.
 

 To build such a file a script should be start in the current working dir or "Sandbox",
 which is named for example +setWDtoTmp.bat or +setWDtoTmp.sh

Parameters:
file - The file path can contain $(ENV) which will be expanded.
Returns:
true if the currdir is detect as directory, and System.setProperty(String, String)
   is executed with setProperty("user.dir", ... file content...)
 Check outside whether the currdir is correct.








newFile
public static java.io.File newFile(java.lang.String sPath)
                            throws java.io.FileNotFoundException
Creates a File object from a given Path.
 The difference to a simple standard new File(sPath) is:
 

 If the sPath is relative, it uses the System.getProperty("user.dir")
 as base directory, and not the given operation system's current directory.
 The first one can be changed with Java capabilities before, the last one cannot be changed inside the JRE.

Parameters:
sPath - relative or absolute path maybe with environment variables or starts with "/tmp/", see absolutePath(String, File)
Returns:
File object.
Throws:
java.io.FileNotFoundException - if the sPath is faulty
Since:
2023-09-21 recognizes also environment variables in sPath, creates necessary directory levels








readFile
public static java.lang.String readFile(java.io.File file)
Reads the content of a whole file into a String.
 This method returns a null pointer if an exception has occurs internally,
 it throws never an Exception itself.

Parameters:
file - The file should be exist, but don't need to exist.
Returns:
null means, there is nothing to read. Otherwise the string contains the content of the file.








readFile
public static java.lang.String readFile(java.io.File file,
                                        java.lang.Appendable dst,
                                        int[] zdst)
Reads the content of a whole file into a Appendable dst.
 This method returns false if an exception has occurs internally,
 it throws never an Exception itself.

Parameters:
file - The file should be exist, but don't need to exist.
dst - any appendable, may be an opened other file too, for copy
Returns:
null means, all ok. Any String with an exception text. 
           On file not found null is returned any zDst is not incremented.
           It means, there is nothing to read. Otherwise the string contains the content of the file.








readInJar
public static java.lang.CharSequence readInJar(java.lang.Class clazz,
                                               java.lang.String pathInJar,
                                               java.lang.String encoding)
Read a file ('Resource') located in a jar file or inside the compiled class files.

Parameters:
clazz - The path starts in the package where this class is located and uses the ClassLoader of this class.
pathInJar - relative to the class.
   Use "filename.ext" if the file is in the same package as the clazz.
   Use "../package/filename.ext" if the file is in another parallel package.
   Note: The file is searched in the bin tree of class files on using in Eclipse IDE
encoding - use usually "UTF-8" or "US-ASCII" or "ISO-8859-1" for byte-coded content
   or "UTF-16BE"
Returns:
null on error, throws never. Usual an error is a programmatically error not a user's failure.
   Else the return value is a StringBuilder which may be able to change, but it should be used readonly only.
   Use toString() to keep it persistent.








writeFile
public static boolean writeFile(java.lang.String content,
                                java.lang.String sFile)
Writes the given String as content to a file without exception throwing.
 This method doesn't throws an exception but returns true of false. It may more simple in application.

Parameters:
content - any textual information
sFile - The path of the file.
Returns:
true if done, false if there was any exception internally.








writeFile
public static boolean writeFile(java.lang.String content,
                                java.io.File file)
Writes the given String as content to a file without exception throwing.
 This method doesn't throws an exception but returns true of false. It may more simple in application.

Parameters:
content - any textual information
sFile - The file.
Returns:
true if done, false if there was any exception internally.








readBinFile
public static byte[] readBinFile(java.io.File file)
Reads the content of a whole file into a byte array.
 This method supplies a null pointer if a exception has occurs internally,
 it throws never an Exception itself.

Parameters:
file - The file should be exist, but don't need to exist.
Returns:
null means, there is nothing to read. Otherwise the byte[] contains the content of the file.








readBinFile
public static int readBinFile(java.io.File file,
                              byte[] buffer)
Reads the content of a file into a byte array. Only the first bytes are read from the file if the buffer is lesser than the file.
 This can be used especially to check the head data of a file. The file is opened as FileInputStream, read and closed again.

Parameters:
file - The file should be exist, but don't need to exist.
Returns:
nrofBytes read , see java.io.InputStream.read(byte[]). 0 if the file is not existing or any error occurs (especially file is locked).








writeBinFile
public static int writeBinFile(java.io.File file,
                               byte[] buffer)
Writes the content of a whole file from a byte array.

Parameters:
file - The file should be exist, but don't need to exist.
Returns:
nrofBytes written , see java.io.OutputStream.write(byte[])








copyFile
public static int copyFile(java.io.File src,
                           java.io.File dst)
                    throws java.io.IOException
Copy a file. The time-stamp and read-only-properties will be kept for dst.

Parameters:
src - A src file.
dst - The dst directory should be exist. Use mkDirPath(String) with this dst to create it.
Returns:
Number of bytes copied. -1 if src file not found. 0 if the src file is empty.
Throws:
java.io.IOException - Any error. but not if the src file not found.








copyFile
public static int copyFile(java.io.File src,
                           java.io.File dst,
                           boolean bKeepTimestamp,
                           boolean bOverwrite,
                           boolean bOverwriteReadonly)
                    throws java.io.IOException
Copy a file. The read-only-properties will be kept for dst.
 If a dst file exists it will be overwritten. This is done also if the dst file may be read only.

Parameters:
src - A src file.
dst - The dst directory should be exist. Use mkDirPath(String) with this dst to create it.
bKeepTimestamp - true then sets the time stamp of the dst to the time stamp of the src.
bOverwrite - if true then overwrite an existing file. If false exception on existing file.
bOverwriteReadonly - if true then overwrite a read-only file if necessary.
   If false exception on trying overwrite a read-only file.
Returns:
Number of bytes copied. -1 if src file not found. 0 if the src file is empty.
Throws:
java.io.IOException - Any error. but not if the src file not found.
java.lang.IllegalArgumentException - if the dst cannot be overwritten.








mkDirPath
public static void mkDirPath(java.io.File file)
                      throws java.io.FileNotFoundException
checks if a path exists or execute mkdir for all not existing directory levels.
  If the file should be a directory but it doesn't exists, the parent directory is created.
  That is because it is not able to detect whether a non-existing directory path is a directory.
  Use mkDirPath(String) with "/" on end to create a directory.

Parameters:
file - Either any file or any directory with given path.
Throws:
java.io.IOException - If the path is not makeable.
java.io.FileNotFoundException








mkDirPath
public static java.io.File mkDirPath(java.lang.String sPath)
                              throws java.io.FileNotFoundException
checks if a path exists or execute mkdir for all not existing directory levels.

Parameters:
sPath - The path to a file or directory if it ends with "/" or "\". 
        It means, a file name on end will ignored. It makes the directory for the file. 
        The used path to a directory is all before the last / or backslash.
Returns:
the directory of the path.
Throws:
java.io.FileNotFoundException - If the path exists and it is a file or if it is not able to create.








mkDir
public static java.io.File mkDir(java.io.File dir)
                          throws java.io.FileNotFoundException
checks if the directory path exists or execute mkdir for all not existing directory levels.

Parameters:
sPath - The path to a directory.
Returns:
the File instance of this directory.
Throws:
java.io.FileNotFoundException - If the path exists and it is a file or if it is not able to create.








delete
public static boolean delete(java.lang.String path)







rmdir
public static boolean rmdir(java.io.File dir)
Removes all files inside the directory and all sub directories with its files.
 Then remove the dir itself.

Parameters:
dir - A directory or a file inside the directory
Returns:
true if all files are deleted. If false then the deletion process was aborted.








cleandir
public static boolean cleandir(java.io.File dir_file)
Removes all files inside the directory and all sub directories with its files.
 The dir itself will be remain.

Parameters:
dir_file - A directory or any file inside the directory.
Returns:
true if all files are deleted. If false then the deletion process was aborted.








cleandirForced
public static boolean cleandirForced(java.io.File dir_file)
Removes all files inside the directory and all sub directories with its files.
 The dir itself will be remain.
 If files or directories inside cannot be deleted, they will be remain 
 but the other files or directories will be tried to delete nevertherless.
 It is in opposite to cleandir(File), the last one aborts if one file cannot delete.

Parameters:
dir_file - A directory or any file inside the directory.
Returns:
true if all files are deleted. If false then at least one file or directory cannot delete.








copyDir
public static boolean copyDir(java.io.File src,
                              java.io.File dst)
Removes all files inside the directory and all sub directories with its files.
 The dir itself will be remain.
 If files or directories inside cannot be deleted, they will be remain 
 but the other files or directories will be tried to delete nevertherless.
 It is in opposite to cleandir(File), the last one aborts if one file cannot delete.

Parameters:
dir_file - A directory or any file inside the directory.
Returns:
true if all files are deleted. If false then at least one file or directory cannot delete.








getDirectory
public static java.io.File getDirectory(java.io.File file)
                                 throws java.io.FileNotFoundException
Returns the directory of the given file.
 Note that the File.getParentFile() does not return the directory if the File is described as a relative path
 which does not contain a directory. This method builds the absolute path of the input file and returns its directory.

Parameters:
file - 
Returns:
null if the file is the root directory. 
   To distinguish whether the file is not exist or it is the root directory one can check file.exist().  
 throws FileNotFoundException if the file is not existing and therefore the directory of it is not able to build.
Throws:
java.io.FileNotFoundException








getFiles
public static java.io.File[] getFiles(java.io.File dir,
                                      java.lang.CharSequence nameWithWildcard)
Returns all matching files of the directory. Adequate java.io.File-listFiles but builds a filter internally.

Parameters:
dir - 
nameWithWildcard - Can have up to 2 '*' as wildcards
Returns:








getFirstFileWildcard
public static java.io.File getFirstFileWildcard(java.io.File file)
Returns the first file with the matching name in the given directory.
 A file may start with a defined name but the rest of name may be unknown, for example designated with a time stamp.
 If only one proper file exists, this is unique. Elsewhere the first exemplar of a matching file may be usefully.

Parameters:
dir - 
nameWithWildcard - Can have up to 2 '*' as wildcards
Returns:








getDirCharseq
public static java.lang.CharSequence getDirCharseq(java.io.File file,
                                                   java.io.File currdir)
Returns the directory of the given file in CharSequence format with canonical path.
 Note that the File.getParentFile() does not return the directory 
 if the File is described as a relative path which does not contain a directory. 
 Note furthermore that  File.getParentFile() does return the formally parent only in the String,
 it is not the real parent if the path is for examle "D:\My\path\.".
 
 This method builds firstly the normalized path of the input file and returns its directory if it contains a slash.
   It means it returns formally the part before slash of the normalized form, independent whether the directory exists or not
   and independent of a current directory. 
 
If the path of the input file does not contain a directory entry in the normalized form,
   then the absolute path is built calling absolutePath(String, File), 
   maybe with the given current directory. Then also the returned directory it absolute. 
 

Parameters:
file - any file or directory.
any - given current directory as base for the absolute path
        or null, then the system's currdir is used, see absolutePath(String, File)
Returns:
Always a result independent whether the file describes an existing path.








getDir
public static java.io.File getDir(java.io.File file)
Returns the directory of the given file.
 Note that the File.getParentFile() does not return the directory 
 if the File is described as a relative path which does not contain a directory. 
 Note furthermore that  File.getParentFile() does return the formally parent only in the String,
 it is not the real parent if the path is for examle "D:\My\path\.".
 This method builds the absolute and normalized path of the input file and returns its directory.

Parameters:
file - any file or directory, should exist.
Returns:
A File proper for the operation system, but it may not be existing. 
   It calls internally getDirCharseq(File, File) and built a new File(...) with the result.








getDirOld
public static java.io.File getDirOld(java.io.File file)







isAbsolutePath
public static boolean isAbsolutePath(java.lang.CharSequence filePath)
Returns true if the String which describes a file path is recognized as an absolute path.
 The conditions to recognize as absolute path are:
 
 Start with slash or backslash
 
Contains a ':' as second char following by '/' or '\'. 
   In this case on windows it is another drive as absolute path.
 

Parameters:
filePath - 
Returns:
true if it is such an absolute path








isAbsolutePathOrDrive
public static boolean isAbsolutePathOrDrive(java.lang.CharSequence filePath)
Returns true if the String which describes a file path is recognized as an absolute path or as a path with drive letter
 which may be relative on the drive.
 The conditions to recognize as absolute path are:
 
 Start with slash or backslash
 
Contains a ':' as second char. In this case on windows it is another drive.
   the path should be used as absolute path mostly, because 
   the current directory or any other base directory couldn't be applied.
 

Parameters:
filePath - 
Returns:








getCanonicalPath
public static java.lang.String getCanonicalPath(java.io.File file)
Gets the canonical path of a file without exception and with unique slashes. 
 See java.io.File.getCanonicalPath(). It does the same, but:
 The separator between directory names is the slash / in windows too!
 It helps to work with unique designation of paths. 
 The original java.io.File.getCanonicalPath() produces a backslash in windows systems.
 On Unix systems the canonical path resolves symbolic links. 
 


 To normalize a path use normalizePath(CharSequence) or normalizePath(File).

Parameters:
file - The given file
Returns:
null if the canonical path isn't available, for example if the path to the file doesn't exists.








relativatePath
public static java.lang.String relativatePath(java.lang.String sInput,
                                              java.lang.String sRefPath)
Builds a relative path from a given directory, from an input path and the reference directory.
 The input path and the reference directory may be relative paths both, than both have to start 
 on the same point in the file tree. If there are absolute paths, it have to start with the same drive letter (Windows).
 


 Examples:
 
 
Parameters:
sInput - The given file path.
sRefPath - Reference from where the return value is built relative. 
        A file-name of this reference file isn't relevant. 
        If only the directory should be given, a '/' on end have to be present.
        The reference directory may given with a relative path, 
        than it should be start at the same directory as the relative given sInput.
Returns:
The file path relative to the sRefFile-directory.




absolutePath
public static java.lang.String absolutePath(java.lang.String sFilePath,
                                            java.io.File currDir)
Converts to the absolute and normalized path if a relative path or HOME path is given.
 Since 2022-01: The filePath may contain environment variable written as 
 $$NAME$ or $(NAME) or $NAME where NAME is an identifier.
 

 The resulting path may start with
 
 "~/" - then the home dir is replaced. The home dir is the string 
     containing in the HOME environment variable, or if not found 
     in HOMEDRIVE/HOMEPATH especially for windows. 
     This style of notation is usable in Linux/Unix as also in Windows.
 
"/tmp/ - use the TMP directory for Linux and shell scripts in windows.
    Then TMP or TEMP is searched as environment variable on windows to replace "/tmp/"
    If TMP or TEMP is not found then keep /tmp/, proper for LINUX.
 
not starting with "/", "\\", "D:/", "D:\\" wherby D is any drive letter,
   then a given currDir is used as anchor to build the absolute path for the file.
   
The currDir can refer to an unknown File, it is not tested here.
   
If the currDir itself is relative, File.getAbsoluteFile() is called to use.
   
 it means you can use new File(".") to get the current dir of the cmd environment of the Java call.
   
currDir may be null, see next:
 
not starting with "/", "\\", "D:/", and currDir is null,
   then System.getProperty("user.dir") is used for the anchor of the given relative path.
   The difference to the current dir gotten with new File(".") is: 
   The System.setProperty("user.dir", xxx) can be changed in the application, 
   in this kind the current dir inside the application can be changed.
     
 The resulting path is cleaned using normalizePath(CharSequence).
 It means, it contains only "/", no "\\" and no artifacts of "/../" and "/./"

Parameters:
sFilePath - given path/to/file. It may contain "\\". "\\" are converted to "/" firstly.
currDir - The current dir or null. If null then a necessary current dir for a relative given path
   is gotten calling System.getProperty("user.dir")
Returns:
The path as absolute path. It is not tested whether it is a valid path. 
   The path contains always / instead \, also on windows.






normalizePath
public static java.lang.CharSequence normalizePath(java.io.File file)
Returns the normalized absolute path from a file. See normalizePath(CharSequence).
 This function builds the absolte path if the file is relative.

Parameters:
file - Any relative or absolute file.
Returns:
The returned CharSequence is a StringBuilder which is never referenced elsewhere
   or it is a String.






normalizePath
public static java.lang.CharSequence normalizePath(java.lang.CharSequence inp)
Cleans any /../ and /./ from a path, it makes it normalized.
 This operation does not build a absolute path. Too much ../ on start fails.
 Hint call it with an completed absolute path before or use instead 
 Moves a : (maybe used as separator between base and local path)
 to the correct position for such as path/dir/..:** follows.
 
  "path/dir/..:dir2/** /*" => "path:dir2/** /*", the "..:" means the parent, dir is irrelevant
 
 "path/dir/..:** /*" => "path:dir/** /*", the ":" is associated before dir, like above
     but the dir is part of the search path because it is mentioned as access. 
 

Parameters:
inp - Any path which may contain /./ or /../, with backslash or slash-separator.
   If the inp is instanceof StringBuilder, it is used directly for correction and returned in any case.
   Elsewhere a new StringBuilder will be created if necessary.
Returns:
The originally inp if inp doesn't contain /./ or /../ or backslash or inp is a Stringbuilder, 
   elsewhere a new StringBuilder which presents the normalized form of the path. 
   It does not contain backslash but slash as separator.
   It does not contain any "/./" or "//" or "/../". 
   It does contain "../" only at start if it is necessary for a relative given path.






cleanAbsolutePath
public static java.lang.String cleanAbsolutePath(java.lang.String inp)
Cleans ".." and "." from an absolute path.

Parameters:
inp - 
Returns:






separateDirName
public static java.lang.CharSequence[] separateDirName(java.lang.CharSequence sPath)
Separates dir and name from a given path

Parameters:
sPath - should be normalized, using '/', not \
Returns:
[0] is the directory string ends with "/" for root, else does not end with backslash 
         {1] is null if sPath ends with "/", else the last part from sPath, the child in dir






isSymbolicLink
public static boolean isSymbolicLink(java.io.File file)
Returns true if the file is symbolic linked. This works on Unix-like file systems.
 For windows it returns true if the cleaned absolute path is identical with the result of
 file.getCanonicalPath() whereby the comparison is done ignoring the lower/upper case of letters and with
 unique slashes instead backslash. It means that this test returns true always, so that
 this method returns false in all situations on windows.
 

 Implementation: The cleaned absolute path is compared with the canonical path. The absolute path is cleared
 from unnecessary ./ parts, see absolutePath(String, File). and cleanAbsolutePath(String).

Parameters:
file - The file to test.
Returns:






checkNewless
public static int checkNewless(java.io.File src,
                               java.io.File dst,
                               boolean removeDstIfOlder)
Checks whether a file is newer as the other, maybe delete dst.
 returns:
 
 -1 if src does not exists. Don't make.
 
0: if src is older than dst. Don't make.
 
1: if dst does not exists. Make.
 
2: if src is newer, dst is existent but should not deleted. removeDstIfOlder is given as false.
 
3: if src is newer, dst is deleted.
 
4: if src is newer, dst should be deleted but the deletion fails. There is a problem on dst.

Parameters:
src - 
dst - 
removeDstIfOlder - deletes the dst also if it may be write protected if the src is newer.
Returns:
-1..4






close
public static boolean close(java.io.Closeable file)
Close operation without exception.
 Note: A close is necessary though it might be worked well without close(). The file is closed and released
 by the operation system any time if an application is finished. It is a property of modern operation systems.
 But if the application runs still, a file may be blocked for access from other applications 
 if it was opened to read or write and not closed after them. It is also so in the case of
 not referenced file handle instances. Use the following pattern to work with files:
  
 Writer myWriter = null;
 try {
   myWriter = new FileWriter(...);  //opens
   ...
   myWriter.write(...)
   myWriter.close();     //closes
   myWriter = null;      //mark it closed in the reference.
 } catch(IOException exc) {
   ... do anything
   //NOTE: the myWriter may be closed or not, depending on the exception kind
 }
 if(myWriter !=null){ FileSystem.close(myWriter); }  //close it if it is remained opened because any exception.
   
 This method helps to close without extra effort of a second exception.
 The close() operation should be done outside and after the main exception for the file operation.
 


 The following pattern is erroneous because the file may remained opened and can't be close outside
 the routine:
  void antiPattern() throws IOException {
   myWriter = new FileWriter(...);  //opens
   ...
   myWriter.write(...)
   myWriter.close();     //closes
 }
 

Parameters:
file - any Closeable instance. If it is null, it is okay. Then no action is done.
Returns:
false if file.close() throws an exception.






addFileToList
public static boolean addFileToList(java.lang.String sPath,
                                    java.util.List<java.io.File> listFiles)
Adds Files with the wildcard-path to a given list.

Parameters:
sPath - path with wildcards in the filename.
listFiles - given list, the list will be extended.
Returns:
false if the deepst defined directory of a wildcard path does not exist.
   true if the search directory exists independent of the number of founded files.
   Note: The number of founded files can be query via the listFiles.size().






addFileToList
public static boolean addFileToList(java.lang.String sPath,
                                    FileFunctions.AddFileToList listFiles)
Adds Files with the wildcard-path to a given list.

Parameters:
sPath - path with wildcards in the filename.
listFiles - given list, the list will be extended.
Returns:
false if the deepst defined directory of a wildcard path does not exist.
   true if the search directory exists independent of the number of founded files.
   Note: The number of founded files can be query via the listFiles.size().






addFileToList
public static boolean addFileToList(java.io.File dir,
                                    java.lang.String sPath,
                                    java.util.List<java.io.File> listFiles)
Add files. It calls addFileToList(File, String, AddFileToList)
 with the wrapped listFiles.

Parameters:
dir - may be null, a directory as base for sPath.
sPath - path may contain wildcard for path and file.
listFiles - Container to get the files.
Returns:
false if the dir not exists or the deepst defined directory of a wildcard path does not exist.
   true if the search directory exists independent of the number of founded files.
   Note: The number of founded files can be query via the listFiles.size().






buildDir
private static java.io.File buildDir(java.io.File dirParent,
                                     java.lang.String sPath,
                                     int posFile)
Builds a File which is a directory of

Parameters:
dirParent - parent, maybe null then unused. If posFile==0 then the current directory is returned.
sPath - path from dirParent or as absolute or relative path.
posFile - the substring(0..posFile) of path is used.
   if 0 then sPath is ignored.
Returns:
The File object build from the input arguments. Whether the file exists or it is a directory
   is not tested here.






addFileToList
private static boolean addFileToList(FileFunctions.AddFileToList listFiles,
                                     java.io.File dir,
                                     java.lang.String sPath,
                                     int posWildcard,
                                     java.io.FilenameFilter filterName,
                                     java.io.FilenameFilter filterAlldir,
                                     int recursivect)
Executes adding file to the given list.
 First all directories are evaluated. This routine is called recursively for directories.
 After them the files in this directory are evaluated and listed.

Parameters:
listFiles - destination list
dir - base directory or null
sPath - can contain '/' but not '\'
posWildcard - first position of a '*' in the path
filterName - filter for the file names or null
filterAlldir - filter for directories or null
recursivect - counter for recursively call. If it is >1000 this routine is aborted to prevent
   too many recursions because any error.
Returns:






addFileToList
public static boolean addFileToList(java.io.File dir,
                                    java.lang.String sPath,
                                    FileFunctions.AddFileToList listFiles)
Add files

Parameters:
dir - may be null, a directory as base for sPath.
sPath - path may contain wildcard for path and file. May use backslash or slash.
listFiles - Container to get the files.
Returns:
false if the dir not exists or the deepst defined directory of a wildcard path does not exist.
   true if the search directory exists independent of the number of founded files.
   Note: The number of founded files can be query via the listFiles.size().






grep1line
public static java.lang.String grep1line(java.io.File file,
                                         java.lang.String what)
                                  throws java.io.IOException
Searches the first line with given text in 1 file, returns the line or null.

Parameters:
file - The file
what - content to search, a simple text, not an regular expression.
Returns:
null if nothing was found, elsewhere the line.
Throws:
java.io.IOException - File not found or any file read exception.






searchInFiles
public static java.lang.String[] searchInFiles(java.util.List<java.io.File> files,
                                               java.lang.String what,
                                               java.lang.Appendable searchOutput)
This is equal the usual grep, but with given files. TODO this method is not ready yet.

Parameters:
files - 
what - 
Returns:






searchInParent
@Deprecated
public static java.io.File searchInParent(java.io.File start,
                                                       java.lang.String... path)
Deprecated. not currently tested, use searchFileInParent(File, String...) for simple files with wildcard-mask.
Searches a file given with local path in this directory and in all parent directories.

Parameters:
start - any start file or directory. If it is a file (for example a current one), its directory is used.
path - May be more as one local path. Simple it is only one "filename.ext" or "anyDirectory". Possible "path/to/file.ext".
   More as one argument may be given, to search one of more given files.
Returns:
null if nothing found. Elsewhere the found file which matches to one of path in the start or one of the parent directories






searchFileInParent
public static java.io.File searchFileInParent(java.io.File start,
                                              java.lang.String... pattern)
Searches a file given with local path in this directory and in all parent directories.

Parameters:
start - any start file or directory. If it is a file (for example a current one), its directory is used.
path - May be more as one local path. Simple it is only one "filename.ext" or "anyDirectory". Possible "path/to/file.ext".
   More as one argument may be given, to search one of more given files.
Returns:
null if nothing found. Elsewhere the found file which matches to one of path in the start or one of the parent directories






stop
private static void stop()





renameCreate
public static boolean renameCreate(java.io.File dir,
                                   java.lang.String src,
                                   java.lang.String dst,
                                   boolean bException)
                            throws java.lang.Exception
Renames from src or creates the dst file.
 This routine is supposed especially if a signal file (a semaphore) should be set.
 For such approaches renaming of existing files is better, because it needs lesser effort on the file system:
 Only the directory entry is changed in its data, no extra space is used, if the src file exists.
 

 But this routine cleans up also: If src is given with '*' then it removes all existing file 
 except the first one found. The first one is renamed. 
 This situation can occur when another tool uses different approaches and the files are messed up.

Parameters:
dir - The directory. May be a absolute path or relative from the system's current directory.
            Hint: For JZtxtcmd usage it can be written: File: "path".
            Then the path is used from the JZtxtcmd internal current dir, not from the system's current dir.
src - Name of the file in this dir to rename. Need not be existing. If it contains a '*' only one found is renamed,
            all other found are deleted.
dst - Name of the dst file in this dir. It will be created if the src is not existing.
            The dst file is existing in any case if the routine returns true.
            If the src file is not given with * and the dst file exists already, nothing will be done.
            The src file is not delete then. Hint: Use * in the name of the src if existing files should be cleaned.
bException - true then an exception is thrown in any error case, false: only the return value inform about problems.
Returns:
true if the operation is successfull, false on any error.
Throws:
java.lang.Exception - only if bException is set. It is possible that the dir path is faulty, the dst contains faulty characters etc.






exists
public static boolean exists(java.io.File file)
Returns true if the given file exists. This method transscripts java.io.File.exists()
 to support simple usage for jbatch.

Parameters:
file - Any file
Returns:
true if this file exists.






isRoot
public static boolean isRoot(java.io.File file)
Returns true if this file describes a root directory.
 A root directory is either "/" or "D:/" whereby "D" is a drive letter in Windows.
 The file can be given as relativ path with ".."

Parameters:
file - Any file
Returns:
true if it is the root.






isRoot
public static boolean isRoot(java.lang.CharSequence sName)




Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method





 a/b/c/d  a/b      c/d If the sRefDirectory is within sInput, sInput will be shortened:  
 a/b/c/d  x/y      ../../a/b/c/d If the sRefDirectory is parallel to sInput, ../ will be added and sRefDirectory will be added:  
 a/b/c/d  a/x      ../b/c/d If the sRefDirectory is within sInput but parallel, ../ will be added and the rest of sInput will be shortened:

a/b/c/d	a/b	c/d	If the sRefDirectory is within sInput, sInput will be shortened:
a/b/c/d	x/y	../../a/b/c/d	If the sRefDirectory is parallel to sInput, ../ will be added and sRefDirectory will be added:
a/b/c/d	a/x	../b/c/d	If the sRefDirectory is within sInput but parallel, ../ will be added and the rest of sInput will be shortened:

Class FileFunctions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sVersion

Constructor Detail

FileFunctions

Method Detail

addFilesWithBasePath

setCurrdirFromFile

newFile

readFile

readFile

readInJar

writeFile

writeFile

readBinFile

readBinFile

writeBinFile

copyFile

copyFile

mkDirPath

mkDirPath

mkDir

delete

rmdir

cleandir

cleandirForced

copyDir

getDirectory

getFiles

getFirstFileWildcard

getDirCharseq

getDir

getDirOld

isAbsolutePath

isAbsolutePathOrDrive

getCanonicalPath

relativatePath

absolutePath

normalizePath

normalizePath

cleanAbsolutePath

separateDirName

isSymbolicLink

checkNewless

close

addFileToList

addFileToList

addFileToList

buildDir

addFileToList

addFileToList

grep1line

searchInFiles

searchInParent

searchFileInParent

stop

renameCreate

exists

isRoot

isRoot