FileUtils (Toolsverse API Reference 5.9)

Object
- com.toolsverse.util.FileUtils

```
public final class FileUtils
extends Object
```
The collection of the static methods for the file operations such as copy, delete, etc.

Since:

1.0

Version:

2.0

Field Summary

Fields
Modifier and Type Field and Description

static int BUFFER
The buffer.

Fields
Modifier and Type	Field and Description
`static int`	`BUFFER` The buffer.

Constructor Summary

Constructors
Constructor and Description

FileUtils()

Constructors
Constructor and Description
`FileUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addFilesToZip(String folder, String zipFileName, List<String> files, String... password)` Adds files to the zip.
`static void`	`addFilesToZip(String folder, String zipFileName, String fileName, String... password)` Adds files to the zip.
`static String`	`addLastSeparator(String path)` Adds the last separator.
`static String`	`changeExt(String fileName, String ext)` Change file extension.
`static String`	`changeFileName(String fileName, String name)` Change file name only.
`static void`	`copyFile(File in, File out)` Copies file.
`static void`	`copyFile(InputStream in, File out)` Copies input stream into the file.
`static void`	`copyFilesFromFolderToFolder(String source, String dest, String fName)` Copies files from the source folder to the destination.
`static void`	`createZipWithPassword(String zipFileName, ArrayList<File> filesToAdd, String passwd, String encyptionMethod)` Creates the zip with password.
`static boolean`	`deleteFile(String path)` Deletes file or folder.
`static boolean`	`deleteFile(String folder, String filename)` Deletes file in the folder.
`static void`	`deleteFilesInFolder(String folder, String fName)` Delete files in the folder.
`static void`	`downloadFile(String downloadUrl, String fileName)` Download file.
`static String`	`executeReplaceMacros(String sourceFileName, String fileName)` Execute replace macros.
`static boolean`	`fileExists(String filename)` Checks if file or folder exists.
`static boolean`	`fileExistsAndNotDir(String filename)` File exists and not dir.
`static String`	`getActualFolderName(String folder)` Gets the actual folder name.
`static byte[]`	`getBytesFromFile(File file)` Reads the binary file and returns array of bytes.
`static String`	`getCorrectFolder(String folder)` Cleanup the folder.
`static String`	`getFilename(String name, String folder, String ext, boolean forceExt)` Creates the full name of the file.
`static String`	`getFileName(String original, String prefix, String suffix, String ext, String extPrefix, String extSuffix)` Gets the file name.
`static String`	`getFileNameByWildcard(String sourceFileName, String pattern, String fileName, Set<String> alreadyCreated)` Gets the file name by wildcard.
`static String`	`getFileNameUsingAlgoForSuffix(String fileName, String algo)` Gets the file name with suffix using given suffix algorithm.
`static String`	`getFileNameWithExtFromOtherFilename(String filename, String filenameWithExt)` Gets the file name with extension from other filename.
`static String`	`getFilenameWithPath(String name, String folder, String ext, boolean forceExt)` Creates the full name of the file.
`static String`	`getFileNameWithSuffix(String fileName, String suffix)` Gets the file name with suffix.
`static List<File>`	`getFilesByPattern(String pattern, Comparator<File> comparator)` Gets the files by pattern and order the list using given comparator.
`static List<File>`	`getFilesByPatterns(String... patterns)` Gets the files by patterns.
`static File[]`	`getFilesInFolder(String folder, String fName)` Gets the files in the folder.
`static String`	`getFirstFolderName(String folder)` Gets the first folder name.
`static String`	`getFolderName(String folder, String separator)` Gets the folder name by replacing original separators on the separator argument.
`static String`	`getFullFileName(String folder, String name, String ext, boolean convert)` Gets the full file name.
`static String`	`getFullName(String url, String path, String file)` Gets the full name from url, path and file.
`static String`	`getNameWithoutPrefix(String name, String prefix)` Gets the name without prefix.
`static String`	`getNormalizedFilename(String folder, String fileName)` Gets the normalized filename.
`static String`	`getNormalizedFolderName(String folder)` Gets the normalized folder name.
`static String`	`getParentFolderName(String folder)` Gets the parent folder name.
`static TypedKeyValue<String,String>`	`getRootFolderAndTheRest(String folder)` Gets the root folder and the rest.
`static String`	`getTempFileName(String name)` Get the temporary file name using given base name (which could be null).
`static String`	`getTempFileNameInDataFolder(String name)` Gets the temp file name in the data folder.
`static String`	`getUnixFolderName(String folder)` Gets the folder name using Unix style separators.
`static String`	`getValidFileName(String fileName, boolean withExt)` Returns the valid file name.
`static void`	`gzipFile(String sourceFileName, String destFileName)` Gzip file.
`static Boolean`	`hasWildCard(String fileName)` Checks for wildcards or { or } in the file name.
`static void`	`hideFileOnWindows(String fileName)` Hides file on windows.
`static boolean`	`isFileNameValid(String file)` Checks if filename is valid.
`static boolean`	`isWildCard(String fileName)` Checks for wildcards in the file name.
`static String`	`loadTextFile(String fileName)` Loads text file into the string.
`static String`	`loadTextFile(String fileName, long maxSize)` Loads text file into the string.
`static String`	`loadTextFileFromResource(String resource)` Loads text file into the string.
`static String`	`merge(String fileToCreate, File... allFiles)` Merge files `allFiles` into the the single `fileToCreate`.
`static String`	`merge(String fileToCreate, String header, String footer, String... patterns)` Merge text files using given file pattern.
`static boolean`	`mkDir(String name)` Creates a folder.
`static Object`	`readObject(String fileName)` Reads java object from the file.
`static Object`	`readObject(String fileName, boolean decrypt)` Reads java object from the file.
`static Object`	`readObjectFromJson(String fileName)` Reads java object from the json file.
`static Object`	`readObjectFromJson(String fileName, boolean decrypt)` Reads java object from the json file.
`static Object`	`readObjectFromJson(String fileName, Key key)` Reads encrypted java object from the json file.
`static TypedKeyValue<String,Long>`	`readTextFile(String fileName, long maxSize)` Reads text file into the string.
`static TypedKeyValue<String,Long>`	`readTextFromStream(InputStream inputStream, long maxSize)` Reads input stream into the string.
`static String`	`removeLastSeparator(String path)` Removes the last separator.
`static String`	`removeWildCard(String name)` Removes the wild card from file name.
`static File`	`saveFile(ByteArrayOutputStream stream, String name)` Create file using given output stream and file name.
`static File`	`saveTempFile(ByteArrayOutputStream stream, String name)` Create file in the temporary folder using given stream and file name.
`static void`	`saveTextFile(String fileName, String text)` Saves the text file.
`static String`	`ungzipFile(String sourceFileName, String destFolder)` UnGzip file.
`static void`	`unzip(String zipFilePath, String destDirectory)` Extracts a zip file specified by the zipFilePath to a directory specified by destDirectory (will be created if does not exists).
`static boolean`	`unzip(String destFolder, String wildCard, boolean deleteZip, String... password)` Unzip files.
`static List<String>`	`unzipFiles(String destFolder, String zipFileName, String... password)` Unzip files into the folder.
`static List<String>`	`unZipFileWithCommons(String destFolder, String zipFileName, boolean isFlat, List<String> files)` Unzip file using commons-compress libary.
`static List<String>`	`unzipOrUnGzipFiles(boolean isUnGZip, boolean isFlat, String destFolder, String zipFileName, String... password)` Unzip or ungzip files into the folder.
`static List<String>`	`unzipOrUnGzipFiles(boolean isUnGZip, String destFolder, String zipFileName, String... password)` Unzip or ungzip files into the folder.
`static TypedKeyValue<String,String>`	`updateFolderAndFilename(String folder, String fileName)` Update folder and filename with path by removing path from the file name and adding it to the folder Examples: updateFolderAndFilename("c:\temp", "test.txt") --> c:\temp\ test.txt updateFolderAndFilename("c:\temp", "\abc\test.txt") --> c:\temp\abc test.txt updateFolderAndFilename(null, "\abc\test.txt") --> abc test.txt
`static void`	`writeObject(String fileName, Object object)` Writes Java object into the file.
`static void`	`writeObject(String fileName, Object object, boolean encrypt)` Writes Java object into the file.
`static void`	`writeObjectToJson(String fileName, Object object)` Writes Java object into the file in json format.
`static void`	`writeObjectToJson(String fileName, Object object, boolean encrypt)` Writes Java object into the file in json format.
`static void`	`writeObjectToJson(String fileName, Object object, Key key)` Writes Java object into the file in json format and encrypt the file.
`static boolean`	`zip(String zipFileName, boolean deleteFiles, String password, String encyptionMethod, String... wildCards)` Zip files.

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

