FileUtil (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.file.FileUtil

```
public class FileUtil
extends java.lang.Object
```
This class provides helper methods for file and stream handling. It's an add-on to the java.io package. The service is implemented as a singleton, so use the FileUtil.current() method to get the sole instance.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASSPATH_PREFIX` Defines the prefix that specifies that the remaining part of the string with that prefix is a file name that must be looked-up using the current classloader: "classpath:".
`static int`	`DEFAULT_BUFFER_SIZE`
`static java.lang.String`	`DEFAULT_TEMP_FILE_PREFIX` The constant that contains the default prefix for temporary file.
`static java.lang.String`	`DEFAULT_URL_STR_ENCODING` Contains the default URL string encoding used in this class: "UTF-8"
`protected static StringPattern`	`DRIVE_LETTER_PATTERN_1`
`protected static StringPattern`	`DRIVE_LETTER_PATTERN_2`
`protected static java.lang.String`	`FILE_PROTOCOL_INDICATOR`
`static FileUtil`	`FU`
`protected static StringPattern`	`JAR_PATTERN`
`static java.lang.String`	`LINE_SEPARATOR` The lines.separator from the system properties as a constant
`protected static StringPattern`	`LOCAL_PATTERN`
`protected static java.lang.Long`	`NO_LIMIT`
`protected static StringPattern`	`REMOTE_PATTERN`
`protected static StringPattern`	`WINDOWS_DRIVE_PATTERN_1`
`protected static StringPattern`	`WINDOWS_DRIVE_PATTERN_2`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FileUtil()` Initialize the new instance with default values.
	`FileUtil(java.lang.ClassLoader classLoader)` Create a new instance with with an external classloader.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`appendClasspathEntriesFrom(java.util.Collection<java.lang.String> elements, java.lang.Object bundleLoader)`
`protected void`	`assertArgumentNotNull(java.lang.String argName, java.lang.Object arg)`
`Classpath`	`calculateClasspath()` Returns the current classpath.
`protected Classpath`	`calculateEclipseClasspath()`
`protected java.lang.String`	`classpathFromManifest(java.lang.String jarFilename)` Returns the classpath definition from the manifest file in the specified JAR or null if not found.
`long`	`cleanDirectory(java.io.File dir)` Deletes all files and sub-directories in the given directory.
`long`	`cleanDirectory(java.io.File dir, boolean filesOnly)` Deletes all files (and optionally sub-directories) in the given directory.
`boolean`	`close(java.io.Closeable closeable)` Close the given closeable ignoring any exception and checking for null before closing.
`boolean`	`close(java.util.zip.ZipFile zipFile)` Close the given ZIP file ignoring any exception.
`boolean`	`closeEntry(java.util.zip.ZipInputStream zipInStream)` Close the current entry in the given ZIP input stream ignoring any exception.
`boolean`	`closeEntry(java.util.zip.ZipOutputStream zipOutStream)` Close the current entry in the given ZIP output stream ignoring any exception.
`protected java.lang.String`	`constructClasspathFrom(java.lang.String jarFilename)`
`java.io.File`	`convertFromURLSyntax(java.io.File file)` Converts the given file from URL syntax to normal file system syntax.
`java.lang.String`	`convertFromURLSyntax(java.lang.String filename)` Converts the given filename from URL syntax to normal file system syntax.
`java.lang.String`	`convertToURLSyntax(java.lang.String filename)` Converts the given filename to URL syntax.
`long`	`copyAll(java.io.File sourceFolder, java.io.File targetFolder)` Copies all files and folders (recursively) from the sourceFolder to the targetFolder.
`void`	`copyFile(java.io.File sourceFile, java.io.File destFile)` Copies the whole contents of the file specified by sourceFile to the file specified by destFile.
`void`	`copyFile(java.io.File sourceFile, java.io.File destFile, boolean preserveTimestamp)` Copies the whole contents of the file specified by sourceFile to the file specified by destFile.
`void`	`copyFile(FileLocator sourceFile, java.io.File destFile, boolean preserveTimestamp)` Copies the whole contents of the file specified by sourceFile to the file specified by destFile.
`void`	`copyFile(java.lang.String sourceFilename, java.lang.String destFilename)` Copies the whole contents of the file specified by sourceFilename to the file specified by destFilename.
`void`	`copyFile(java.lang.String sourceFilename, java.lang.String destFilename, boolean preserveTimestamp)` Copies the whole contents of the file specified by sourceFilename to the file specified by destFilename.
`void`	`copyFile(java.net.URL source, java.io.File destFile)` Copies the whole contents of the file specified by source URL to the file specified by destFile.
`void`	`copyStream(java.io.InputStream inStream, java.io.OutputStream outStream)` Copies all data from the input stream to the output stream using a buffer with the default size (4096 bytes).
`void`	`copyStream(java.io.InputStream inStream, java.io.OutputStream outStream, int bufSize)` Copies all data from the input stream to the output stream using a buffer of the given size in bytes.
`void`	`copyStream(java.io.InputStream inStream, java.io.OutputStream outStream, int bufSize, java.lang.Long limit)` Copies all data from the input stream to the output stream using a buffer of the given size in bytes.
`protected void`	`copyText(java.io.InputStream inStream, java.nio.charset.Charset charset, java.io.StringWriter writer)`
`protected void`	`copyText(java.io.InputStream inStream, CheckedCharsetName charsetName, java.io.StringWriter writer)`
`protected void`	`copyText(java.io.InputStream inStream, java.io.StringWriter writer)`
`void`	`copyText(java.io.Reader reader, java.io.StringWriter writer)` Copies all text lines from the specified reader to the given writer.
`java.io.File`	`copyToTempFile(java.io.InputStream inStream)` Copies the contents of the given inStream to a temporary file and returns this temporary file.
`java.io.File`	`copyToTempFile(java.io.InputStream inStream, java.lang.String filePrefix)` Copies the contents of the given inStream to a temporary file and returns this temporary file.
`java.io.File`	`copyToTempFile(java.io.InputStream inStream, java.lang.String filePrefix, java.lang.String fileSuffix)` Copies the contents of the given inStream to a temporary file and returns this temporary file.
`java.io.File`	`copyToTempFile(java.io.InputStream inStream, java.lang.String filePrefix, java.lang.String fileSuffix, boolean deleteOnExit)` Copies the contents of the given inStream to a temporary file and returns this temporary file.
`java.io.File`	`copyToTempFile(java.lang.String filename, java.lang.String filePrefix, java.lang.String fileSuffix, boolean deleteOnExit)` Copies the contents of the file specified by filename to a temporary file and returns this temporary file.
`protected java.lang.String`	`createClasspathFrom(java.lang.String path)`
`void`	`createFile(java.io.File file, byte... content)` Creates the file and writes the given content to it.
`void`	`createFile(java.io.InputStream inStream, java.io.File file)` Creates the file and writes the given stream to it.
`void`	`createFile(java.io.InputStream inStream, java.io.File file, int bufferSize, java.lang.Long limit)` Creates the file and writes the given stream to it.
`protected Classpath`	`createSystemClasspath()`
`static FileUtil`	`current()` Returns the default instance of this class.
`protected Classpath`	`determineLookupClasspath(java.lang.String sysPropName)`
`boolean`	`ensureEmptyFolder(java.io.File folder)` Ensures that the specified folder exists and is empty.
`boolean`	`ensureFolderExists(java.io.File folder)` Ensures that the specified folder exists.
`void`	`extractZipArchive(java.io.File zipFile, java.io.File destDir)` Copies all files from the given zip archive to the specified destination directory.
`void`	`extractZipArchive(java.io.File zipFile, java.io.File destDir, IZipEntryFilter filter)` Copies all files from the given zip archive that match the given filter to the specified destination directory.
`void`	`extractZipArchive(java.util.zip.ZipInputStream zipInStream, java.io.File destDir, IZipEntryFilter filter)` Copies all files from the given zip archive that match the given filter to the specified destination directory.
`java.util.Collection<java.lang.String>`	`findZippedFiles(java.io.File zipFile, IZipEntryFilter filter)` Returns all (full-path) names of file entries in the given zipFile that match the specified filter.
`java.lang.String`	`getClasspath()` Returns the current classpath as String.
`protected java.lang.String`	`getClasspathFromSystemProperty()` Returns the classpath this JVM is using.
`protected java.lang.ClassLoader`	`getCurrentClassLoader()`
`Classpath`	`getLookupPath(java.lang.String sysPropName)` Returns a class path that is either the value of the specified system property or the classpath calculated from the current Java environment.
`java.lang.String`	`getRelativePath(java.io.File dir, java.io.File fileBelowDir)` Returns the relative path of the given fileBelowDir in relation to the specified directory.
`protected void`	`handleException(java.lang.Exception ex)`
`protected int`	`indexOfPreceedingNotNullElement(java.lang.String[] elements, int start)`
`protected IOUtil`	`ioUtil()`
`boolean`	`isExistingFolder(java.io.File folder)` Returns true if the given folder is an existing folder on the file system.
`boolean`	`isExistingFolder(java.lang.String path)` Returns true if the given path is an existing folder on the file system.
`boolean`	`isInsideJavaArchive(java.lang.String filename)` Returns true if the given filename specifies a file (or directory) that is located inside a JAR file.
`boolean`	`isLocal(java.lang.String filename)` Returns true if the given filename specifies a file (or directory) on the local file system.
`boolean`	`isLocalFileURL(java.lang.String filename)` Returns true if the given filename specifies a file (or directory) on the local file system using the URL syntax such as "file:/usr/bin/run" or "file:\C:\temp\readme.txt.
`boolean`	`isRemote(java.lang.String filename)` Returns true if the given filename specifies a file (or directory) on a remote system.
`java.lang.String`	`javaFilename(java.lang.String filename)` Returns the given filename in the platform independent way that Java understands.
`java.lang.String[]`	`javaFilenames(java.lang.String[] filenames)` Returns a new array of filenames where all backslashes are replaced by forward slashes.
`IConfigSettings`	`loadNamedValuesFrom(java.lang.String filename)` Loads all properties form the file with the given name. If the filename contains the prefix "classpath:" then it will be looked-up using the underlying current classloader.
`java.util.Properties`	`loadPropertiesFrom(java.lang.String filename)` Loads all properties form the file with the given name. If the filename contains the prefix "classpath:" the it will be looked-up using the underlying current classloader.
`java.io.InputStream`	`openFile(java.lang.String filename)` Opens the file with the given name and returns it as an input stream. If the filename contains the prefix "classpath:" then it will be looked-up using the underlying current classloader.
`NamedInputStream`	`openFileForRead(java.lang.String filename)` Opens the file with the given name and returns it as a named input stream. If the filename contains the prefix "classpath:" then it will be looked-up using the underlying current classloader.
`void`	`processTextLines(java.io.InputStream inStream, java.nio.charset.Charset charset, ILineProcessor processor)` Reads all text lines from the specified input stream and passes them one by one to the given line processor.
`void`	`processTextLines(java.io.InputStream inStream, ICheckedCharset charsetName, ILineProcessor processor)` Reads all text lines from the specified input stream and passes them one by one to the given line processor.
`void`	`processTextLines(java.io.InputStream inStream, ILineProcessor processor)` Reads all text lines from the specified input stream and passes them one by one to the given line processor.
`void`	`processTextLines(java.io.Reader reader, ILineProcessor processor)` Reads all text lines from the specified reader and passes them one by one to the given line processor.
`void`	`processTextLines(java.lang.String filename, ICheckedCharset charsetName, ILineProcessor processor)` Reads all text lines from the file with the specified name and passes them one by one to the given line processor.
`void`	`processTextLines(java.lang.String filename, ILineProcessor processor)` Reads all text lines from the file with the specified name and passes them one by one to the given line processor.
`java.lang.String`	`readTextFrom(java.io.File file)` Reads the whole content of the specified file and returns it as a string.
`java.lang.String`	`readTextFrom(java.io.File file, java.nio.charset.Charset charset)` Reads the whole content of the specified file and returns it as a string.
`java.lang.String`	`readTextFrom(java.io.File file, ICheckedCharset charsetName)` Reads the whole content of the specified file and returns it as a string.
`java.lang.String`	`readTextFrom(FileLocator fileLocator)` Reads the whole content of the specified file and returns it as a string.
`java.lang.String`	`readTextFrom(FileLocator fileLocator, java.nio.charset.Charset charset)` Reads the whole content of the specified file and returns it as a string.
`java.lang.String`	`readTextFrom(FileLocator fileLocator, ICheckedCharset charsetName)` Reads the whole content of the specified file and returns it as a string.
`java.lang.String`	`readTextFrom(java.io.InputStream inStream)` Reads the whole content of the given input stream and returns it as a string.
`java.lang.String`	`readTextFrom(java.io.InputStream inStream, java.nio.charset.Charset charset)` Reads the whole content of the given input stream and returns it as a string.
`java.lang.String`	`readTextFrom(java.io.InputStream inStream, ICheckedCharset charsetName)` Reads the whole content of the given input stream and returns it as a string.
`java.lang.String`	`readTextFrom(java.lang.String filename)` Reads the whole content of the file with the given name and returns it as a string.
`java.lang.String`	`readTextFrom(java.lang.String filename, java.nio.charset.Charset charset)` Reads the whole content of the file with the given name and returns it as a string.
`java.lang.String`	`readTextFrom(java.lang.String filename, ICheckedCharset charsetName)` Reads the whole content of the file with the given name and returns it as a string.
`java.lang.String[]`	`readTextLinesFrom(java.io.File file)` Reads all text lines from the specified file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.File file, java.nio.charset.Charset charset)` Reads all text lines from the specified file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.File file, java.nio.charset.Charset charset, IStringFilter filter)` Reads all text lines matching the filter from the specified file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.File file, ICheckedCharset charsetName)` Reads all text lines from the specified file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.File file, ICheckedCharset charsetName, IStringFilter filter)` Reads all text lines matching the filter from the specified file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.File file, IStringFilter filter)` Reads all text lines matching the filter from the specified file into a String array.
`java.lang.String[]`	`readTextLinesFrom(FileLocator fileLocator)` Reads all text lines from the specified file location into a String array.
`java.lang.String[]`	`readTextLinesFrom(FileLocator fileLocator, java.nio.charset.Charset charset, IStringFilter filter)` Reads all text lines matching the filter from the specified file location into a String array.
`java.lang.String[]`	`readTextLinesFrom(FileLocator fileLocator, ICheckedCharset charsetName)` Reads all text lines from the specified file location into a String array.
`java.lang.String[]`	`readTextLinesFrom(FileLocator fileLocator, ICheckedCharset charsetName, IStringFilter filter)` Reads all text lines matching the filter from the specified file location into a String array.
`java.lang.String[]`	`readTextLinesFrom(FileLocator fileLocator, IStringFilter filter)` Reads all text lines matching the filter from the specified file location into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.InputStream inStream)` Reads all text lines from the specified stream into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.InputStream inStream, java.nio.charset.Charset charset)` Reads all text lines from the specified stream into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.InputStream inStream, java.nio.charset.Charset charset, IStringFilter filter)` Reads all text lines matching the filter from the specified stream into a String array using the specified character encoding.
`java.lang.String[]`	`readTextLinesFrom(java.io.InputStream inStream, ICheckedCharset charsetName)` Reads all text lines from the specified stream into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.InputStream inStream, ICheckedCharset charsetName, IStringFilter filter)` Reads all text lines matching the filter from the specified stream into a String array using the specified character encoding.
`java.lang.String[]`	`readTextLinesFrom(java.io.InputStream inStream, IStringFilter filter)` Reads all text lines matching the filter from the specified stream into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.Reader reader)` Reads all text lines from the specified reader into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.io.Reader reader, IStringFilter filter)` Reads all text lines that match the filter from the specified reader into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.lang.String filename)` Reads all text lines from the named file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.lang.String filename, java.nio.charset.Charset charset)` Reads all text lines from the named file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.lang.String filename, java.nio.charset.Charset charset, IStringFilter filter)` Reads all text lines from the named file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.lang.String filename, ICheckedCharset charsetName)` Reads all text lines from the named file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.lang.String filename, ICheckedCharset charsetName, IStringFilter filter)` Reads all text lines from the named file into a String array.
`java.lang.String[]`	`readTextLinesFrom(java.lang.String filename, IStringFilter filter)` Reads all text lines from the named file into a String array.
`protected ReflectUtil`	`reflect()`
`long`	`removeDirectory(java.io.File dir)` Deletes all files and sub-directories in the given directory and the directory itself.
`java.lang.String`	`standardize(java.lang.String filename)` Convert the filename to a canonical (see java.io.File.getCanonicalPath()) format and replace any backslashes '\' by slashes ('/').
`java.lang.String[]`	`standardize(java.lang.String[] filenames)` Convert all the given filenames to a canonical (see java.io.File.getCanonicalPath()) format and replace any backslashes '\' by slashes ('/').
`protected java.lang.String`	`standardizeFilename(java.lang.String filename)`
`protected StringUtil`	`str()`
`java.lang.String`	`urlDecode(java.lang.String str)` Returns the given string with all %xx placeholders decoded.
`java.lang.String`	`urlDecode(java.lang.String str, ICheckedCharset charsetName)` Returns the given string with all %xx placeholders decoded using the specified charset encoding.
`java.lang.String`	`urlEncode(java.lang.String str)` Returns the given string with all characters that are not allowed directly in URLs encoded as %xx placeholders.
`java.lang.String`	`urlEncode(java.lang.String str, ICheckedCharset charsetName)` Returns the given string with all characters that are not allowed directly in URLs encoded as %xx placeholders.

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

- Field Detail
  - FU
```
public static final FileUtil FU
```
  - LINE_SEPARATOR
```
public static final java.lang.String LINE_SEPARATOR
```
    The lines.separator from the system properties as a constant
  - DEFAULT_BUFFER_SIZE
```
public static final int DEFAULT_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TEMP_FILE_PREFIX
```
public static final java.lang.String DEFAULT_TEMP_FILE_PREFIX
```
    The constant that contains the default prefix for temporary file. It is "PFFU" (Programmer's Friend FileUtil).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_URL_STR_ENCODING
```
public static final java.lang.String DEFAULT_URL_STR_ENCODING
```
    Contains the default URL string encoding used in this class: "UTF-8"
    
    See Also:
    
    Constant Field Values
  - CLASSPATH_PREFIX
```
public static final java.lang.String CLASSPATH_PREFIX
```
    Defines the prefix that specifies that the remaining part of the string with that prefix is a file name that must be looked-up using the current classloader: "classpath:".
    
    See Also:
    
    Constant Field Values
  - FILE_PROTOCOL_INDICATOR
```
protected static final java.lang.String FILE_PROTOCOL_INDICATOR
```
    See Also:
    
    Constant Field Values
  - LOCAL_PATTERN
```
protected static final StringPattern LOCAL_PATTERN
```
  - REMOTE_PATTERN
```
protected static final StringPattern REMOTE_PATTERN
```
  - JAR_PATTERN
```
protected static final StringPattern JAR_PATTERN
```
  - DRIVE_LETTER_PATTERN_1
```
protected static final StringPattern DRIVE_LETTER_PATTERN_1
```
  - DRIVE_LETTER_PATTERN_2
```
protected static final StringPattern DRIVE_LETTER_PATTERN_2
```
  - WINDOWS_DRIVE_PATTERN_1
```
protected static final StringPattern WINDOWS_DRIVE_PATTERN_1
```
  - WINDOWS_DRIVE_PATTERN_2
```
protected static final StringPattern WINDOWS_DRIVE_PATTERN_2
```
  - NO_LIMIT
```
protected static final java.lang.Long NO_LIMIT
```
- Constructor Detail
  - FileUtil
```
public FileUtil(java.lang.ClassLoader classLoader)
```
    Create a new instance with with an external classloader.
  - FileUtil
```
protected FileUtil()
```
    Initialize the new instance with default values.
- Method Detail
  - current
```
public static FileUtil current()
```
    Returns the default instance of this class. This instance is internally using the same classloader that was used to load FileUtil class.
  - createFile
```
public void createFile(java.io.File file,
                       byte... content)
                throws java.io.IOException
```
    Creates the file and writes the given content to it.
    
    Parameters:
    
    file - The file to be created (must not be null).
    
    content - The (optional) content to be written to the file.
    
    Throws:
    
    java.io.IOException
  - createFile
```
public void createFile(java.io.InputStream inStream,
                       java.io.File file)
                throws java.io.IOException
```
    Creates the file and writes the given stream to it. Afterwards the inStream will be closed.
    
    Parameters:
    
    inStream - The stream to be written to the file.
    
    file - The file to be created (must not be null).
    
    Throws:
    
    java.io.IOException
  - createFile
```
public void createFile(java.io.InputStream inStream,
                       java.io.File file,
                       int bufferSize,
                       java.lang.Long limit)
                throws java.io.IOException
```
    Creates the file and writes the given stream to it. Afterwards the inStream (and the file stream) will be closed.
    
    Parameters:
    
    inStream - The stream to be written to the file.
    
    file - The file to be created (must not be null).
    
    bufferSize - The size of the buffer that is used for the transfer of byte chunks (must be a positive value).
    
    limit - The maximum number of bytes that will be copied. If exceeded an IOException will be thrown. Setting this parameter to null, zero or a negative value will specify no limit.
    
    Throws:
    
    java.io.IOException
  - copyStream
```
public void copyStream(java.io.InputStream inStream,
                       java.io.OutputStream outStream)
                throws java.io.IOException
```
    Copies all data from the input stream to the output stream using a buffer with the default size (4096 bytes). After all data is copied both streams will be closed !
    
    Throws:
    
    java.io.IOException
  - copyStream
```
public void copyStream(java.io.InputStream inStream,
                       java.io.OutputStream outStream,
                       int bufSize)
                throws java.io.IOException
```
    Copies all data from the input stream to the output stream using a buffer of the given size in bytes. After all data has been copied both streams will be closed!
    
    Throws:
    
    java.io.IOException
  - copyStream
```
public void copyStream(java.io.InputStream inStream,
                       java.io.OutputStream outStream,
                       int bufSize,
                       java.lang.Long limit)
                throws java.io.IOException
```
    Copies all data from the input stream to the output stream using a buffer of the given size in bytes. After all data has been copied both streams will be closed!
    
    Parameters:
    
    inStream - The source stream.
    
    outStream - The target stream.
    
    bufSize - The size of the buffer that is used for the transfer of byte chunks (must be positive value).
    
    limit - The maximum number of bytes that will be copied. If exceeded an IOException will be thrown. Setting this parameter to null, zero or a negative value will specify no limit.
    
    Throws:
    
    java.io.IOException
  - copyFile
```
public void copyFile(java.io.File sourceFile,
                     java.io.File destFile,
                     boolean preserveTimestamp)
              throws java.io.IOException
```
    Copies the whole contents of the file specified by sourceFile to the file specified by destFile. If destFile already exists, it will be overwritten without warning! If preservetimestamp is true, the last modified time of the destFile will be set to that of the sourceFile. Otherwise it will be the current date.
    
    Parameters:
    
    sourceFile - The file to copy
    
    destFile - The destination where to copy the file content
    
    preserveTimestamp - A flag that indicates if destFile must have the same timestamp as sourceFile
    
    Throws:
    
    java.io.IOException
  - copyFile
```
public void copyFile(FileLocator sourceFile,
                     java.io.File destFile,
                     boolean preserveTimestamp)
              throws java.io.IOException
```
    Copies the whole contents of the file specified by sourceFile to the file specified by destFile. If destFile already exists, it will be overwritten without warning! If preservetimestamp is true, the last modified time of the destFile will be set to that of the sourceFile. Otherwise it will be the current date.
    
    Parameters:
    
    sourceFile - The file to copy
    
    destFile - The destination where to copy the file content
    
    preserveTimestamp - A flag that indicates if destFile must have the same timestamp as sourceFile
    
    Throws:
    
    java.io.IOException
  - copyFile
```
public void copyFile(java.net.URL source,
                     java.io.File destFile)
              throws java.io.IOException
```
    Copies the whole contents of the file specified by source URL to the file specified by destFile. If destFile already exists, it will be overwritten without warning!
    
    Parameters:
    
    source - An URL that specifies the source file that must be copied
    
    destFile - The destination where to copy the file content
    
    Throws:
    
    java.io.IOException
  - copyFile
```
public void copyFile(java.io.File sourceFile,
                     java.io.File destFile)
              throws java.io.IOException
```
    Copies the whole contents of the file specified by sourceFile to the file specified by destFile. If destFile already exists, it will be overwritten without warning! The modification timestamp of destFile will be the current date.
    
    Parameters:
    
    sourceFile - The file to copy
    
    destFile - The destination where to copy the file content
    
    Throws:
    
    java.io.IOException
  - copyFile
```
public void copyFile(java.lang.String sourceFilename,
                     java.lang.String destFilename,
                     boolean preserveTimestamp)
              throws java.io.IOException
```
    Copies the whole contents of the file specified by sourceFilename to the file specified by destFilename. If destFilename already exists, it will be overwritten without warning! If preservetimestamp is true, the last modified time of the destFilename will be set to that of the sourceFilename. Otherwise it will be the current date.
    
    Parameters:
    
    sourceFilename - The file to copy
    
    destFilename - The destinition where to copy the file content
    
    preserveTimestamp - A flag that indicates if destFile must have the same timestamp as sourceFile
    
    Throws:
    
    java.io.IOException
  - copyFile
```
public void copyFile(java.lang.String sourceFilename,
                     java.lang.String destFilename)
              throws java.io.IOException
```
    Copies the whole contents of the file specified by sourceFilename to the file specified by destFilename. If destFilename already exists, it will be overwritten without warning! The modification timestamp of destFilename will be the current date.
    
    Parameters:
    
    sourceFilename - The file to copy
    
    destFilename - The destinition where to copy the file content
    
    Throws:
    
    java.io.IOException
  - copyAll
```
public long copyAll(java.io.File sourceFolder,
                    java.io.File targetFolder)
```
    Copies all files and folders (recursively) from the sourceFolder to the targetFolder. The target folder will be created if necessary.
    
    Returns:
    
    The number of files copied.
  - findZippedFiles
```
public java.util.Collection<java.lang.String> findZippedFiles(java.io.File zipFile,
                                                              IZipEntryFilter filter)
                                                       throws java.io.IOException
```
    Returns all (full-path) names of file entries in the given zipFile that match the specified filter.
    
    Parameters:
    
    zipFile - The zip file to look for the matching entries (must not be null).
    
    filter - The filter that defines which names to return (must not be null).
    
    Returns:
    
    A collection of the found names (never null).
    
    Throws:
    
    java.io.IOException - In case of errors with the zip file handling.
  - extractZipArchive
```
public void extractZipArchive(java.io.File zipFile,
                              java.io.File destDir)
                       throws java.io.IOException
```
    Copies all files from the given zip archive to the specified destination directory.
    
    Parameters:
    
    zipFile - The file to be extracted (must not be null).
    
    destDir - The file directory to which to extract the files (must not be null).
    
    Throws:
    
    java.io.IOException
  - extractZipArchive
```
public void extractZipArchive(java.io.File zipFile,
                              java.io.File destDir,
                              IZipEntryFilter filter)
                       throws java.io.IOException
```
    Copies all files from the given zip archive that match the given filter to the specified destination directory.
    
    Parameters:
    
    zipFile - The file to be extracted (must not be null).
    
    destDir - The file directory to which to extract the files (must not be null).
    
    filter - An optional filter - only matching entries will be extracted (may be null for all matching).
    
    Throws:
    
    java.io.IOException
  - extractZipArchive
```
public void extractZipArchive(java.util.zip.ZipInputStream zipInStream,
                              java.io.File destDir,
                              IZipEntryFilter filter)
                       throws java.io.IOException
```
    Copies all files from the given zip archive that match the given filter to the specified destination directory. The zipInStream will NOT be closed after this method has finished!
    
    Parameters:
    
    zipInStream - The opened stream on the zip file to be extracted (must not be null).
    
    destDir - The file directory to which to extract the files (must not be null).
    
    filter - An optional filter - only matching entries will be extracted (may be null for all matching).
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.io.InputStream inStream)
                              throws java.io.IOException
