flexagon.ff.common.core.utils

Class FlexFileUtils

java.lang.Object

FlexFileBase

flexagon.ff.common.core.utils.FlexFileUtils

public class FlexFileUtils
extends FlexFileBase

Method Summary

Modifier and Type	Method and Description
static java.lang.String	calculateDirectoryHash(java.io.File pDirToHash) Calculate directory hash by considering all files in the folder.
static java.lang.String	calculateFileHash(java.io.File pFile) Calculates hash based on file content.
static java.lang.String	convertBase64EncodedString(java.lang.String pEncodedString)
static void	convertBase64EncodedStringToFile(java.lang.String pEncodedString, java.io.File pFile) Deprecated. Use java 8 Base64 when java 6 dependency is removed.
static java.lang.String	convertByteArrayToHexString(byte[] arrayBytes)
static java.lang.String	convertFileToBase64String(java.io.File pFile)
static java.lang.String	convertGlobToRegEx(java.lang.String line)
static void	copyDirectory(java.io.File srcDir, java.io.File destDir) Contents of SrcDir are copied to DestDir.
static void	copyFile(java.io.File srcFile, java.io.File destFile) Copy file.
static void	delete(java.io.File fileOrDirectory) Delete file or directory represented by supplied file object
static void	deleteDirectory(java.io.File directory) Delete directory including all of its contents.
static void	deleteDirectorySafely(java.io.File pDirectory) Delete a directory safely.
static void	deleteFile(java.io.File file) Delete file
static void	deleteFileSafely(java.io.File file) Delete file, ignoring if delete fails
static void	deleteSafely(java.io.File pFileOrDirectory) Delete File or Directory safely.
static void	ensureDirectory(java.io.File directory)
static java.lang.String	getExtensionFromFileName(java.lang.String pFileNamePath)
static java.lang.String	getExtensionFromFileName(java.lang.String pFileNamePath, java.lang.String pDefaultExtension)
static java.util.Collection<java.io.File>	getListOfFilesMatchingCaseInsensitiveSuffix(java.io.File sourceFolder, java.lang.String suffix) Finds files that end with suffix.
static java.io.File[]	getListOfFilesMatchingExt(java.io.File sourceFolder, java.lang.String pExtension) Don't put the .
static java.lang.String[]	getListOfFilesMatchingExt(java.lang.String pDirectory, java.lang.String pExtension) Returns an empty list if no files are found.
static java.util.Collection<java.io.File>	getListOfFilesMatchingRegex(java.io.File sourceFolder, java.lang.String regex)
static java.util.Collection<java.io.File>	getListOfFilesMatchingSuffix(java.io.File sourceFolder, java.lang.String suffix) Finds files that end with suffix.
static java.util.Collection<java.io.File>	getListOfFilesMatchingWildcard(java.io.File sourceFolder, java.lang.String wildCardExpression)
static java.lang.String	hashInputStream(java.io.InputStream inputStream, java.lang.String pFileName)
static java.lang.String[]	list(java.io.File directory) checks for access issues, if null is returned from list, it means that this process can not access that folder.
static java.io.File[]	listFiles(java.io.File directory) checks for access issues, if null is returned from listFiles, it means that this process can not access that folder.
static java.io.File[]	listFilesNewerThan(java.io.File directory, long timestamp)
static java.io.File[]	listFilesOlderThan(java.io.File directory, long timestamp)
static java.lang.String	listStringToString(java.util.List<java.lang.String> lines)
static java.lang.String	probeContentType(java.io.File pFile)
static java.lang.String	probeContentType(java.lang.String pFileName) in Java 11+, need to include javax.activation as a dependency to use this method.
static java.util.List<java.lang.String>	read(java.io.File file) Reads a File into a List<String>
static java.util.List<java.lang.String>	read(java.io.InputStream is) Reads an input stream into a List<String>
static java.util.Map<java.lang.String,java.lang.String>	readAsMap(java.io.File file) This method will not work if the file has 2 or more = signs on a line.
static byte[]	readBytesFromFile(java.io.File file)
static java.lang.String	readFileAsMultiLineString(java.io.File file)
static java.lang.String	readFileAsMultiLineString(java.io.InputStream is)
static java.lang.String	readFileAsString(java.io.File file)
static java.lang.String	readFileAsString(java.io.InputStream is)
static void	rename(java.io.File from, java.io.File to)
static void	unZip(java.io.File pFileToUnzip, java.io.File pOutputFolder)
static void	unZip(java.io.InputStream pInputStream, java.io.File pOutputFolder)
static void	unZipJar(java.lang.String pJarFileWithPath, java.lang.String pOutputFolder)
static void	unZipJar(java.lang.String pJarFile, java.lang.String pInputFolder, java.lang.String pOutputFolder)
static void	write(java.io.File file, java.util.List<java.lang.String> data) Write a list of strings to a file with UTF-8 charset
static void	write(java.io.File file, java.util.List<java.lang.String> data, java.nio.charset.Charset pCharset) Write list of strings to a file with the specified charset
static void	writeAsMap(java.io.File file, java.util.Map<java.lang.String,java.lang.String> map)
static void	writeBytesToFile(java.io.File file, byte[] pData) Writes a byte array to a file Throws FlexRuntimeException
static void	writeInputStreamToFile(java.io.File resultsFile, java.io.InputStream inputStream) Writes an input stream to a file Throws FlexRuntimeException
static int	zip(java.io.File pSourceDirectory, java.lang.String pTargetFile)
static void	zipDirectory(java.lang.String pNamePrefix, java.io.File pDirectory, java.util.zip.ZipOutputStream pZos) Add a directory to a ZipOutputStream.
static void	zipFile(java.lang.String pNamePrefix, java.io.File pFile, java.util.zip.ZipOutputStream pZipOutputStream) Add a file into a zip output stream
static java.io.InputStream	zipInputStreamsToInputStream(java.util.Map<java.lang.String,java.io.InputStream> pInputStreams) Combines multiple input streams into a single compressed input stream
static java.io.ByteArrayOutputStream	zipInputStreamsToOutputStream(java.util.Map<java.lang.String,java.io.InputStream> pInputStreams) Combines multiple input streams into a single zip stream