- Field Detail
  - BUFFER
```
public static int BUFFER
```
    The buffer.
- Constructor Detail
  - FileUtils
```
public FileUtils()
```
- Method Detail
  - addFilesToZip
```
public static void addFilesToZip(String folder,
                                 String zipFileName,
                                 List<String> files,
                                 String... password)
                          throws Exception
```
    Adds files to the zip.
    
    Parameters:
    
    folder - the folder with the files
    
    zipFileName - the zip file name
    
    files - the list of the files to add. The file path is ignored, only name and extension combined with the folder argument are used
    
    password - the password
    
    Throws:
    
    Exception - is anything goes wrong
  - addFilesToZip
```
public static void addFilesToZip(String folder,
                                 String zipFileName,
                                 String fileName,
                                 String... password)
                          throws Exception
```
    Adds files to the zip.
    
    Parameters:
    
    folder - the folder with the files
    
    zipFileName - the zip file name
    
    fileName - the file name to add. Wildcards are allowed. The file path is ignored, only name and extension combined with the folder argument are used
    
    password - the password
    
    Throws:
    
    Exception - is anything goes wrong
  - changeExt
```
public static String changeExt(String fileName,
                               String ext)
```
    Change file extension.
```
 c:\abc\xyz.txt, new ext xml -- c:\abc\xyz.xml
 xyz.txt, new ext xml -- xyz.xml
 xyz, new ext xml -- xyz.xml
 
```
    Parameters:
    
    fileName - the file name
    
    ext - the new extension
    
    Returns:
    
    the new file name
  - changeFileName
```
public static String changeFileName(String fileName,
                                    String name)
```
    Change file name only.
```
 c:\abc\xyz.txt, new name mnm -- c:\abc\mnm.txt
 xyz, new name mnm -- mnm
 xyz.txt, new name mnm -- mnm.txt
 
```
    Parameters:
    
    fileName - the file name
    
    name - the new name
    
    Returns:
    
    the file name
  - copyFile
```
public static void copyFile(File in,
                            File out)
                     throws Exception
```
    Copies file.
    
    Parameters:
    
    in - the input file
    
    out - the output file
    
    Throws:
    
    Exception - is anything goes wrong
  - copyFile
```
public static void copyFile(InputStream in,
                            File out)
                     throws Exception
```
    Copies input stream into the file.
    
    Parameters:
    
    in - the input stream
    
    out - the output file
    
    Throws:
    
    Exception - in case of any error
  - copyFilesFromFolderToFolder
```
public static void copyFilesFromFolderToFolder(String source,
                                               String dest,
                                               String fName)
                                        throws Exception
```
    Copies files from the source folder to the destination.
    
    Parameters:
    
    source - the source folder name
    
    dest - the destination folder name
    
    fName - the file name. Wildcards are allowed
    
    Throws:
    
    Exception - in case of any error
  - createZipWithPassword
```
public static void createZipWithPassword(String zipFileName,
                                         ArrayList<File> filesToAdd,
                                         String passwd,
                                         String encyptionMethod)
                                  throws Exception
```
    Creates the zip with password.
    
    Parameters:
    
    zipFileName - the zip file name
    
    filesToAdd - the files to add
    
    passwd - the password
    
    encyptionMethod - the encyption method
    
    Throws:
    
    Exception - in case of any error
  - deleteFile
```
public static boolean deleteFile(String path)
```
    Deletes file or folder. If folder is not empty will delete all sub folders and files.
    
    Parameters:
    
    path - the full path to the file or folder
    
    Returns:
    
    true, if successful
  - deleteFile
```
public static boolean deleteFile(String folder,
                                 String filename)
```
    Deletes file in the folder.
    
    Parameters:
    
    folder - the folder name
    
    filename - the file name
    
    Returns:
    
    true, if successful
  - deleteFilesInFolder
```
public static void deleteFilesInFolder(String folder,
                                       String fName)
                                throws Exception
```
    Delete files in the folder.
    
    Parameters:
    
    folder - the folder name
    
    fName - the file name. Wild cards are allowed.
    
    Throws:
    
    Exception - in case of any error
  - downloadFile
```
public static void downloadFile(String downloadUrl,
                                String fileName)
                         throws Exception
```
    Download file.
    
    Parameters:
    
    downloadUrl - the download url
    
    fileName - the file name
    
    Throws:
    
    Exception - the exception
  - fileExists
```
public static boolean fileExists(String filename)
```
    Checks if file or folder exists.
    
    Parameters:
    
    filename - the file or folder name
    
    Returns:
    
    true, if file or folder exists
  - fileExistsAndNotDir
```
public static boolean fileExistsAndNotDir(String filename)
```
    File exists and not dir.
    
    Parameters:
    
    filename - the filename
    
    Returns:
    
    true, if successful
  - getBytesFromFile