```
    Reads the whole content of the given input stream and returns it as a string. The stream will be closed after calling this method. Even if an exception occurred! The stream character encoding is the JVM default encoding.
    
    Parameters:
    
    inStream - The input stream to read.
    
    Returns:
    
    The text content of the given stream.
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.io.InputStream inStream,
                                     ICheckedCharset charsetName)
                              throws java.io.IOException
```
    Reads the whole content of the given input stream and returns it as a string. The stream will be closed after calling this method. Even if an exception occurred!
    
    Parameters:
    
    inStream - The input stream to read (must not be null).
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    Returns:
    
    The text content of the given stream
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.io.InputStream inStream,
                                     java.nio.charset.Charset charset)
                              throws java.io.IOException
```
    Reads the whole content of the given input stream and returns it as a string. The stream will be closed after calling this method. Even if an exception occurred!
    
    Parameters:
    
    inStream - The input stream to read (must not be null).
    
    charset - A character set defining the encoding of the stream (must not be null).
    
    Returns:
    
    The text content of the given stream.
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.lang.String filename)
                              throws java.io.IOException
```
    Reads the whole content of the file with the given name and returns it as a string. The file character encoding is the JVM default encoding.
    
    Parameters:
    
    filename - The name of the text containing file
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.lang.String filename,
                                     java.nio.charset.Charset charset)
                              throws java.io.IOException