Methods inherited from class java.lang.Object

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

Method Detail

ensureDirectory

public static void ensureDirectory(java.io.File directory)

deleteDirectory

public static void deleteDirectory(java.io.File directory)

Delete directory including all of its contents.

Parameters:

directory -

deleteDirectorySafely

public static void deleteDirectorySafely(java.io.File pDirectory)

Delete a directory safely. Meaning it will not throw an exception if it does not complete correctly.

Parameters:

pDirectory -

deleteFile

public static void deleteFile(java.io.File file)

Delete file

Parameters:

file -

deleteFileSafely

public static void deleteFileSafely(java.io.File file)

Delete file, ignoring if delete fails

Parameters:

file -

delete

public static void delete(java.io.File fileOrDirectory)

Delete file or directory represented by supplied file object

Parameters:

fileOrDirectory -

deleteSafely

public static void deleteSafely(java.io.File pFileOrDirectory)

Delete File or Directory safely. Meaning no exception will be thrown if it fails.

Parameters:

pFileOrDirectory -

listFiles

public static java.io.File[] listFiles(java.io.File directory)

checks for access issues, if null is returned from listFiles, it means that this process can not access that folder.

Parameters:

directory -

Returns:

listFilesOlderThan

public static java.io.File[] listFilesOlderThan(java.io.File directory,
                                                long timestamp)

listFilesNewerThan

public static java.io.File[] listFilesNewerThan(java.io.File directory,
                                                long timestamp)

list

public static java.lang.String[] list(java.io.File directory)

checks for access issues, if null is returned from list, it means that this process can not access that folder.

Parameters:

directory -

Returns:

copyFile

public static void copyFile(java.io.File srcFile,
                            java.io.File destFile)

Copy file.

Parameters:

srcFile -

destFile -

copyDirectory

public static void copyDirectory(java.io.File srcDir,
                                 java.io.File destDir)

Contents of SrcDir are copied to DestDir. Destination directory must be empty. Source Directory must exist and must represent Directory.

Parameters:

srcDir -

destDir -

rename

public static void rename(java.io.File from,
                          java.io.File to)

readBytesFromFile

public static byte[] readBytesFromFile(java.io.File file)

writeInputStreamToFile

public static void writeInputStreamToFile(java.io.File resultsFile,
                                          java.io.InputStream inputStream)