```
public static byte[] getBytesFromFile(File file)
                               throws IOException
```
    Reads the binary file and returns array of bytes.
    
    Parameters:
    
    file - the full file name
    
    Returns:
    
    the array of bytes from the file
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - getFilename
```
public static String getFilename(String name,
                                 String folder,
                                 String ext,
                                 boolean forceExt)
```
    Creates the full name of the file.
    
    Examples:
    getFilename("c:temp\test.txt", null, null, false) --> c:\temp\test.txt
    getFilename("test.txt", "c:\abc", null, false) --> c:\abc\test.txt
    getFilename("test.txt", "c:\abc", "bak", true) --> c:\abc\test.bak
    
    Parameters:
    
    name - the original name of the file
    
    folder - the folder
    
    ext - the extension
    
    forceExt - if true the ext argument will used. Otherwise the original file extension is used.
    
    Returns:
    
    the filename
  - updateFolderAndFilename
```
public static TypedKeyValue<String,String> updateFolderAndFilename(String folder,
                                                                   String fileName)
```
    Update folder and filename with path by removing path from the file name and adding it to the folder
    
    Examples:
    updateFolderAndFilename("c:\temp", "test.txt") --> c:\temp\ test.txt
    updateFolderAndFilename("c:\temp", "\abc\test.txt") --> c:\temp\abc test.txt
    updateFolderAndFilename(null, "\abc\test.txt") --> abc test.txt
    
    Parameters:
    
    folder - the folder
    
    fileName - the file name
    
    Returns:
    
    the key is a new folder and the value is a new file name
  - getFilenameWithPath
```
public static String getFilenameWithPath(String name,
                                         String folder,
                                         String ext,
                                         boolean forceExt)
```
    Creates the full name of the file. If The name parameter can contains a folder it will be concatenated with the folder parameter
    
    Examples:
    getFilenameWithPath("c:temp\test.txt", null, null, false) --> c:\temp\test.txt
    getFilenameWithPath("test.txt", "c:\abc", null, false) --> c:\abc\test.txt
    getFilenameWithPath("test.txt", "c:\abc", "bak", true) --> c:\abc\test.bak
    getFilenameWithPath("\xyz\test.txt", "c:\abc", "bak", true) --> c:\abc\xyz\test.bak
    getFilenameWithPath("\xyz\test.txt", "", "bak", true) --> \xyz\test.bak
    
    Parameters:
    
    name - the original name of the file
    
    folder - the folder
    
    ext - the extension
    
    forceExt - if true the ext argument will used. Otherwise the original file extension is used.
    
    Returns:
    
    the filename
  - getFileName
```
public static String getFileName(String original,
                                 String prefix,
                                 String suffix,
                                 String ext,
                                 String extPrefix,
                                 String extSuffix)
```
    Gets the file name.
    
    Parameters:
    
    original - the original
    
    prefix - the prefix
    
    suffix - the suffix
    
    ext - the ext
    
    extPrefix - the ext prefix
    
    extSuffix - the ext suffix
    
    Returns:
    
    the file name
  - getFilesByPatterns
```
public static List<File> getFilesByPatterns(String... patterns)
```
    Gets the files by patterns.
    
    Parameters:
    
    patterns - the patterns
    
    Returns:
    
    the files
  - getFilesByPattern
```
public static List<File> getFilesByPattern(String pattern,
                                           Comparator<File> comparator)
```
    Gets the files by pattern and order the list using given comparator.
    
    Parameters:
    
    pattern - the pattern
    
    comparator - the comparator
    
    Returns:
    
    the ordered files
  - getFilesInFolder
```
public static File[] getFilesInFolder(String folder,
                                      String fName)
```
    Gets the files in the folder.
    
    Parameters:
    
    folder - the folder name
    
    fName - the file name. Wildcards are allowed
    
    Returns:
    
    the list of the files in the folder
  - getFolderName
```
public static String getFolderName(String folder,
                                   String separator)
```
    Gets the folder name by replacing original separators on the separator argument. Separator is either Unix style "/" or Windows style "\".
    
    Parameters:
    
    folder - the original folder
    
    separator - the separator
    
    Returns:
    
    the folder name
  - getFullFileName
```
public static String getFullFileName(String folder,
                                     String name,
                                     String ext,
                                     boolean convert)
```
    Gets the full file name.
    
    Examples:
    getFullFileName("c:\temp", "abc", ".txt", true) --> c:/temp/abc.txt
    getFullFileName("c:\temp", "abc", ".txt", false) --> c:\temp\abc.txt
    
    Parameters:
    
    folder - the folder name
    
    name - the name of the file
    
    ext - the extension of the file
    
    convert - if true converts all separators to the Unix style
    
    Returns:
    
    the full name
  - getFullName