```
    Reads the whole content of the file with the given name and returns it as a string.
    
    Parameters:
    
    filename - The name of the text containing file (must not be null).
    
    charset - A character set defining the file encoding (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.lang.String filename,
                                     ICheckedCharset charsetName)
                              throws java.io.IOException
```
    Reads the whole content of the file with the given name and returns it as a string.
    
    Parameters:
    
    filename - The name of the text containing file
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.io.File file)
                              throws java.io.IOException
```
    Reads the whole content of the specified file and returns it as a string. The file character encoding is the JVM default encoding.
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.io.File file,
                                     ICheckedCharset charsetName)
                              throws java.io.IOException
```
    Reads the whole content of the specified file and returns it as a string.
    
    Parameters:
    
    file - The text file from which to read (must not be null).
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(java.io.File file,
                                     java.nio.charset.Charset charset)
                              throws java.io.IOException
```
    Reads the whole content of the specified file and returns it as a string.
    
    Parameters:
    
    file - The text file from which to read (must not be null).
    
    charset - A character set defining the file encoding (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(FileLocator fileLocator)
                              throws java.io.IOException
```
    Reads the whole content of the specified file and returns it as a string. The file character encoding is the JVM default encoding.
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(FileLocator fileLocator,
                                     ICheckedCharset charsetName)
                              throws java.io.IOException
```
    Reads the whole content of the specified file and returns it as a string.
    
    Parameters:
    
    fileLocator - The locator of the text file to read (must not be null).
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextFrom
```
public java.lang.String readTextFrom(FileLocator fileLocator,
                                     java.nio.charset.Charset charset)
                              throws java.io.IOException
```
    Reads the whole content of the specified file and returns it as a string.
    
    Parameters:
    
    fileLocator - The locator of the text file to read (must not be null).
    
    charset - A character set defining the encoding of the file (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.lang.String filename)
                                     throws java.io.IOException
```
    Reads all text lines from the named file into a String array. The file character encoding is the JVM default encoding.
    
    Parameters:
    
    filename - The name of the file from which to read the text lines
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.lang.String filename,
                                            ICheckedCharset charsetName)
                                     throws java.io.IOException
```
    Reads all text lines from the named file into a String array.
    
    Parameters:
    
    filename - The name of the file from which to read the text lines
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.lang.String filename,
                                            java.nio.charset.Charset charset)
                                     throws java.io.IOException
```
    Reads all text lines from the named file into a String array.
    
    Parameters:
    
    filename - The name of the file from which to read the text lines (must not be null).
    
    charset - A character set defining the encoding of the file (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.File file)
                                     throws java.io.IOException
```
    Reads all text lines from the specified file into a String array. The file character encoding is the JVM default encoding.
    
    Parameters:
    
    file - The file from which to read the text lines.
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.File file,
                                            ICheckedCharset charsetName)
                                     throws java.io.IOException
```
    Reads all text lines from the specified file into a String array.
    
    Parameters:
    
    file - The file from which to read the text lines
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.File file,
                                            java.nio.charset.Charset charset)
                                     throws java.io.IOException
```
    Reads all text lines from the specified file into a String array.
    
    Parameters:
    
    file - The file from which to read the text lines (must not be null).
    
    charset - A character set defining the encoding of the file (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(FileLocator fileLocator)
                                     throws java.io.IOException
```
    Reads all text lines from the specified file location into a String array. The file character encoding is the JVM default encoding.
    
    Parameters:
    
    fileLocator - The file from which to read the text lines
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(FileLocator fileLocator,
                                            ICheckedCharset charsetName)
                                     throws java.io.IOException
```
    Reads all text lines from the specified file location into a String array.
    
    Parameters:
    
    fileLocator - The file from which to read the text lines
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.InputStream inStream)
                                     throws java.io.IOException
```
    Reads all text lines from the specified stream into a String array. After that the stream will be closed. Even if an exception occurs. The character encoding is the JVM default encoding.
    
    Parameters:
    
    inStream - The stream from which to read the text lines
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.InputStream inStream,
                                            ICheckedCharset charsetName)
                                     throws java.io.IOException
```
    Reads all text lines from the specified stream into a String array. After that the stream will be closed. Even if an exception occurs.
    
    Parameters:
    
    inStream - The stream from which to read the text lines
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.InputStream inStream,
                                            java.nio.charset.Charset charset)
                                     throws java.io.IOException
```
    Reads all text lines from the specified stream into a String array. After that the stream will be closed. Even if an exception occurs.
    
    Parameters:
    
    inStream - The stream from which to read the text lines (must not be null).
    
    charset - A character set defining the encoding of the stream (must not be null).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.Reader reader)
                                     throws java.io.IOException
```
    Reads all text lines from the specified reader into a String array. After that the reader will be closed. Even if an exception occurs.
    
    Parameters:
    
    reader - The reader which provides the text
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.lang.String filename,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines from the named file into a String array. The character encoding is the JVM default encoding.
    
    Parameters:
    
    filename - The name of the file from which to read the text lines
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.lang.String filename,
                                            ICheckedCharset charsetName,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines from the named file into a String array.
    
    Parameters:
    
    filename - The name of the file from which to read the text lines
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.lang.String filename,
                                            java.nio.charset.Charset charset,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines from the named file into a String array.
    
    Parameters:
    
    filename - The name of the file from which to read the text lines
    
    charset - A character set defining the file encoding (must not be null).
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.File file,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified file into a String array. The character encoding is the JVM default encoding.
    
    Parameters:
    
    file - The file from which to read the text lines
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.File file,
                                            ICheckedCharset charsetName,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified file into a String array.
    
    Parameters:
    
    file - The file from which to read the text lines
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.File file,
                                            java.nio.charset.Charset charset,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified file into a String array.
    
    Parameters:
    
    file - The file from which to read the text lines (must not be null).
    
    charset - A character set defining the encoding of the file (must not be null).
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(FileLocator fileLocator,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified file location into a String array. The character encoding is the JVM default encoding.
    
    Parameters:
    
    fileLocator - The file from which to read the text lines
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(FileLocator fileLocator,
                                            ICheckedCharset charsetName,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified file location into a String array.
    
    Parameters:
    
    fileLocator - The file from which to read the text lines
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(FileLocator fileLocator,
                                            java.nio.charset.Charset charset,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified file location into a String array.
    
    Parameters:
    
    fileLocator - The file from which to read the text lines (must not be null).
    
    charset - A character set defining the file encoding (must not be null).
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.InputStream inStream,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified stream into a String array. After that the stream will be closed. Even if an exception occurs. The character encoding is the JVM default encoding.
    
    Parameters:
    
    inStream - The stream from which to read the text lines
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.InputStream inStream,
                                            ICheckedCharset charsetName,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified stream into a String array using the specified character encoding. After that the stream will be closed. Even if an exception occurs.
    
    Parameters:
    
    inStream - The stream from which to read the text lines.
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    filter - A filter that defines which lines to return (may be null -> all lines).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.InputStream inStream,
                                            java.nio.charset.Charset charset,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines matching the filter from the specified stream into a String array using the specified character encoding. After that the stream will be closed. Even if an exception occurs.
    
    Parameters:
    
    inStream - The stream from which to read the text lines (must not be null).
    
    charset - A character set defining the encoding of the input stream (must not be null).
    
    filter - A filter that defines which lines to return (may be null -> all lines).
    
    Throws:
    
    java.io.IOException
  - readTextLinesFrom
```
public java.lang.String[] readTextLinesFrom(java.io.Reader reader,
                                            IStringFilter filter)
                                     throws java.io.IOException
```
    Reads all text lines that match the filter from the specified reader into a String array. If the filter is null all lines will be returned. After that the reader will be closed. Even if an exception occurs.
    
    Parameters:
    
    reader - The reader which provides the text
    
    filter - A filter that defines which lines to return (may be null -> all lines)
    
    Throws:
    
    java.io.IOException
  - copyText
```
public void copyText(java.io.Reader reader,
                     java.io.StringWriter writer)
              throws java.io.IOException