Writes an input stream to a file Throws FlexRuntimeException

Parameters:

resultsFile - - file to write

inputStream - - InputStream to write. The inputStream is not closed, and should be by the caller.

writeBytesToFile

public static void writeBytesToFile(java.io.File file,
                                    byte[] pData)

Writes a byte array to a file Throws FlexRuntimeException

Parameters:

file - - file to write

pData - - data for file.

read

public static java.util.List<java.lang.String> read(java.io.File file)

Reads a File into a List<String>

Parameters:

file - - file to read.

Returns:

the data from the file.

read

public static java.util.List<java.lang.String> read(java.io.InputStream is)

Reads an input stream into a List<String>

Parameters:

is - - input stream

Returns:

the data from the input stream.

readFileAsString

public static java.lang.String readFileAsString(java.io.File file)

readFileAsString

public static java.lang.String readFileAsString(java.io.InputStream is)

readFileAsMultiLineString

public static java.lang.String readFileAsMultiLineString(java.io.File file)

readFileAsMultiLineString

public static java.lang.String readFileAsMultiLineString(java.io.InputStream is)

listStringToString

public static java.lang.String listStringToString(java.util.List<java.lang.String> lines)

readAsMap

public static java.util.Map<java.lang.String,java.lang.String> readAsMap(java.io.File file)

This method will not work if the file has 2 or more = signs on a line. It should probably either not be used - use Properties File classes from Java instead, or it should be rewritten with using indexOf(=) instead of split("=").

Parameters:

file -

Returns:

write

public static void write(java.io.File file,
                         java.util.List<java.lang.String> data)

Write a list of strings to a file with UTF-8 charset

Parameters:

file - File to write to

data - List of strings to write

write

public static void write(java.io.File file,
                         java.util.List<java.lang.String> data,
                         java.nio.charset.Charset pCharset)

Write list of strings to a file with the specified charset

Parameters:

file - File to write to

data - List of strings to write

pCharset - Charset to write with

writeAsMap

public static void writeAsMap(java.io.File file,
                              java.util.Map<java.lang.String,java.lang.String> map)

getListOfFilesMatchingExt

public static java.lang.String[] getListOfFilesMatchingExt(java.lang.String pDirectory,
                                                           java.lang.String pExtension)

Returns an empty list if no files are found.

Parameters:

pDirectory -

pExtension -

Returns:

getListOfFilesMatchingExt

public static java.io.File[] getListOfFilesMatchingExt(java.io.File sourceFolder,
                                                       java.lang.String pExtension)

Don't put the . on it. The . is added for you. So, you would pass in "java" to find *.java.

Parameters:

sourceFolder -

pExtension - - NO PERIOD.

Returns:

getListOfFilesMatchingSuffix

public static java.util.Collection<java.io.File> getListOfFilesMatchingSuffix(java.io.File sourceFolder,
                                                                              java.lang.String suffix)

Finds files that end with suffix. This is case-sensitive. You can use this for extension by starting the suffix with a .

Parameters:

sourceFolder -

suffix -

Returns:

getListOfFilesMatchingCaseInsensitiveSuffix

public static java.util.Collection<java.io.File> getListOfFilesMatchingCaseInsensitiveSuffix(java.io.File sourceFolder,
                                                                                             java.lang.String suffix)

Finds files that end with suffix. This is case-sensitive. You can use this for extension by starting the suffix with a .

Parameters:

sourceFolder -

suffix -

Returns:

getListOfFilesMatchingRegex

public static java.util.Collection<java.io.File> getListOfFilesMatchingRegex(java.io.File sourceFolder,
                                                                             java.lang.String regex)

getListOfFilesMatchingWildcard

public static java.util.Collection<java.io.File> getListOfFilesMatchingWildcard(java.io.File sourceFolder,
                                                                                java.lang.String wildCardExpression)

zipInputStreamsToOutputStream

public static java.io.ByteArrayOutputStream zipInputStreamsToOutputStream(java.util.Map<java.lang.String,java.io.InputStream> pInputStreams)
                                                                   throws java.io.IOException

Combines multiple input streams into a single zip stream

Parameters:

pInputStreams - Map of [fileName: InputStream] to include in the zip

Returns:

ZipOutputStream of the zip

Throws:

java.io.IOException

zipInputStreamsToInputStream

