flexagon.ff.common.core.utils

Class FlexFileUtils

java.lang.Object

flexagon.ff.common.core.utils.FlexFileUtils

public class FlexFileUtils
extends java.lang.Object

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	convertByteArrayToHexString(byte[] arrayBytes)
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 it's contents.
static void	deleteFile(java.io.File file) Delete file
static void	deleteFileSafely(java.io.File file) Delete file, ignoring if delete fails
static void	ensureDirectory(java.io.File directory)
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 boolean	isSymbolicLink(java.io.File file) Returns true if file represents symbolic link.
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 void	main(java.lang.String[] pArgs)
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 fileToUnzip, 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 specificed 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 void	zip(java.io.File pSourceDirectory, java.lang.String pTargetFile)

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 it's contents.

Parameters:

directory -

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 -

isSymbolicLink

public static boolean isSymbolicLink(java.io.File file)

Returns true if file represents symbolic link.

Parameters:

file -

Returns:

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:

file - - 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 specificed 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)

zip

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

Throws:

FlexCheckedException

unZip

public static void unZip(java.io.File fileToUnzip,
                         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

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)

main

public static void main(java.lang.String[] pArgs)
                 throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException