org.safs.text

Class FileUtilities

java.lang.Object

org.safs.text.FileUtilities

public class FileUtilities
extends java.lang.Object

Functions to process files for specific text. This includes processing of both default System character encodings and UTF-8 encodings.

Author:

Carl Nagle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileUtilities.Access
static class	FileUtilities.DateType
static class	FileUtilities.FileAttribute To model the file attribute.
static class	FileUtilities.FileAttributeFilter Note: To form a new instance of class FileAttributeFilter,please use one of the following file attribute's code or their combination: FileUtilities.FileAttribute.Type.NORMALFILE FileUtilities.FileAttribute.Type.READONLYFILE FileUtilities.FileAttribute.Type.HIDDENFILE FileUtilities.FileAttribute.Type.SYSTEMFILE FileUtilities.FileAttribute.Type.DIRECTORY FileUtilities.FileAttribute.Type.ARCHIVEFILE For example: //this filter will help to get all normal files, all hidden files and all archive files.
static class	FileUtilities.FileType
static class	FileUtilities.FilterMode
static class	FileUtilities.ImageFilterMode
static class	FileUtilities.Mode
static class	FileUtilities.PatternFilterMode
static class	FileUtilities.Placement
static interface	FileUtilities.Predicate<T> Provides one method test() returning boolean. A copy from Java 8, this interface could be removed when using Java 8 or later.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ARCHIVEFILESUFFIX A list of suffix for archive file in link http://en.wikipedia.org/wiki/List_of_archive_formats
static char	ATTRIBUTE_ARCHIVE 'A'
static char	ATTRIBUTE_HIDDEN 'H'
static char	ATTRIBUTE_READONLY 'R'
static char	ATTRIBUTE_SYSTEM 'S'
static java.lang.String[]	ATTRIBUTES_ARRAY An array containing "R" "S" "H" "A"
static java.lang.String	DOS_COMMAND_ATTRIB "attrib"
static java.lang.String	FILE_SEP_UNIX "/"
static java.lang.String	FILE_SEP_WIN "\\"
static int	FILE_TYPE_BENCH
static int	FILE_TYPE_DATAPOOL
static int	FILE_TYPE_DIFF
static int	FILE_TYPE_PROJECT
static int	FILE_TYPE_TEST
static int	PARAM_ALL_CHARACTERS -1, means all characters will be written.
static java.lang.String	PARAM_CASE_INSENSITIVE "CaseInsensitive"
static java.lang.String	PARAM_CASE_SENSITIVE "CaseSensitive"
static java.lang.String	PARAM_NO_VERIYF "NoVerify"
static java.lang.String	VAR_SAFSBENCHDIRECTORY
static java.lang.String	VAR_SAFSDATAPOOLDIRECTORY
static java.lang.String	VAR_SAFSDIFDIRECTORY
static java.lang.String	VAR_SAFSLOGSDIRECTORY
static java.lang.String	VAR_SAFSPROJECTDIRECTORY
static java.lang.String	VAR_SAFSTESTDIRECTORY

Constructor Summary

Constructors

Constructor and Description
FileUtilities()

Method Summary

Modifier and Type	Method and Description
static java.util.Properties	appendProperties(java.util.Properties target, java.net.URL url) Open a new Properties file located at the provided URL and add its entries to those in the target Properties file.
static int	copyDirectoryRecursively(java.io.File srcDir, java.io.File destDir) Careful what you wish for...
static void	copyFile(java.io.InputStream in, java.io.OutputStream out)
static void	copyFileToFile(java.io.BufferedReader reader, java.io.BufferedWriter writer) Copy one file (BufferedReader) to another file (BufferedWriter).
static void	copyFileToFile(java.io.File source, java.io.File dest) Attempt to copy a source File to a destination File location.
static void	copySystemToUTF8File(java.lang.String systemFile, java.lang.String utf8File) Copy a default system codepage file to a file in UTF-8 format.
static void	copyUTF8ToSystemFile(java.lang.String utf8File, java.lang.String systemFile) Copy a UTF-8 format file to a file in the default system codepage.
static java.io.File	deduceBenchFile(java.lang.String filename, RuntimeDataInterface data) Deduce the absolute full path bench-relative file.
static java.io.File	deduceDatapoolFile(java.lang.String filename, RuntimeDataInterface data) Deduce the absolute full path datapool-relative file.
static java.io.File	deduceDiffFile(java.lang.String filename, RuntimeDataInterface data) Deduce the absolute full path Diff-relative file.
static java.io.File	deduceFile(java.lang.String filename, int type, RuntimeDataInterface data) Deduce the absolute full path to a project-relative, test-relative, bench-relative, diff-relative filename.
static java.lang.String	deduceMatchingUUIDFilename(java.lang.String benchFilename) Create a unique test/actual filename matching the benchFilename but with a UUID String embedded.
static java.io.File	deduceProjectFile(java.lang.String filename, RuntimeDataInterface data) Deduce the absolute full path to a project-relative file.
static java.io.File	deduceTestFile(java.lang.String filename, RuntimeDataInterface data) Deduce the absolute full path test-relative file.
static int	deleteDirectoryRecursively(java.lang.String directory, boolean verbose) Remove directory recursively by JAVA API
static java.lang.String	detectFileEncoding(java.lang.String filename) Detects file's encoding. This depends on class FileUtilitiesByThirdParty, which requires jar juniversalchardet
static java.lang.String	detectStringEncoding(java.lang.String str) Detects String encoding. This depends on class FileUtilitiesByThirdParty, which requires jar juniversalchardet
static java.io.BufferedReader	getBufferedFileReader(java.lang.String filename, java.lang.String encoding) Provides a BufferedReader for a FileInputStream with encoding.
static java.io.BufferedWriter	getBufferedFileWriter(java.lang.String filename, java.lang.String encoding) Provides a BufferedWriter for a FileOutputStream with encoding.
static java.lang.String	getExtension(java.io.File file) Return the lower-case file extension portion of the provided logical file.
static FileUtilities.FileAttribute	getFileAttribute(java.io.File file)
static java.lang.String	getPlatformName()
static java.io.BufferedReader	getSystemBufferedFileReader(java.lang.String filename) Provides a BufferedReader for a FileInputStream opened with an InputStreamReader using the default System codepage\charset.
static java.io.BufferedWriter	getSystemBufferedFileWriter(java.lang.String filename) Provides a BufferedWriter for a FileOutputStream opened with an OutputStreamWriter using the default System codepage\charset.
static java.io.BufferedWriter	getSystemBufferedFileWriter(java.lang.String filename, boolean append) Provides a BufferedWriter for a FileOutputStream opened with an OutputStreamWriter using the default System codepage\charset.
static java.io.BufferedReader	getUTF8BufferedFileReader(java.lang.String filename) Provides a BufferedReader for a FileInputStream opened with a UTF-8 InputStreamReader.
static java.io.BufferedWriter	getUTF8BufferedFileWriter(java.lang.String filename) Provides a BufferedWriter for a FileOutputStream opened with a UTF-8 OutputStreamWriter.
static java.io.BufferedWriter	getUTF8BufferedFileWriter(java.lang.String filename, boolean append) Provides a BufferedWriter for a FileOutputStream opened with a UTF-8 OutputStreamWriter.
static boolean	isArchive(java.io.File file) Return true, if the file has a suffix as one of ARCHIVEFILESUFFIX.
static boolean	isArchive(java.lang.String filename) Return true, if the file has a suffix as one of ARCHIVEFILESUFFIX.
static boolean	isFileUTF8(java.lang.String filename) Opens a FileInputStream and checks for UTF-8 0xEF 0xBB 0xBF marker bytes and closes the file.
static boolean	isReadOnly(java.io.File file) If file can be read and can NOT be wrote, then return true.
static boolean	isWindowPlatform()
static java.lang.String	normalizeFileSeparators(java.lang.String filename) Attempt to replace all filename path separators ( "\" or "/" ) with the correct ones for the current environment.
static java.lang.String[]	readLinesFromFile(java.lang.String filepath) Read file lines into a String[].
static java.lang.String	readStringFromEncodingFile(java.lang.String filename, java.lang.String encoding) Read file contents into a String.
static java.lang.String	readStringFromFile(java.io.BufferedReader reader) Read file contents into a String.
static java.lang.String	readStringFromSystemFile(java.lang.String filename) Read file contents into a String.
static java.lang.String	readStringFromUTF8File(java.lang.String filename) Read file contents into a String.
static void	replaceAllSubdirectoryFilesSubstrings(java.lang.String directory, java.lang.String[] fileEndings, java.lang.String findString, java.lang.String replaceString, boolean isCaseSensitive) Recursively replaceDirectoryFileSubstrings in all matching files in the directory and all sub-directories.
static void	replaceDirectoryFilesSubstrings(java.lang.String directory, java.lang.String[] fileEndings, java.lang.String findString, java.lang.String replaceString, boolean isCaseSensitive) Examine the contents of each file in the specified directory whose filename matches any one of the provided fileEndings.
static boolean	setFileAttribute(FileUtilities.FileAttribute attribute, java.io.File file)
static void	unzipFile(java.lang.String zipFileName, java.io.File root, boolean verbose) Calls unzipJAR with noMETATDir as false.
static void	unzipJAR(java.lang.String zipFileName, java.io.File root, boolean verbose, boolean noMETADir)
static void	unzipJAR(java.lang.String zipFileName, java.io.File root, boolean verbose, FileUtilities.Predicate<java.lang.String> skipPredicator)
static void	writeCollectionToFile(java.io.BufferedWriter writer, java.util.Collection<?> list) Output the toString() values in a Collection as separate lines in a new file.
static void	writeCollectionToFile(java.io.BufferedWriter writer, java.util.Collection<?> list, java.lang.String newline) Output the toString() values in a Collection as separate lines in a new file.
static void	writeCollectionToSystemFile(java.lang.String filename, java.util.Collection<?> list) Output the toString() values in a Collection as separate lines in a new file.
static void	writeCollectionToUTF8File(java.lang.String filename, java.util.Collection<?> list) Output the toString() values in a Collection as separate lines in a new file.
static void	writePropertiesFile(java.io.BufferedWriter writer, java.util.Map<java.lang.String,java.lang.String> props) Purpose: write Properties contents to BufferedWriter in a SAFS Properties file format:
static void	writeStringToFile(java.io.BufferedWriter writer, java.lang.String data) Output a String to a new file.
static void	writeStringToFile(java.lang.String filename, java.lang.String encoding, java.lang.String data) Output the String in a new file.
static void	writeStringToSystemFile(java.lang.String filename, java.lang.String data) Output the toString() values in a Collection as separate lines in a new file.
static void	writeStringToUTF8File(java.lang.String filename, java.lang.String data) Output the String in a new file.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_TYPE_TEST

public static final int FILE_TYPE_TEST

See Also:

Constant Field Values

FILE_TYPE_BENCH

public static final int FILE_TYPE_BENCH

See Also:

Constant Field Values

FILE_TYPE_PROJECT

public static final int FILE_TYPE_PROJECT

See Also:

Constant Field Values

FILE_TYPE_DIFF

public static final int FILE_TYPE_DIFF

See Also:

Constant Field Values

FILE_TYPE_DATAPOOL

public static final int FILE_TYPE_DATAPOOL

See Also:

Constant Field Values

VAR_SAFSBENCHDIRECTORY

public static final java.lang.String VAR_SAFSBENCHDIRECTORY

See Also:

Constant Field Values

VAR_SAFSDATAPOOLDIRECTORY

public static final java.lang.String VAR_SAFSDATAPOOLDIRECTORY

See Also:

Constant Field Values

VAR_SAFSDIFDIRECTORY

public static final java.lang.String VAR_SAFSDIFDIRECTORY

See Also:

Constant Field Values

VAR_SAFSLOGSDIRECTORY

public static final java.lang.String VAR_SAFSLOGSDIRECTORY

See Also:

Constant Field Values

VAR_SAFSPROJECTDIRECTORY

public static final java.lang.String VAR_SAFSPROJECTDIRECTORY

See Also:

Constant Field Values

VAR_SAFSTESTDIRECTORY

public static final java.lang.String VAR_SAFSTESTDIRECTORY

See Also:

Constant Field Values

FILE_SEP_UNIX

public static java.lang.String FILE_SEP_UNIX

"/"

FILE_SEP_WIN

public static java.lang.String FILE_SEP_WIN

"\\"

PARAM_NO_VERIYF

public static final java.lang.String PARAM_NO_VERIYF

"NoVerify"

See Also:

Constant Field Values

PARAM_CASE_SENSITIVE

public static final java.lang.String PARAM_CASE_SENSITIVE

"CaseSensitive"

See Also:

Constant Field Values

PARAM_CASE_INSENSITIVE

public static final java.lang.String PARAM_CASE_INSENSITIVE

"CaseInsensitive"

See Also:

Constant Field Values

PARAM_ALL_CHARACTERS

public static final int PARAM_ALL_CHARACTERS

-1, means all characters will be written.

See Also:

Constant Field Values

ARCHIVEFILESUFFIX

public static final java.lang.String[] ARCHIVEFILESUFFIX

A list of suffix for archive file in link http://en.wikipedia.org/wiki/List_of_archive_formats

DOS_COMMAND_ATTRIB

public static final java.lang.String DOS_COMMAND_ATTRIB

"attrib"

See Also:

Constant Field Values

ATTRIBUTE_READONLY

public static final char ATTRIBUTE_READONLY

'R'

See Also:

Constant Field Values

ATTRIBUTE_SYSTEM

public static final char ATTRIBUTE_SYSTEM

'S'

See Also:

Constant Field Values

ATTRIBUTE_HIDDEN

public static final char ATTRIBUTE_HIDDEN

'H'

See Also:

Constant Field Values

ATTRIBUTE_ARCHIVE

public static final char ATTRIBUTE_ARCHIVE

'A'

See Also:

Constant Field Values

ATTRIBUTES_ARRAY

public static final java.lang.String[] ATTRIBUTES_ARRAY

An array containing "R" "S" "H" "A"

Constructor Detail

FileUtilities

public FileUtilities()

Method Detail

getBufferedFileWriter

public static java.io.BufferedWriter getBufferedFileWriter(java.lang.String filename,
                                                           java.lang.String encoding)
                                                    throws java.io.FileNotFoundException

Provides a BufferedWriter for a FileOutputStream with encoding.

Parameters:

filename - case-insensitive absolute filename path.

encoding - The encoding to be used to create a OutputStreamWriter; If null, a default encoding indicated by "file.encoding" will be used.

Returns:

BufferedWriter open with a OutputStreamWriter to a FileOutputStream and the default buffer size.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist and cannot be created, cannot be opened for write operations, etc.

See Also:

CaseInsensitiveFile, OutputStreamWriter, FileOutputStream

getUTF8BufferedFileWriter

public static java.io.BufferedWriter getUTF8BufferedFileWriter(java.lang.String filename)
                                                        throws java.io.FileNotFoundException

Provides a BufferedWriter for a FileOutputStream opened with a UTF-8 OutputStreamWriter.

Parameters:

filename - case-insensitive absolute filename path.

Returns:

BufferedWriter open with a UTF-8 OutputStreamWriter to a FileOutputStream and the default buffer size.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist and cannot be created, cannot be opened for write operations, etc.

See Also:

CaseInsensitiveFile, OutputStreamWriter, FileOutputStream

getUTF8BufferedFileWriter

public static java.io.BufferedWriter getUTF8BufferedFileWriter(java.lang.String filename,
                                                               boolean append)
                                                        throws java.io.FileNotFoundException

Provides a BufferedWriter for a FileOutputStream opened with a UTF-8 OutputStreamWriter.

Parameters:

filename - case-insensitive absolute filename path.

append - if true, append contents to the end of file

Returns:

BufferedWriter open with a UTF-8 OutputStreamWriter to a FileOutputStream and the default buffer size.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist and cannot be created, cannot be opened for write operations, etc.

See Also:

CaseInsensitiveFile, OutputStreamWriter, FileOutputStream

isFileUTF8

public static boolean isFileUTF8(java.lang.String filename)
                          throws java.io.FileNotFoundException,
                                 java.io.IOException

Opens a FileInputStream and checks for UTF-8 0xEF 0xBB 0xBF marker bytes and closes the file. See Representations_of_byte_order_marks_by_encoding

Parameters:

filename - case-insensitive absolute filename path.

Returns:

true if the file starts with the UTF-8 marker bytes. false otherwise--including if there are not 3 bytes of data available to be read from the file.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist, cannot be opened for read operations, etc.

java.io.IOException - if there is an IO problem when attempting to open or read from the file.

See Also:

CaseInsensitiveFile, FileInputStream, FileOutputStream

detectFileEncoding

public static java.lang.String detectFileEncoding(java.lang.String filename)

Detects file's encoding.
This depends on class FileUtilitiesByThirdParty, which requires jar juniversalchardet

Parameters:

filename - case-insensitive absolute filename path.

Returns:

String, the file encoding; null, if some Exceptions occur.

detectStringEncoding

public static java.lang.String detectStringEncoding(java.lang.String str)

Detects String encoding.
This depends on class FileUtilitiesByThirdParty, which requires jar juniversalchardet

Parameters:

str - - input as string.

Returns:

String, the file encoding; null, if some Exceptions occur.

normalizeFileSeparators

public static java.lang.String normalizeFileSeparators(java.lang.String filename)

Attempt to replace all filename path separators ( "\" or "/" ) with the correct ones for the current environment.

Parameters:

filename - that may or may not have separators embedded.

Returns:

new String with correct File.separators -- if any. Returns filename unmodified if it is null or contains no separators.

getBufferedFileReader

public static java.io.BufferedReader getBufferedFileReader(java.lang.String filename,
                                                           java.lang.String encoding)
                                                    throws java.io.FileNotFoundException

Provides a BufferedReader for a FileInputStream with encoding.

Parameters:

filename - case-insensitive absolute filename path.

encoding - The encoding to be used to create a InputStreamReader; If null, a default encoding indicated by "file.encoding" will be used.

Returns:

BufferedReader open with a InputStreamReader to a FileInputStream and the default buffer size.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist, cannot be opened for read operations, etc.

See Also:

CaseInsensitiveFile, InputStreamReader, FileInputStream

getUTF8BufferedFileReader

public static java.io.BufferedReader getUTF8BufferedFileReader(java.lang.String filename)
                                                        throws java.io.FileNotFoundException

Provides a BufferedReader for a FileInputStream opened with a UTF-8 InputStreamReader.

Parameters:

filename - case-insensitive absolute filename path.

Returns:

BufferedReader open with a UTF-8 InputStreamReader to a FileInputStream and the default buffer size.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist, cannot be opened for read operations, etc.

See Also:

CaseInsensitiveFile, InputStreamReader, FileInputStream

getSystemBufferedFileWriter

public static java.io.BufferedWriter getSystemBufferedFileWriter(java.lang.String filename)
                                                          throws java.io.FileNotFoundException

Provides a BufferedWriter for a FileOutputStream opened with an OutputStreamWriter using the default System codepage\charset.

Parameters:

filename - case-insensitive absolute filename path.

Returns:

BufferedWriter open with a default OutputStreamWriter to a FileOutputStream and the default buffer size.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist and cannot be created, cannot be opened for write operations, etc.

See Also:

CaseInsensitiveFile, OutputStreamWriter, FileOutputStream

getSystemBufferedFileWriter

public static java.io.BufferedWriter getSystemBufferedFileWriter(java.lang.String filename,
                                                                 boolean append)
                                                          throws java.io.FileNotFoundException

Provides a BufferedWriter for a FileOutputStream opened with an OutputStreamWriter using the default System codepage\charset.

Parameters:

filename - case-insensitive absolute filename path.

append - if true, append contents to the end of file

Returns:

BufferedWriter open with a default OutputStreamWriter to a FileOutputStream and the default buffer size.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist and cannot be created, cannot be opened for write operations, etc.

See Also:

CaseInsensitiveFile, OutputStreamWriter, FileOutputStream

getSystemBufferedFileReader

public static java.io.BufferedReader getSystemBufferedFileReader(java.lang.String filename)
                                                          throws java.io.FileNotFoundException

Provides a BufferedReader for a FileInputStream opened with an InputStreamReader using the default System codepage\charset.

Parameters:

filename - case-insensitive absolute filename path.

Returns:

BufferedReader open with a default InputStreamReader to a FileInputStream and the default buffer size.

Throws:

java.io.FileNotFoundException - if filename exists but points to a directory instead of a regular file, does not exist, cannot be opened for read operations, etc.

See Also:

CaseInsensitiveFile, InputStreamReader, FileInputStream

copyFileToFile

public static void copyFileToFile(java.io.BufferedReader reader,
                                  java.io.BufferedWriter writer)
                           throws java.io.IOException

Copy one file (BufferedReader) to another file (BufferedWriter). Typically this is done to convert from one character encoding to another. The reader and writer will be closed on exit even if an IOException is thrown.

Parameters:

reader - BufferedReader to copy from.

writer - BufferedWriter to copy to.

Throws:

java.io.IOException - if an error occurs reading or writing.

copyUTF8ToSystemFile

public static void copyUTF8ToSystemFile(java.lang.String utf8File,
                                        java.lang.String systemFile)
                                 throws java.io.FileNotFoundException

Copy a UTF-8 format file to a file in the default system codepage.

Parameters:

utf8File - full absolute path of readable UTF-8 file to copy to default system codepage.

systemFile - full absolute path to valid output file to be created during copy.

Throws:

java.io.FileNotFoundException - if filenames exist but points to a directory instead of regular files, input file does not exist or output file cannot be created, or files cannot be opened for read or write operations, as appropriate.

See Also:

copyFileToFile(BufferedReader, BufferedWriter)

copySystemToUTF8File

public static void copySystemToUTF8File(java.lang.String systemFile,
                                        java.lang.String utf8File)
                                 throws java.io.FileNotFoundException

Copy a default system codepage file to a file in UTF-8 format.

Parameters:

systemFile - full absolute path to default system file to be copied to UTF-8.

utf8File - full absolute path of file to be created during copy.

Throws:

java.io.FileNotFoundException - if filenames exist but point to a directory instead of regular files, input file does not exist or output file cannot be created, or files cannot be opened for read or write operations, as appropriate.

See Also:

copyFileToFile(BufferedReader, BufferedWriter)

writeCollectionToFile

public static void writeCollectionToFile(java.io.BufferedWriter writer,
                                         java.util.Collection<?> list,
                                         java.lang.String newline)
                                  throws java.io.IOException

Output the toString() values in a Collection as separate lines in a new file. Each line is ended with the newline String provided. The output character encoding is determined by the BufferedWriter provided.

The writer is flushed and closed here, upon completion.

Parameters:

writer - BufferedWriter determines the output character encoding.

list - Collection of objects\lines to write

newline - String to append to each item in the list.

Throws:

java.io.IOException - thrown if an IO error occurs during writing.

writePropertiesFile

public static void writePropertiesFile(java.io.BufferedWriter writer,
                                       java.util.Map<java.lang.String,java.lang.String> props)
                                throws java.io.IOException

Purpose: write Properties contents to BufferedWriter in a SAFS Properties file format:

 :PROPERTY:propertyName
 property value possibly spanning
 multiple lines.
 :PROPERTY:propertyName
 etc...
 

Parameters:

writer - BufferedWriter

props - Map, the properties to write

Throws:

java.io.IOException

writeStringToFile

public static void writeStringToFile(java.io.BufferedWriter writer,
                                     java.lang.String data)
                              throws java.io.IOException

Output a String to a new file. The String is expected to contain all formatting, tabs, and newlines, etc.. and will be written unmodified. The output character encoding is determined by the BufferedWriter provided.

Parameters:

writer - BufferedWriter determines the output character encoding.

data - String text to write.

Throws:

java.io.IOException - thrown if an IO error occurs during writing.

See Also:

writeStringToSystemFile(String, String), writeStringToUTF8File(String, String)

writeStringToSystemFile

public static void writeStringToSystemFile(java.lang.String filename,
                                           java.lang.String data)
                                    throws java.io.FileNotFoundException,
                                           java.io.IOException

Output the toString() values in a Collection as separate lines in a new file. Each line is ended with the System line.separator property. This method outputs the text in the default character encoding of the System.

Parameters:

filename - absolute system path to the file to be created\overwritten.

data - String text to write.

Throws:

java.io.FileNotFoundException

java.io.IOException - thrown if an IO error occurs during writing.

See Also:

writeStringToFile(BufferedWriter, String)

writeStringToUTF8File

public static void writeStringToUTF8File(java.lang.String filename,
                                         java.lang.String data)
                                  throws java.io.FileNotFoundException,
                                         java.io.IOException

Output the String in a new file. This method outputs the text in the UTF-8 character encoding.

Parameters:

filename - absolute system path to the file to be created\overwritten.

data - String text to write.

Throws:

java.io.FileNotFoundException

java.io.IOException - thrown if an IO error occurs during writing.

See Also:

writeStringToFile(BufferedWriter, String)

writeStringToFile

public static void writeStringToFile(java.lang.String filename,
                                     java.lang.String encoding,
                                     java.lang.String data)
                              throws java.io.FileNotFoundException,
                                     java.io.IOException

Output the String in a new file. This method outputs the text in the character encoding given by parameter.

Parameters:

filename - absolute system path to the file to be created\overwritten.

encoding - the encoding to be used to write a file.

data - String text to write.

Throws:

java.io.FileNotFoundException

java.io.IOException - thrown if an IO error occurs during writing.

See Also:

writeStringToFile(BufferedWriter, String)

writeCollectionToFile

public static void writeCollectionToFile(java.io.BufferedWriter writer,
                                         java.util.Collection<?> list)
                                  throws java.io.IOException

Output the toString() values in a Collection as separate lines in a new file. Each line is ended with the System line.separator property appropriate for the current operating system. The output character encoding is determined by the BufferedWriter provided.

Parameters:

writer - BufferedWriter determines the output character encoding.

list - Collection of objects\lines to write

Throws:

java.io.IOException - thrown if an IO error occurs during writing.

See Also:

writeCollectionToFile(BufferedWriter, Collection, String), writeCollectionToFile(BufferedWriter, Collection, String)

writeCollectionToSystemFile

public static void writeCollectionToSystemFile(java.lang.String filename,
                                               java.util.Collection<?> list)
                                        throws java.io.FileNotFoundException,
                                               java.io.IOException

Output the toString() values in a Collection as separate lines in a new file. Each line is ended with the System line.separator property. This method outputs the text in the default character encoding of the System.

Parameters:

filename - absolute system path to the file to be created\overwritten.

list -

Throws:

java.io.FileNotFoundException

java.io.IOException - thrown if an IO error occurs during writing.

See Also:

writeCollectionToFile(BufferedWriter, Collection)

writeCollectionToUTF8File

public static void writeCollectionToUTF8File(java.lang.String filename,
                                             java.util.Collection<?> list)
                                      throws java.io.FileNotFoundException,
                                             java.io.IOException

Output the toString() values in a Collection as separate lines in a new file. Each line is ended with the System line.separator property. This method outputs the text in the UTF-8 character encoding.

Parameters:

filename - absolute system path to the file to be created\overwritten.

list -

Throws:

java.io.FileNotFoundException

java.io.IOException - thrown if an IO error occurs during writing.

See Also:

writeCollectionToFile(BufferedWriter, Collection)

readStringFromFile

public static java.lang.String readStringFromFile(java.io.BufferedReader reader)
                                           throws java.io.IOException

Read file contents into a String. The String is expected to contain all formatting, tabs, and newlines, etc.. and will be returned unmodified. The character decoding is determined by the BufferedReader provided.

Parameters:

reader - BufferedReader determines the character decoding.

Returns:

String contents of file

Throws:

java.io.IOException - thrown if an IO error occurs.

See Also:

readStringFromSystemFile(String), readStringFromUTF8File(String)

readLinesFromFile

public static java.lang.String[] readLinesFromFile(java.lang.String filepath)
                                            throws java.io.IOException

Read file lines into a String[]. The String[] is expected to contain all formatting, but \n and \r should be removed via the readLine calls. The character encoding is detected from the file, if possible. If not, the System encoding is assumed.

Parameters:

filepath -

Returns:

String[] contents of file

Throws:

java.io.IOException - thrown if an IO error occurs.

See Also:

readStringFromSystemFile(String), readStringFromUTF8File(String)

replaceAllSubdirectoryFilesSubstrings

public static void replaceAllSubdirectoryFilesSubstrings(java.lang.String directory,
                                                         java.lang.String[] fileEndings,
                                                         java.lang.String findString,
                                                         java.lang.String replaceString,
                                                         boolean isCaseSensitive)
                                                  throws java.io.IOException

Recursively replaceDirectoryFileSubstrings in all matching files in the directory and all sub-directories.

Parameters:

directory -

fileEndings -

findString -

replaceString -

isCaseSensitive -

Throws:

java.io.IOException

See Also:

replaceDirectoryFilesSubstrings(String, String[], String, String, boolean)

replaceDirectoryFilesSubstrings

public static void replaceDirectoryFilesSubstrings(java.lang.String directory,
                                                   java.lang.String[] fileEndings,
                                                   java.lang.String findString,
                                                   java.lang.String replaceString,
                                                   boolean isCaseSensitive)
                                            throws java.io.IOException

Examine the contents of each file in the specified directory whose filename matches any one of the provided fileEndings. Every instance of the findString in these files will be replaced with the replaceString. The file will be decoded in whatever encoding it contains via readLinesFromFile. The replacement file will be written to whatever encoding was detected, or to UTF8 if the encoding was not properly detected. When the file is rewritten, the platform-specific EOL is used.

Parameters:

directory -

fileEndings -

findString -

replaceString -

isCaseSensitive -

Throws:

java.io.IOException

See Also:

readLinesFromFile(String), detectFileEncoding(String), writeStringToFile(String, String, String), writeStringToUTF8File(String, String)

readStringFromSystemFile

public static java.lang.String readStringFromSystemFile(java.lang.String filename)
                                                 throws java.io.FileNotFoundException,
                                                        java.io.IOException

Read file contents into a String. The String is expected to contain all formatting, tabs, and newlines, etc.. and will be returned unmodified. The default System character decoding is assumed.

Parameters:

filename -

Returns:

String contents of file.

Throws:

java.io.FileNotFoundException

java.io.IOException - thrown if an IO error occurs.

See Also:

getSystemBufferedFileReader(String)

readStringFromUTF8File

public static java.lang.String readStringFromUTF8File(java.lang.String filename)
                                               throws java.io.FileNotFoundException,
                                                      java.io.IOException

Read file contents into a String. The String is expected to contain all formatting, tabs, and newlines, etc.. and will be returned unmodified. UTF8 character decoding is assumed.

Parameters:

filename -

Returns:

String contents of file.

Throws:

java.io.FileNotFoundException

java.io.IOException - thrown if an IO error occurs.

See Also:

getUTF8BufferedFileReader(String)

readStringFromEncodingFile

public static java.lang.String readStringFromEncodingFile(java.lang.String filename,
                                                          java.lang.String encoding)
                                                   throws java.io.FileNotFoundException,
                                                          java.io.IOException

Read file contents into a String. The String is expected to contain all formatting, tabs, and newlines, etc.. and will be returned unmodified. Character decoding is given by parameter.

Parameters:

filename -

encoding - The encoding to be used to read a file

Returns:

String contents of file.

Throws:

java.io.FileNotFoundException

java.io.IOException - thrown if an IO error occurs.

See Also:

getUTF8BufferedFileReader(String)

appendProperties

public static java.util.Properties appendProperties(java.util.Properties target,
                                                    java.net.URL url)

Open a new Properties file located at the provided URL and add its entries to those in the target Properties file. If the target Properties file is null then simply return the new Properties file. If the URL is null or an IOException is encountered while opening it then we will simply return the target Properties file unmodified (which might be null.)

Parameters:

target - Properties file to be appended, or null.

url - to Properties file to append.

Returns:

Properties file or null.

isWindowPlatform

public static boolean isWindowPlatform()

getPlatformName

public static java.lang.String getPlatformName()

getExtension

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

Return the lower-case file extension portion of the provided logical file. Ex: ...\Filename.ext will return "ext".

Parameters:

file -

Returns:

the file extension, or null if one cannot be deduced.

unzipFile

public static void unzipFile(java.lang.String zipFileName,
                             java.io.File root,
                             boolean verbose)
                      throws java.io.IOException,
                             java.io.FileNotFoundException

Calls unzipJAR with noMETATDir as false.

Parameters:

zipFileName - String, the 'zip file' to be uncompressed.

root - File, the directory to store the uncompressed files.

verbose - boolean, if the uncompressed message will be printed to console.

Throws:

java.io.IOException

java.io.FileNotFoundException

See Also:

unzipJAR(String, File, boolean, boolean)

unzipJAR

public static void unzipJAR(java.lang.String zipFileName,
                            java.io.File root,
                            boolean verbose,
                            boolean noMETADir)
                     throws java.io.IOException,
                            java.io.FileNotFoundException

Parameters:

zipFileName - String, the 'zip' or 'jar' file to be uncompressed.

root - File, the directory to store the uncompressed files.

verbose - boolean, if the uncompressed message will be printed to console.

noMETADir - true to bypass the META-INF directory and MANIFEST.MF file.

Throws:

java.io.IOException

java.io.FileNotFoundException

unzipJAR

public static void unzipJAR(java.lang.String zipFileName,
                            java.io.File root,
                            boolean verbose,
                            FileUtilities.Predicate<java.lang.String> skipPredicator)
                     throws java.io.IOException,
                            java.io.FileNotFoundException

Parameters:

zipFileName - String, the 'zip' or 'jar' file to be uncompressed.

root - File, the directory to store the uncompressed files.

verbose - boolean, if the uncompressed message will be printed to console.

skipPredicator - Predicate, if its method test(T) returns true, then skip the file when unzip files.

Throws:

java.io.IOException

java.io.FileNotFoundException

copyFile

public static void copyFile(java.io.InputStream in,
                            java.io.OutputStream out)
                     throws java.io.IOException

Parameters:

in - InputStream, The InputStream of the source file to be copied.

out - OutputStream, The OutputStream of the destination file.

Throws:

java.io.IOException

deleteDirectoryRecursively

public static int deleteDirectoryRecursively(java.lang.String directory,
                                             boolean verbose)

Remove directory recursively by JAVA API

Parameters:

directory - String, the directory to be recursively deleted.

verbose - boolean, if the error message will be printed to console.

Returns:

int

copyDirectoryRecursively

public static int copyDirectoryRecursively(java.io.File srcDir,
                                           java.io.File destDir)
                                    throws java.io.IOException,
                                           java.lang.IllegalArgumentException

Careful what you wish for...

Parameters:

srcDir -

destDir -

Returns:

Throws:

java.io.IOException

java.lang.IllegalArgumentException

copyFileToFile

public static void copyFileToFile(java.io.File source,
                                  java.io.File dest)
                           throws java.io.IOException

Attempt to copy a source File to a destination File location. The destination File location will be created if it does not already exist.

Parameters:

source - -- cannot be null and must be a file, not a directory.

dest - -- cannot be null. Will be created if it does not already exist.

Throws:

java.io.IOException - if an error occurs during the attempt.

isArchive

public static boolean isArchive(java.io.File file)
                         throws SAFSException

Return true, if the file has a suffix as one of ARCHIVEFILESUFFIX.

Throws:

SAFSException

isArchive

public static boolean isArchive(java.lang.String filename)
                         throws SAFSException

Return true, if the file has a suffix as one of ARCHIVEFILESUFFIX.

Throws:

SAFSException

isReadOnly

public static boolean isReadOnly(java.io.File file)
                          throws SAFSException

If file can be read and can NOT be wrote, then return true.

Throws:

SAFSException

setFileAttribute

public static boolean setFileAttribute(FileUtilities.FileAttribute attribute,
                                       java.io.File file)
                                throws SAFSException

Parameters:

attribute - FileAttribute, the attribute to set

file - File, the file for which the attributes will be set

Returns:

boolean, true if the setting is successful.

Throws:

SAFSException

deduceMatchingUUIDFilename

public static java.lang.String deduceMatchingUUIDFilename(java.lang.String benchFilename)

Create a unique test/actual filename matching the benchFilename but with a UUID String embedded.

Parameters:

benchFilename - Example: "benchmark.txt"

Returns:

"benchmarkUUIDMARKER.txt"

deduceFile

public static java.io.File deduceFile(java.lang.String filename,
                                      int type,
                                      RuntimeDataInterface data)
                               throws SAFSException

Deduce the absolute full path to a project-relative, test-relative, bench-relative, diff-relative filename.

Parameters:

filename - String, usually a relative path filename.

There is a caveat for test/bench/diff-relative filenames. If there is any File.separator present in the relative path then the path is considered relative to whatever is considered the Datapool directory unless it does not exist, or is already an absolute file path.

If it does not exist as the Datapool directory, or a subdirectory of the Datapool directory, then the path is made relative to the Project directory. A project-relative path is always relative to the actual project root directory unless it is given as an absolute file path.

If the provided filename is an absolute path, and contains a root path that includes the Bench directory, and the filepath sought is of type Test or Diff, then the filename/filepath will be converted to a comparable relative path off the Test or Diff directories as appropriate. This is done to avoid unintentional overwriting of benchmark files by test/actual and diff files.

type - int, the type of the file: test-relative, bench-relative, project-relative.

data - RuntimeDataInterface to access runtime data (directories). Like a subclass of GenericEngine, or Processor.

Returns:

File, the absolute full path test/bench/diff file.

Throws:

SAFSException

See Also:

#FILE_TYPE_TEST}, #FILE_TYPE_BENCH}, #FILE_TYPE_DIFF}, #FILE_TYPE_DATAPOOL}, #FILE_TYPE_PROJECT}

deduceTestFile

public static java.io.File deduceTestFile(java.lang.String filename,
                                          RuntimeDataInterface data)
                                   throws SAFSException

Deduce the absolute full path test-relative file.

Parameters:

filename - String, the test/actual file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path.

If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.

If it is an absolute path, and contains a root path that includes the Bench directory, then the file will be converted to a comparable relative path off the Test directory.

data - RuntimeDataInterface to access runtime data (directories). Like a subclass of GenericEngine, or Processor.

Returns:

File, the absolute full path test file.

Throws:

SAFSException

See Also:

#deduceFile(String, int, RuntimeDataInterface)}

deduceDiffFile

public static java.io.File deduceDiffFile(java.lang.String filename,
                                          RuntimeDataInterface data)
                                   throws SAFSException

Deduce the absolute full path Diff-relative file.

Parameters:

filename - String, the diff file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path.

If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.

If it is an absolute path, and contains a root path that includes the Bench directory, then the file will be converted to a comparable relative path off the Diff directory.

data - RuntimeDataInterface to access runtime data (directories). Like a subclass of GenericEngine, or Processor.

Returns:

File, the absolute full path diff file.

Throws:

SAFSException

See Also:

#deduceFile(String, int, RuntimeDataInterface)}

deduceBenchFile

public static java.io.File deduceBenchFile(java.lang.String filename,
                                           RuntimeDataInterface data)
                                    throws SAFSException

Deduce the absolute full path bench-relative file.

Parameters:

filename - String, the test file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path. If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.

data - RuntimeDataInterface to access runtime data (directories). Like a subclass of GenericEngine, or Processor.

Returns:

File, the absolute full path bench file.

Throws:

SAFSException

See Also:

#deduceFile(String, int, RuntimeDataInterface)}

deduceProjectFile

public static java.io.File deduceProjectFile(java.lang.String filename,
                                             RuntimeDataInterface data)
                                      throws SAFSException

Deduce the absolute full path to a project-relative file.

Parameters:

filename - String, the test file name. The path is ALWAYS considered relative to the project root directory regardless of the absence or presence of File.separators unless the file is already an absolute path.

data - RuntimeDataInterface to access runtime data (directories). Like a subclass of GenericEngine, or Processor.

Returns:

File, the absolute full path bench file.

Throws:

SAFSException

See Also:

#deduceFile(String, int, RuntimeDataInterface)}

deduceDatapoolFile

public static java.io.File deduceDatapoolFile(java.lang.String filename,
                                              RuntimeDataInterface data)
                                       throws SAFSException

Deduce the absolute full path datapool-relative file.

Parameters:

filename - String, the data file name. It can contain sub directories.

data - RuntimeDataInterface to access runtime data (directories). Like a subclass of GenericEngine, or Processor.

Returns:

File, the absolute full path datapool file.

Throws:

SAFSException

See Also:

#deduceFile(String, int, RuntimeDataInterface)}

getFileAttribute

public static FileUtilities.FileAttribute getFileAttribute(java.io.File file)
                                                    throws SAFSException

Parameters:

file - File, the file to extract the attribute information.

Returns:

FileAttribute, the file's attributes

Throws:

SAFSException