```
public static String getFullName(String url,
                                 String path,
                                 String file)
```
    Gets the full name from url, path and file.
    
    Parameters:
    
    url - the url
    
    path - the path
    
    file - the file
    
    Returns:
    
    the full name
  - getTempFileName
```
public static String getTempFileName(String name)
```
    Get the temporary file name using given base name (which could be null).
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the temporary file name
  - getTempFileNameInDataFolder
```
public static String getTempFileNameInDataFolder(String name)
```
    Gets the temp file name in the data folder.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the temp file name in data folder
  - getUnixFolderName
```
public static String getUnixFolderName(String folder)
```
    Gets the folder name using Unix style separators. Removes extra whitespace.
    
    Examples:
    getUnixFolderName("c:\temp\abc") --> c:/temp/abc/
    getUnixFolderName("//usr//temp") --> //usr//temp/
    
    Parameters:
    
    folder - the original folder name
    
    Returns:
    
    the folder name with Unix style separators
  - getValidFileName
```
public static String getValidFileName(String fileName,
                                      boolean withExt)
```
    Returns the valid file name.
    
    Parameters:
    
    fileName - the file name
    
    withExt - if false . will be replaced on _
    
    Returns:
    
    the valid file name
  - isFileNameValid
```
public static boolean isFileNameValid(String file)
```
    Checks if filename is valid.
    
    Parameters:
    
    file - the file name
    
    Returns:
    
    true, if filename is valid
  - gzipFile
```
public static void gzipFile(String sourceFileName,
                            String destFileName)
                     throws IOException
```
    Gzip file.
    
    Parameters:
    
    sourceFileName - the source file name
    
    destFileName - the gzip file name
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - ungzipFile
```
public static String ungzipFile(String sourceFileName,
                                String destFolder)
                         throws IOException
```
    UnGzip file.
    
    Parameters:
    
    sourceFileName - the gzip file name
    
    destFolder - the destination folder
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - hasWildCard
```
public static Boolean hasWildCard(String fileName)
```
    Checks for wildcards or { or } in the file name.
    
    Parameters:
    
    fileName - the file name
    
    Returns:
    
    the Boolean.TRUE if file name contains wildcards or { or }. Returns null if file name is empty.
  - isWildCard
```
public static boolean isWildCard(String fileName)
```
    Checks for wildcards in the file name.
    
    Parameters:
    
    fileName - the file name
    
    Returns:
    
    true is file name has * or ?.
  - hideFileOnWindows
```
public static void hideFileOnWindows(String fileName)
```
    Hides file on windows.
    
    Parameters:
    
    fileName - the file name
  - loadTextFile
```
public static String loadTextFile(String fileName)
                           throws IOException
```
    Loads text file into the string.
    
    Parameters:
    
    fileName - the file name
    
    Returns:
    
    the string
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - loadTextFile
```
public static String loadTextFile(String fileName,
                                  long maxSize)
                           throws IOException
```
    Loads text file into the string. Limits the max size of the loaded data.
    
    Parameters:
    
    fileName - the file name
    
    maxSize - the max size of the loaded data. If equals to -1 the limit will not be enforced.
    
    Returns:
    
    the string
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - loadTextFileFromResource
```
public static String loadTextFileFromResource(String resource)
                                       throws IOException
```
    Loads text file into the string. Limits the max size of the loaded data.
    
    Parameters:
    
    resource - the resource
    
    Returns:
    
    the string
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - merge
```
public static String merge(String fileToCreate,
                           File... allFiles)
                    throws Exception
```
    Merge files allFiles into the the single fileToCreate.
    
    Parameters:
    
    fileToCreate - the file to create
    
    allFiles - the files to merge
    
    Returns:
    
    the output string
    
    Throws:
    
    Exception - in case of any errror
  - merge