```
    Copies all text lines from the specified reader to the given writer. After that the reader will be closed. Even if an exception occurs.
    
    Parameters:
    
    reader - The reader which provides the text to copy
    
    writer - The writer to which the text will be copied
    
    Throws:
    
    java.io.IOException
  - processTextLines
```
public void processTextLines(java.lang.String filename,
                             ILineProcessor processor)
                      throws java.io.IOException
```
    Reads all text lines from the file with the specified name and passes them one by one to the given line processor. The processing will be terminated, if the end of the text is reached or if the processor returns false.
    
    Parameters:
    
    filename - The name of the text file to read
    
    processor - The processor that receives the lines from the text
    
    Throws:
    
    java.io.IOException
  - processTextLines
```
public void processTextLines(java.lang.String filename,
                             ICheckedCharset charsetName,
                             ILineProcessor processor)
                      throws java.io.IOException
```
    Reads all text lines from the file with the specified name and passes them one by one to the given line processor. The processing will be terminated, if the end of the text is reached or if the processor returns false.
    
    Parameters:
    
    filename - The name of the text file to read
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    processor - The processor that receives the lines from the text
    
    Throws:
    
    java.io.IOException
  - processTextLines
```
public void processTextLines(java.io.InputStream inStream,
                             ILineProcessor processor)
                      throws java.io.IOException
```
    Reads all text lines from the specified input stream and passes them one by one to the given line processor. The processing will be terminated, if the end of the text is reached or if the processor returns false.
    The given input stream will be closed after the execution of this method. Even if an exception occurred. The character encoding is the JVM default encoding.
    
    Parameters:
    
    inStream - The input stream that contains the text
    
    processor - The processor that receives the lines from the text
    
    Throws:
    
    java.io.IOException
  - processTextLines
```
public void processTextLines(java.io.InputStream inStream,
                             ICheckedCharset charsetName,
                             ILineProcessor processor)
                      throws java.io.IOException
```
    Reads all text lines from the specified input stream and passes them one by one to the given line processor. The processing will be terminated, if the end of the text is reached or if the processor returns false.
    The given input stream will be closed after the execution of this method. Even if an exception occurred.
    
    Parameters:
    
    inStream - The input stream that contains the text (must not be null).
    
    charsetName - A charset name already checked to be supported (must not be null).
    
    processor - The processor that receives the lines from the text (must not be null).
    
    Throws:
    
    java.io.IOException
  - processTextLines
```
public void processTextLines(java.io.InputStream inStream,
                             java.nio.charset.Charset charset,
                             ILineProcessor processor)
                      throws java.io.IOException
```
    Reads all text lines from the specified input stream and passes them one by one to the given line processor. The processing will be terminated, if the end of the text is reached or if the processor returns false.
    The given input stream will be closed after the execution of this method. Even if an exception occurred.
    
    Parameters:
    
    inStream - The input stream that contains the text (must not be null).
    
    charset - A character set defining the encoding of the stream (must not be null).
    
    processor - The processor that receives the lines from the text (must not be null).
    
    Throws:
    
    java.io.IOException
  - processTextLines
```
public void processTextLines(java.io.Reader reader,
                             ILineProcessor processor)
                      throws java.io.IOException
```
    Reads all text lines from the specified reader and passes them one by one to the given line processor. The processing will be terminated, if the end of the text is reached or if the processor returns false.
    
    Parameters:
    
    reader - The reader that contains a text stream
    
    processor - The processor that receives the lines from the text
    
    Throws:
    
    java.io.IOException
  - close
```
public boolean close(java.util.zip.ZipFile zipFile)
```
    Close the given ZIP file ignoring any exception. Returns true, if the ZIP file was closed successfully, false otherwise
  - closeEntry
```
public boolean closeEntry(java.util.zip.ZipInputStream zipInStream)
```
    Close the current entry in the given ZIP input stream ignoring any exception. Returns true, if the entry was closed successfully, false otherwise
  - closeEntry
```
public boolean closeEntry(java.util.zip.ZipOutputStream zipOutStream)
```
    Close the current entry in the given ZIP output stream ignoring any exception. Returns true, if the entry was closed successfully, false otherwise
  - close
```
public boolean close(java.io.Closeable closeable)
```
    Close the given closeable ignoring any exception and checking for null before closing. Returns true, if the object was closed successfully, false otherwise.
  - standardize
```
public java.lang.String standardize(java.lang.String filename)
```
    Convert the filename to a canonical (see java.io.File.getCanonicalPath()) format and replace any backslashes '\' by slashes ('/'). If possible all "." and ".." elements in the path are eliminated.
    
    Parameters:
    
    filename - The filename which has to be standardized
    
    Returns:
    
    An absolute filename that uses slashes to separate its elements
  - standardize
```
public java.lang.String[] standardize(java.lang.String[] filenames)
```
    Convert all the given filenames to a canonical (see java.io.File.getCanonicalPath()) format and replace any backslashes '\' by slashes ('/'). If possible all "." and ".." elements in the path are eliminated.
    
    Parameters:
    
    filenames - The file names which have to be standardized
    
    Returns:
    
    An new array containing absolute filenames that uses slashes to separate its elements
  - javaFilename
```
public java.lang.String javaFilename(java.lang.String filename)
```
    Returns the given filename in the platform independent way that Java understands. That is all elements are separated by a forward slash rather than back slashes.
    
    Parameters:
    
    filename - The name to be modified
  - javaFilenames
```
public java.lang.String[] javaFilenames(java.lang.String[] filenames)
```
    Returns a new array of filenames where all backslashes are replaced by forward slashes.
    
    Parameters:
    
    filenames - The file names to be modified
    
    Returns:
    
    The same file names but with forward slashes only
  - getClasspath
```
public java.lang.String getClasspath()
```
    Returns the current classpath as String. If this is called from within an Eclipse plug-in the classpath is created from the plug-in dependencies. Otherwise the classpath is taken from the system property "java.class.path" or the manifest file if the application was started with option -jar.
  - calculateClasspath
```
public Classpath calculateClasspath()
```
    Returns the current classpath. If this is called from within an Eclipse plug-in the classpath is created from the plug-in dependencies. Otherwise the classpath is taken from the system property "java.class.path" or the manifest file if the application was started with option -jar.
    
    See Also:
    
    getClasspath()
  - getLookupPath
```
public Classpath getLookupPath(java.lang.String sysPropName)
```
    Returns a class path that is either the value of the specified system property or the classpath calculated from the current Java environment.
    If the given system property has a lookup path set it will be scanned for ${xxx} placeholders which will be replaced by values of the corresponding system properties.
    
    Parameters:
    
    sysPropName - A system property name of null
  - copyToTempFile
```
public java.io.File copyToTempFile(java.io.InputStream inStream)
                            throws java.io.IOException
```
    Copies the contents of the given inStream to a temporary file and returns this temporary file. When the VM terminates the temporary file will automatically be deleted if it still exists. The name of the temporary file starts with the default prefix "PFFU" and ends with the default suffix ".tmp".
    
    Parameters:
    
    inStream - The stream to copy into the temporary file
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    copyToTempFile(InputStream, String), copyToTempFile(InputStream, String, String), copyToTempFile(InputStream, String, String, boolean)
  - copyToTempFile
```
public java.io.File copyToTempFile(java.io.InputStream inStream,
                                   java.lang.String filePrefix)
                            throws java.io.IOException
```
    Copies the contents of the given inStream to a temporary file and returns this temporary file. When the VM terminates the temporary file will automatically be deleted if it still exists. The name of the temporary file starts with the given prefix and ends with the default ".tmp".
    
    Parameters:
    
    inStream - The stream to copy into the temporary file
    
    filePrefix - The prefix to be used for the temp file name (must not be null)
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    copyToTempFile(InputStream), copyToTempFile(InputStream, String, String), copyToTempFile(InputStream, String, String, boolean)
  - copyToTempFile
```
public java.io.File copyToTempFile(java.io.InputStream inStream,
                                   java.lang.String filePrefix,
                                   java.lang.String fileSuffix)
                            throws java.io.IOException
```
    Copies the contents of the given inStream to a temporary file and returns this temporary file. When the VM terminates the temporary file will automatically be deleted if it still exists. The name of the temporary file starts with the given prefix and ends with the given suffix.
    
    Parameters:
    
    inStream - The stream to copy into the temporary file
    
    filePrefix - The prefix to be used for the temp file name (must not be null)
    
    fileSuffix - The prefix to be used for the temp file name (may be null)
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    File.createTempFile(java.lang.String, java.lang.String), copyToTempFile(InputStream), copyToTempFile(InputStream, String), copyToTempFile(InputStream, String, String, boolean)
  - copyToTempFile
```
public java.io.File copyToTempFile(java.io.InputStream inStream,
                                   java.lang.String filePrefix,
                                   java.lang.String fileSuffix,
                                   boolean deleteOnExit)
                            throws java.io.IOException
```
    Copies the contents of the given inStream to a temporary file and returns this temporary file. The name of the temporary file starts with the given prefix and ends with the given suffix.
    
    Parameters:
    
    inStream - The stream to copy into the temporary file
    
    filePrefix - The prefix to be used for the temp file name (must not be null)
    
    fileSuffix - The prefix to be used for the temp file name (may be null)
    
    deleteOnExit - If true the temporary file will be deleted when the VM terminates
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    File.createTempFile(java.lang.String, java.lang.String), copyToTempFile(InputStream), copyToTempFile(InputStream, String), copyToTempFile(InputStream, String, String)
  - copyToTempFile
```
public java.io.File copyToTempFile(java.lang.String filename,
                                   java.lang.String filePrefix,
                                   java.lang.String fileSuffix,
                                   boolean deleteOnExit)
                            throws java.io.IOException
```
    Copies the contents of the file specified by filename to a temporary file and returns this temporary file. The name of the temporary file starts with the given prefix and ends with the given suffix.
    
    Parameters:
    
    filename - The name of the file which to copy into the temporary file
    
    filePrefix - The prefix to be used for the temp file name (must not be null)
    
    fileSuffix - The prefix to be used for the temp file name (may be null)
    
    deleteOnExit - If true the temporary file will be deleted when the VM terminates
    
    Returns:
    
    The newly created temporary file or null if the input file (filename) cannot be found
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException - If any input parameter is not ok
    
    See Also:
    
    File.createTempFile(java.lang.String, java.lang.String)
  - isLocalFileURL
```
public boolean isLocalFileURL(java.lang.String filename)
```
    Returns true if the given filename specifies a file (or directory) on the local file system using the URL syntax such as "file:/usr/bin/run" or "file:\C:\temp\readme.txt.
  - isLocal
```
public boolean isLocal(java.lang.String filename)
```
    Returns true if the given filename specifies a file (or directory) on the local file system. That is, it doesn't contain a protocol prefix such as "http:" or "ftp:".
  - isRemote
```
public boolean isRemote(java.lang.String filename)
```
    Returns true if the given filename specifies a file (or directory) on a remote system. That is, it contains a protocol prefix such as "http:" or "ftp:".
  - isInsideJavaArchive
```
public boolean isInsideJavaArchive(java.lang.String filename)
```
    Returns true if the given filename specifies a file (or directory) that is located inside a JAR file.
  - convertToURLSyntax
```
public java.lang.String convertToURLSyntax(java.lang.String filename)
```
    Converts the given filename to URL syntax. That is, it prepends the scheme "file:" and replaces all illegal URL characters by %xx values. Be aware that this method uses %20 for replacing spaces and not the plus ('+') as the URLEncoder class would do.
    Examples:
    "/path/name" -> "file:/path/name"
    "C:\path\name" -> "file:/C:/path/name"
    "path/name" -> "file:path/name" "C:\\folder name\\filename{v1}" -> "file:/C:/folder%20name/filename%7bv1%7d"
    
    Parameters:
    
    filename - The filename to convert
  - convertFromURLSyntax
```
public java.lang.String convertFromURLSyntax(java.lang.String filename)
```
    Converts the given filename from URL syntax to normal file system syntax. It removes the scheme and decodes all escaped characters.
    Examples:
    "file:/path/name" -> "/path/name"
    "file:\C:\path\name" -> "C:\path\name"
    "path/name" -> "path/name" "file:/C:/Program+Files/settings.ini" -> "C:\Program Files\settings.ini"
    
    Parameters:
    
    filename - The filename to convert
  - convertFromURLSyntax
```
public java.io.File convertFromURLSyntax(java.io.File file)
```
    Converts the given file from URL syntax to normal file system syntax.
    Examples:
    "file:/path/name" -> "/path/name"
    "file:\C:\path\name" -> "C:\path\name"
    "path/name" -> "path/name"
    
    Parameters:
    
    file - The file to convert
  - urlDecode
```
public java.lang.String urlDecode(java.lang.String str,
                                  ICheckedCharset charsetName)
```
    Returns the given string with all %xx placeholders decoded using the specified charset encoding.
    
    Parameters:
    
    str - The string to decode.
    
    charsetName - The name of the charset to be used for decoding.
    
    Returns:
    
    A string with all %xx placeholders decoded according to the specified charset.
  - urlDecode
```
public java.lang.String urlDecode(java.lang.String str)
```
    Returns the given string with all %xx placeholders decoded.
    
    Parameters:
    
    str - The string to decode
    
    Returns:
    
    A string with all %xx placeholders decoded (using UTF-8)
  - urlEncode
```
public java.lang.String urlEncode(java.lang.String str,
                                  ICheckedCharset charsetName)
```
    Returns the given string with all characters that are not allowed directly in URLs encoded as %xx placeholders. In particular it replaces spaces by " %20" rather than '+'! That is reasonable in cases where files in the local file system contain spaces. Such URLs (staring with "file:") cannot open a stream if the URL contains a '+' because the '+' would not be decoded back to a space. That is a bug (or at least an inconsistency) in the URL class implementation.
    
    Parameters:
    
    str - The string to encode.
    
    charsetName - The name of the charset to be used for encoding.
    
    Returns:
    
    A string with %xx encodings for all invalid URL characters.
  - urlEncode
```
public java.lang.String urlEncode(java.lang.String str)
```
    Returns the given string with all characters that are not allowed directly in URLs encoded as %xx placeholders. In particular it replaces spaces by " %20" rather than '+'! That is reasonable in cases where files in the local file system contain spaces. Such URLs (staring with "file:") cannot open a stream if the URL contains a '+' because the '+' would not be decoded back to a space. That is a bug (or at least an inconsistency) in the URL class implementation.
    
    Parameters:
    
    str - The string to encode.
    
    Returns:
    
    A string with %xx (UTF-8) encodings for all invalid URL characters.
  - removeDirectory
```
public long removeDirectory(java.io.File dir)
```
    Deletes all files and sub-directories in the given directory and the directory itself. !!! BE CAREFUL WITH THIS METHOD!!!
    If called with the wrong directory name it can cause data loss.
    
    Parameters:
    
    dir - The directory under which all files must be deleted (must not be null).
    
    Returns:
    
    The number of deleted artifacts.
  - cleanDirectory
```
public long cleanDirectory(java.io.File dir)
```
    Deletes all files and sub-directories in the given directory. !!! BE CAREFUL WITH THIS METHOD!!!
    If called with the wrong directory name it can cause data loss.
    
    Parameters:
    
    dir - The directory under which all files must be deleted (must not be null).
    
    Returns:
    
    The number of deleted artifacts.
  - cleanDirectory
```
public long cleanDirectory(java.io.File dir,
                           boolean filesOnly)