public static java.io.InputStream zipInputStreamsToInputStream(java.util.Map<java.lang.String,java.io.InputStream> pInputStreams)
                                                        throws java.io.IOException

Combines multiple input streams into a single compressed input stream

Parameters:

pInputStreams - Map of [fileName: InputStream] to include in the zip

Returns:

InputStream of the combined streams. This can be used for api upload or file writing

Throws:

java.io.IOException

zip

public static int zip(java.io.File pSourceDirectory,
                      java.lang.String pTargetFile)
               throws FlexCheckedException

Throws:

FlexCheckedException

unZip

public static void unZip(java.io.File pFileToUnzip,
                         java.io.File pOutputFolder)
                  throws FlexCheckedException

Throws:

FlexCheckedException

unZip

public static void unZip(java.io.InputStream pInputStream,
                         java.io.File pOutputFolder)
                  throws FlexCheckedException

Throws:

FlexCheckedException

unZipJar

public static void unZipJar(java.lang.String pJarFile,
                            java.lang.String pInputFolder,
                            java.lang.String pOutputFolder)
                     throws FlexCheckedException

Throws:

FlexCheckedException

unZipJar

public static void unZipJar(java.lang.String pJarFileWithPath,
                            java.lang.String pOutputFolder)
                     throws FlexCheckedException

Throws:

FlexCheckedException

zipDirectory

public static void zipDirectory(java.lang.String pNamePrefix,
                                java.io.File pDirectory,
                                java.util.zip.ZipOutputStream pZos)
                         throws java.io.IOException

Add a directory to a ZipOutputStream. Useful if you want to zip some directories in a folder but not all

Parameters:

pNamePrefix - Name of the directory

pDirectory - Directory to zip

pZos - Already opened ZipOutputStream. CALLER MUST CLOSE THIS STREAM.

Throws:

java.io.IOException

zipFile

public static void zipFile(java.lang.String pNamePrefix,
                           java.io.File pFile,
                           java.util.zip.ZipOutputStream pZipOutputStream)
                    throws java.io.IOException

Add a file into a zip output stream

Parameters:

pNamePrefix - directory before the file

pFile - The file to add

pZipOutputStream - The stream to add the file too. Caller needs to close the stream.

Throws:

java.io.IOException

convertGlobToRegEx

public static java.lang.String convertGlobToRegEx(java.lang.String line)

calculateDirectoryHash

public static java.lang.String calculateDirectoryHash(java.io.File pDirToHash)
                                               throws FlexCheckedException

Calculate directory hash by considering all files in the folder.

Parameters:

pDirToHash -

Returns:

Throws:

FlexCheckedException

calculateFileHash

public static java.lang.String calculateFileHash(java.io.File pFile)
                                          throws FlexCheckedException

Calculates hash based on file content.

This method was copied from ArtifactUtil of FlexDeployPluginCore.

Parameters:

pFile -

Returns:

Throws:

FlexCheckedException

hashInputStream

public static java.lang.String hashInputStream(java.io.InputStream inputStream,
                                               java.lang.String pFileName)
                                        throws FlexCheckedException

Throws:

FlexCheckedException

convertByteArrayToHexString

public static java.lang.String convertByteArrayToHexString(byte[] arrayBytes)

probeContentType

public static java.lang.String probeContentType(java.lang.String pFileName)

in Java 11+, need to include javax.activation as a dependency to use this method.

probeContentType

public static java.lang.String probeContentType(java.io.File pFile)

convertFileToBase64String

public static java.lang.String convertFileToBase64String(java.io.File pFile)

convertBase64EncodedStringToFile

public static void convertBase64EncodedStringToFile(java.lang.String pEncodedString,
                                                    java.io.File pFile)
                                             throws FlexCheckedException

Deprecated. Use java 8 Base64 when java 6 dependency is removed.

Parameters:

pEncodedString -

pFile -

Throws:

FlexCheckedException

convertBase64EncodedString

public static java.lang.String convertBase64EncodedString(java.lang.String pEncodedString)

getExtensionFromFileName

public static java.lang.String getExtensionFromFileName(java.lang.String pFileNamePath)

getExtensionFromFileName

public static java.lang.String getExtensionFromFileName(java.lang.String pFileNamePath,
                                                        java.lang.String pDefaultExtension)