```
public static String merge(String fileToCreate,
                           String header,
                           String footer,
                           String... patterns)
                    throws Exception
```
    Merge text files using given file pattern.
    
    Parameters:
    
    fileToCreate - the name of the file to create
    
    header - the header string to be added to the file
    
    footer - the footer string to be added to the file
    
    patterns - the array of patterns. For example usr/temp/*.txt, abc.txt
    
    Returns:
    
    result string
    
    Throws:
    
    Exception - the exception
  - mkDir
```
public static boolean mkDir(String name)
```
    Creates a folder.
    
    Parameters:
    
    name - the folder name
    
    Returns:
    
    true, if successful
  - readObject
```
public static Object readObject(String fileName)
                         throws Exception
```
    Reads java object from the file.
    
    Parameters:
    
    fileName - the file name
    
    Returns:
    
    the object
    
    Throws:
    
    Exception - in case of any error
  - readObject
```
public static Object readObject(String fileName,
                                boolean decrypt)
                         throws Exception
```
    Reads java object from the file.
    
    Parameters:
    
    fileName - the file name
    
    decrypt - if true decrypts the object using default key
    
    Returns:
    
    the object
    
    Throws:
    
    Exception - in case of any error
  - readObjectFromJson
```
public static Object readObjectFromJson(String fileName)
                                 throws Exception
```
    Reads java object from the json file.
    
    Parameters:
    
    fileName - the file name
    
    Returns:
    
    the object
    
    Throws:
    
    Exception - in case of any error
  - readObjectFromJson
```
public static Object readObjectFromJson(String fileName,
                                        boolean decrypt)
                                 throws Exception
```
    Reads java object from the json file.
    
    Parameters:
    
    fileName - the file name
    
    decrypt - if true decrypts the object using default key
    
    Returns:
    
    the object
    
    Throws:
    
    Exception - in case of any error
  - readObjectFromJson
```
public static Object readObjectFromJson(String fileName,
                                        Key key)
                                 throws Exception
```
    Reads encrypted java object from the json file.
    
    Parameters:
    
    fileName - the file name
    
    key - the key
    
    Returns:
    
    the object
    
    Throws:
    
    Exception - in case of any error
  - readTextFile
```
public static TypedKeyValue<String,Long> readTextFile(String fileName,
                                                      long maxSize)
                                               throws IOException
```
    Reads text file into the string. Limits the max size of the loaded data.
    
    Parameters:
    
    fileName - the file name
    
    maxSize - the max size of the loaded data. If equals to -1 the limit will not be enforced.
    
    Returns:
    
    TypedKeyValue where key is a loaded string and value is a number of bytes actually read.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - readTextFromStream
```
public static TypedKeyValue<String,Long> readTextFromStream(InputStream inputStream,
                                                            long maxSize)
                                                     throws IOException
```
    Reads input stream into the string. Limits the max size of the loaded data.
    
    Parameters:
    
    inputStream - the input stream
    
    maxSize - the max size of the loaded data. If equals to -1 the limit will not be enforced.
    
    Returns:
    
    TypedKeyValue where key is a loaded string and value is a number of bytes actually read.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - saveFile
```
public static File saveFile(ByteArrayOutputStream stream,
                            String name)
                     throws IOException
```
    Create file using given output stream and file name.
    
    Parameters:
    
    stream - the stream
    
    name - the name
    
    Returns:
    
    the file
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - saveTempFile
```
public static File saveTempFile(ByteArrayOutputStream stream,
                                String name)
                         throws IOException
```
    Create file in the temporary folder using given stream and file name.
    
    Parameters:
    
    stream - the stream
    
    name - the name
    
    Returns:
    
    the file
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - saveTextFile
```
public static void saveTextFile(String fileName,
                                String text)
                         throws IOException
```
    Saves the text file.
    
    Parameters:
    
    fileName - the file name
    
    text - the text to save
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - unzip
```
public static boolean unzip(String destFolder,
                            String wildCard,
                            boolean deleteZip,
                            String... password)
                     throws Exception
```
    Unzip files.
    
    Parameters:
    
    destFolder - the destination folder
    
    wildCard - the wild card
    
    deleteZip - if true - delete original zip file
    
    password - the password
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - unzipOrUnGzipFiles
```
public static List<String> unzipOrUnGzipFiles(boolean isUnGZip,
                                              boolean isFlat,
                                              String destFolder,
                                              String zipFileName,
                                              String... password)
                                       throws Exception
```
    Unzip or ungzip files into the folder.
    
    Parameters:
    
    isUnGZip - boolean, if true unzip the gzip file
    
    isFlat - boolean, if true do not create nested folders
    
    destFolder - the destination folder name
    
    zipFileName - the zip file name
    
    password - the password
    
    Returns:
    
    the the list of strings, each of them is a fully qualified file name
    
    Throws:
    
    Exception - in case of any error
  - unZipFileWithCommons
```
public static List<String> unZipFileWithCommons(String destFolder,
                                                String zipFileName,
                                                boolean isFlat,
                                                List<String> files)
                                         throws Exception
```
    Unzip file using commons-compress libary.
    
    Parameters:
    
    destFolder - the destination folder
    
    zipFileName - the zip file name
    
    isFlat - boolean if true do not create subfolders
    
    files - the List of files. If null return null
    
    Returns:
    
    the List of files
    
    Throws:
    
    Exception - in case of any error
  - unzipOrUnGzipFiles
```
public static List<String> unzipOrUnGzipFiles(boolean isUnGZip,
                                              String destFolder,
                                              String zipFileName,
                                              String... password)
                                       throws Exception
```
    Unzip or ungzip files into the folder.
    
    Parameters:
    
    isUnGZip - boolean, if true unzip the gzip file
    
    destFolder - the destination folder name
    
    zipFileName - the zip file name
    
    password - the password
    
    Returns:
    
    the the list of strings, each of them is a fully qualified file name
    
    Throws:
    
    Exception - in case of any error
  - unzipFiles
```
public static List<String> unzipFiles(String destFolder,
                                      String zipFileName,
                                      String... password)
                               throws Exception
```
    Unzip files into the folder.
    
    Parameters:
    
    destFolder - the destination folder name
    
    zipFileName - the zip file name
    
    password - the password
    
    Returns:
    
    the the list of strings, each of them is a fully qualified file name
    
    Throws:
    
    Exception - in case of any error
  - removeWildCard
```
public static String removeWildCard(String name)
```
    Removes the wild card from file name.
    
    Parameters:
    
    name - the file name
    
    Returns:
    
    the file name without wildcard
  - unzip
```
public static void unzip(String zipFilePath,
                         String destDirectory)
                  throws IOException
```
    Extracts a zip file specified by the zipFilePath to a directory specified by destDirectory (will be created if does not exists).
    
    Parameters:
    
    zipFilePath - the zip file path
    
    destDirectory - the dest directory
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - writeObject
```
public static void writeObject(String fileName,
                               Object object)
                        throws Exception
```
    Writes Java object into the file.
    
    Parameters:
    
    fileName - the file name
    
    object - the object
    
    Throws:
    
    Exception - in case of any error
  - writeObject
```
public static void writeObject(String fileName,
                               Object object,
                               boolean encrypt)
                        throws Exception
```
    Writes Java object into the file.
    
    Parameters:
    
    fileName - the file name
    
    object - the object
    
    encrypt - if true encrypts the file
    
    Throws:
    
    Exception - in case of any error
  - writeObjectToJson
```
public static void writeObjectToJson(String fileName,
                                     Object object)
                              throws Exception
```
    Writes Java object into the file in json format.
    
    Parameters:
    
    fileName - the file name
    
    object - the object
    
    Throws:
    
    Exception - in case of any error
  - writeObjectToJson
```
public static void writeObjectToJson(String fileName,
                                     Object object,
                                     boolean encrypt)
                              throws Exception
```
    Writes Java object into the file in json format.
    
    Parameters:
    
    fileName - the file name
    
    object - the object
    
    encrypt - if true encrypts the file
    
    Throws:
    
    Exception - in case of any error
  - writeObjectToJson
```
public static void writeObjectToJson(String fileName,
                                     Object object,
                                     Key key)
                              throws Exception
```
    Writes Java object into the file in json format and encrypt the file.
    
    Parameters:
    
    fileName - the file name
    
    object - the object
    
    key - the encryption key
    
    Throws:
    
    Exception - in case of any error
  - zip
```
public static boolean zip(String zipFileName,
                          boolean deleteFiles,
                          String password,
                          String encyptionMethod,
                          String... wildCards)
                   throws Exception
```
    Zip files.
    
    Parameters:
    
    zipFileName - the zip file name
    
    deleteFiles - if true - delete original files
    
    password - the password
    
    encyptionMethod - the encyption method (null - default, ASE - ASE)
    
    wildCards - the wild cards
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - executeReplaceMacros
```
public static String executeReplaceMacros(String sourceFileName,
                                          String fileName)
                                   throws Exception
```
    Execute replace macros.
    
    Parameters:
    
    sourceFileName - the source file name
    
    fileName - the file name
    
    Returns:
    
    String
    
    Throws:
    
    Exception - in case of any error
  - getFileNameUsingAlgoForSuffix
```
public static String getFileNameUsingAlgoForSuffix(String fileName,
                                                   String algo)
```
    Gets the file name with suffix using given suffix algorithm.
    
    Parameters:
    
    fileName - the file name
    
    algo - the algo
    
    Returns:
    
    the file name with suffix
  - getFileNameWithSuffix
```
public static String getFileNameWithSuffix(String fileName,
                                           String suffix)
```
    Gets the file name with suffix.
    
    Parameters:
    
    fileName - the file name
    
    suffix - the suffix
    
    Returns:
    
    the file name with suffix
  - getFileNameByWildcard
```
public static String getFileNameByWildcard(String sourceFileName,
                                           String pattern,
                                           String fileName,
                                           Set<String> alreadyCreated)
                                    throws Exception
```
    Gets the file name by wildcard.
    
    Parameters:
    
    sourceFileName - the source file name
    
    pattern - the pattern
    
    fileName - the file name
    
    alreadyCreated - the already created
    
    Returns:
    
    the file name by wildcard
    
    Throws:
    
    Exception - the exception
  - getNormalizedFolderName
```
public static String getNormalizedFolderName(String folder)
```
    Gets the normalized folder name.
    
    Parameters:
    
    folder - the folder
    
    Returns:
    
    the normalized folder name
  - getNormalizedFilename
```
public static String getNormalizedFilename(String folder,
                                           String fileName)
```
    Gets the normalized filename.
    
    Parameters:
    
    folder - the folder
    
    fileName - the file name
    
    Returns:
    
    the normalized filename
  - getParentFolderName
```
public static String getParentFolderName(String folder)
```
    Gets the parent folder name.
```
 test/abc -> test/
 test/abc/xyz -> test/abc/
 csv/ -> scv/
 
```
    Parameters:
    
    folder - the folder
    
    Returns:
    
    the parent folder name
  - getActualFolderName
```
public static String getActualFolderName(String folder)
```
    Gets the actual folder name.
```
 test/abc -> abc
 test/abc/ -> abc
 test/abc/xyz -> xyz
 csv/ -> scv
 csv -> scv
 
```
    Parameters:
    
    folder - the folder
    
    Returns:
    
    the actual folder name
  - getFirstFolderName
```
public static String getFirstFolderName(String folder)
```
    Gets the first folder name.
```
 test / abc -> test / test / abc / xyz -> test
 
 
```
    Parameters:
    
    folder - the folder
    
    Returns:
    
    the first folder name
  - getRootFolderAndTheRest
```
public static TypedKeyValue<String,String> getRootFolderAndTheRest(String folder)
```
    Gets the root folder and the rest.
    
    Parameters:
    
    folder - the folder
    
    Returns:
    
    the root folder and the rest
  - getNameWithoutPrefix
```
public static String getNameWithoutPrefix(String name,
                                          String prefix)
```
    Gets the name without prefix.
    
    Parameters:
    
    name - the name
    
    prefix - the prefix
    
    Returns:
    
    the name without prefix
  - addLastSeparator
```
public static String addLastSeparator(String path)
```
    Adds the last separator.
    
    Parameters:
    
    path - the path
    
    Returns:
    
    the string
  - removeLastSeparator
```
public static String removeLastSeparator(String path)
```
    Removes the last separator.
    
    Parameters:
    
    path - the path
    
    Returns:
    
    the string
  - getCorrectFolder
```
public static String getCorrectFolder(String folder)
```
    Cleanup the folder.
    
    Parameters:
    
    folder - the folder
    
    Returns:
    
    the correct folder
  - getFileNameWithExtFromOtherFilename
```
public static String getFileNameWithExtFromOtherFilename(String filename,
                                                         String filenameWithExt)
```
    Gets the file name with extension from other filename.
    
    Parameters:
    
    filename - the filename
    
    filenameWithExt - the filename with extension
    
    Returns:
    
    the file name with extension from other filename

Class FileUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

BUFFER

Constructor Detail

FileUtils

Method Detail

addFilesToZip

addFilesToZip

changeExt

changeFileName

copyFile

copyFile

copyFilesFromFolderToFolder

createZipWithPassword

deleteFile

deleteFile

deleteFilesInFolder

downloadFile

fileExists

fileExistsAndNotDir

getBytesFromFile

getFilename

updateFolderAndFilename

getFilenameWithPath

getFileName

getFilesByPatterns

getFilesByPattern

getFilesInFolder

getFolderName

getFullFileName

getFullName

getTempFileName

getTempFileNameInDataFolder

getUnixFolderName

getValidFileName

isFileNameValid

gzipFile

ungzipFile

hasWildCard

isWildCard

hideFileOnWindows

loadTextFile

loadTextFile

loadTextFileFromResource

merge

merge

mkDir

readObject

readObject

readObjectFromJson

readObjectFromJson

readObjectFromJson

readTextFile

readTextFromStream

saveFile

saveTempFile

saveTextFile

unzip

unzipOrUnGzipFiles

unZipFileWithCommons

unzipOrUnGzipFiles

unzipFiles

removeWildCard

unzip

writeObject

writeObject

writeObjectToJson

writeObjectToJson

writeObjectToJson

zip

executeReplaceMacros

getFileNameUsingAlgoForSuffix

getFileNameWithSuffix

getFileNameByWildcard

getNormalizedFolderName

getNormalizedFilename