```
    Deletes all files (and optionally sub-directories) in the given directory. !!! BE CAREFUL WITH THIS METHOD!!!
    If called with the wrong directory name it can cause data loss.
    
    Parameters:
    
    dir - The directory under which all files must be deleted (must not be null).
    
    filesOnly - If true only files will be deleted, if false sub-directories will be deleted as well.
    
    Returns:
    
    The number of deleted artifacts.
  - openFile
```
public java.io.InputStream openFile(java.lang.String filename)
                             throws java.io.FileNotFoundException
```
    Opens the file with the given name and returns it as an input stream.
    If the filename contains the prefix "classpath:" then it will be looked-up using the underlying current classloader.
    Without that prefix it will be treated as normal file on the file system (relative or absolute).
    
    Parameters:
    
    filename - The file to open (must not be null). It may contain a path (with slashes).
    
    Returns:
    
    The input stream for the file.
    
    Throws:
    
    java.io.FileNotFoundException
  - openFileForRead
```
public NamedInputStream openFileForRead(java.lang.String filename)
                                 throws java.io.FileNotFoundException
```
    Opens the file with the given name and returns it as a named input stream.
    If the filename contains the prefix "classpath:" then it will be looked-up using the underlying current classloader.
    Without that prefix it will be treated as normal file on the file system (relative or absolute).
    
    Parameters:
    
    filename - The file to open (must not be null). It may contain a path (with slashes).
    
    Returns:
    
    The input stream for the file along with the normalized absolute name of the file.
    
    Throws:
    
    java.io.FileNotFoundException
  - loadPropertiesFrom
```
public java.util.Properties loadPropertiesFrom(java.lang.String filename)
                                        throws java.io.IOException
```
    Loads all properties form the file with the given name.
    If the filename contains the prefix "classpath:" the it will be looked-up using the underlying current classloader.
    Without that prefix it will be treated as normal file on the file system (relative or absolute).
    
    Parameters:
    
    filename - The properties file (must not be null). It may contain a path (with slashes).
    
    Returns:
    
    The loaded properties.
    
    Throws:
    
    java.io.IOException
  - loadNamedValuesFrom
```
public IConfigSettings loadNamedValuesFrom(java.lang.String filename)
                                    throws java.io.IOException
```
    Loads all properties form the file with the given name.
    If the filename contains the prefix "classpath:" then it will be looked-up using the underlying current classloader.
    Without that prefix it will be treated as normal file on the file system (relative or absolute).
    
    Parameters:
    
    filename - The properties file (must not be null). It may contain a path (with slashes).
    
    Returns:
    
    The loaded properties as immutable name/value pairs.
    
    Throws:
    
    java.io.IOException
  - ensureEmptyFolder
```
public boolean ensureEmptyFolder(java.io.File folder)
```
    Ensures that the specified folder exists and is empty. So if it exists already, it will be cleaned, otherwise it will be created. If the given folder is actually a file it will not be touched and the method returns false.
    
    Returns:
    
    true if the folder exists now, otherwise false.
  - ensureFolderExists
```
public boolean ensureFolderExists(java.io.File folder)
```
    Ensures that the specified folder exists. If it does not exist yet, it will be created. If the given folder is actually a file it will not be touched and the method returns false.
    
    Returns:
    
    true if the folder exists, otherwise false.
  - isExistingFolder
```
public boolean isExistingFolder(java.lang.String path)
```
    Returns true if the given path is an existing folder on the file system.
  - isExistingFolder
```
public boolean isExistingFolder(java.io.File folder)
```
    Returns true if the given folder is an existing folder on the file system.
  - getRelativePath
```
public java.lang.String getRelativePath(java.io.File dir,
                                        java.io.File fileBelowDir)
```
    Returns the relative path of the given fileBelowDir in relation to the specified directory. If the file is not below the specified dir, its absolute path will be returned.
    
    Parameters:
    
    dir - The directory under which the file is supposed to be located (must not be null).
    
    fileBelowDir - The file under the given dir somewhere down the hierarchy of sub-directories (must not be null).
    
    Returns:
    
    The relative path (with forward slashes), with no starting and trailing slashes.
  - copyText
```
protected void copyText(java.io.InputStream inStream,
                        java.io.StringWriter writer)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - copyText
```
protected void copyText(java.io.InputStream inStream,
                        CheckedCharsetName charsetName,
                        java.io.StringWriter writer)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - copyText
```
protected void copyText(java.io.InputStream inStream,
                        java.nio.charset.Charset charset,
                        java.io.StringWriter writer)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - standardizeFilename
```
protected java.lang.String standardizeFilename(java.lang.String filename)
```
  - indexOfPreceedingNotNullElement
```
protected int indexOfPreceedingNotNullElement(java.lang.String[] elements,
                                              int start)
```
  - classpathFromManifest
```
protected java.lang.String classpathFromManifest(java.lang.String jarFilename)
```
    Returns the classpath definition from the manifest file in the specified JAR or null if not found.
  - constructClasspathFrom
```
protected java.lang.String constructClasspathFrom(java.lang.String jarFilename)
```
  - calculateEclipseClasspath
```
protected Classpath calculateEclipseClasspath()
```
  - appendClasspathEntriesFrom
```
protected void appendClasspathEntriesFrom(java.util.Collection<java.lang.String> elements,
                                          java.lang.Object bundleLoader)
```
  - getClasspathFromSystemProperty
```
protected java.lang.String getClasspathFromSystemProperty()
```
    Returns the classpath this JVM is using. This is either the current value of the system property "java.class.path" or in case of JVM started with option -jar the classpath from the manifest file in the startup JAR.
  - determineLookupClasspath
```
protected Classpath determineLookupClasspath(java.lang.String sysPropName)
```
  - createSystemClasspath
```
protected Classpath createSystemClasspath()
```
  - createClasspathFrom
```
protected java.lang.String createClasspathFrom(java.lang.String path)
```
  - assertArgumentNotNull
```
protected void assertArgumentNotNull(java.lang.String argName,
                                     java.lang.Object arg)
```
  - getCurrentClassLoader
```
protected java.lang.ClassLoader getCurrentClassLoader()
```
  - ioUtil
```
protected IOUtil ioUtil()
```
  - str
```
protected StringUtil str()
```
  - reflect
```
protected ReflectUtil reflect()
```
  - handleException
```
protected void handleException(java.lang.Exception ex)
```

Class FileUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FU

LINE_SEPARATOR

DEFAULT_BUFFER_SIZE

DEFAULT_TEMP_FILE_PREFIX

DEFAULT_URL_STR_ENCODING

CLASSPATH_PREFIX

FILE_PROTOCOL_INDICATOR

LOCAL_PATTERN

REMOTE_PATTERN

JAR_PATTERN

DRIVE_LETTER_PATTERN_1

DRIVE_LETTER_PATTERN_2

WINDOWS_DRIVE_PATTERN_1

WINDOWS_DRIVE_PATTERN_2

NO_LIMIT

Constructor Detail

FileUtil

FileUtil

Method Detail

current

createFile

createFile

createFile

copyStream

copyStream

copyStream

copyFile

copyFile

copyFile

copyFile

copyFile

copyFile

copyAll

findZippedFiles

extractZipArchive

extractZipArchive

extractZipArchive

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom

readTextLinesFrom