org.dstadler.commons.zip

Class ZipUtils

java.lang.Object

org.dstadler.commons.zip.ZipUtils

public class ZipUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZipUtils.ZipFileVisitor A simple walker which will visit all Zip-entries in the given InputStream.

Constructor Summary

Constructors

Constructor and Description
ZipUtils()

Method Summary

Modifier and Type	Method and Description
static void	extractZip(java.io.File zip, java.io.File toDir) Extracts all files in the specified ZIP file and stores them in the denoted directory.
static void	extractZip(java.io.InputStream zip, java.io.File toDir) Extracts all files in the ZIP file passed as InputStream and stores them in the denoted directory.
static void	findZip(java.lang.String zipName, java.io.InputStream zipInput, java.io.FileFilter searchFilter, java.util.List<java.lang.String> results) Looks in the ZIP file available via zipInput for files matching the provided file-filter, recursing into sub-ZIP files.
static java.io.InputStream	getZipContentsRecursive(java.lang.String file) Get a stream of the noted file which potentially resides inside ZIP files.
static java.lang.String	getZipStringContentsRecursive(java.lang.String file) Get the text-contents of the noted file.
static boolean	isFileInZip(java.lang.String name) Checks if the string denotes a file inside a ZIP file using the notation used for getZipContentsRecursive().
static boolean	isZip(java.lang.String fileName) Determines if the file has an extension known to be a ZIP file, currently this includes .zip, .jar, .war, .ear, .aar
static void	replaceInZip(java.io.File zip, java.lang.String file, java.lang.String data, java.lang.String encoding) Replaces the specified file in the provided ZIP file with the provided content.
static void	replaceInZip(java.lang.String zipFile, java.lang.String data, java.lang.String encoding) Replace the file denoted by the zipFile with the provided data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipUtils

public ZipUtils()

Method Detail

isZip

public static boolean isZip(java.lang.String fileName)

Determines if the file has an extension known to be a ZIP file, currently this includes .zip, .jar, .war, .ear, .aar

Parameters:

fileName - The name of the file to check.

Returns:

True if the filename is of an extension that is a known zip file, false otherwise.

isFileInZip

public static boolean isFileInZip(java.lang.String name)

Checks if the string denotes a file inside a ZIP file using the notation used for getZipContentsRecursive().

Parameters:

name - The name to check

Returns:

true if the name denotes a file inside a known zip file format.

findZip

public static void findZip(java.lang.String zipName,
                           java.io.InputStream zipInput,
                           java.io.FileFilter searchFilter,
                           java.util.List<java.lang.String> results)
                    throws java.io.IOException

Looks in the ZIP file available via zipInput for files matching the provided file-filter, recursing into sub-ZIP files.

Parameters:

zipName - Name of the file to read, mainly used for building the resulting pointer into the zip-file

zipInput - An InputStream which is positioned at the beginning of the zip-file contents

searchFilter - A FileFilter which determines if files in the zip-file are matched

results - A existing list where found matches are added to.

Throws:

java.io.IOException - If the ZIP file cannot be read, e.g. if it is corrupted.

getZipContentsRecursive

public static java.io.InputStream getZipContentsRecursive(java.lang.String file)
                                                   throws java.io.IOException

Get a stream of the noted file which potentially resides inside ZIP files. An exclamation mark '!' denotes a zip-entry. ZIP files can be nested inside one another. e.g. c:\temp\test.zip!sample.zip!my.zip!somefile.txt If there is no exclamation mark contained in the file-parameter, an input stream to this file is returned directly. means that there is a zip file c:\temp\test.zip which contains a file "sample.zip", which itself contains a file "my.zip" which finally contains a file "somefile.txt"

Parameters:

file - The name of the file to read, files inside zip files are denoted with '!'.

Returns:

A stream that points to the file inside the ZIP file.

Throws:

java.io.IOException - If the file cannot be found or an error occurs while opening the file.

getZipStringContentsRecursive

public static java.lang.String getZipStringContentsRecursive(java.lang.String file)
                                                      throws java.io.IOException

Get the text-contents of the noted file. An exclamation mark '!' denotes a zip-entry. ZIP files can be nested inside one another. e.g. c:\temp\test.zip!sample.zip!my.zip!somefile.txt If there is no exclamation mark contained in the file-parameter, an input stream to this file is returned directly. means that there is a zip file c:\temp\test.zip which contains a file "sample.zip", which itself contains a file "my.zip" which finally contains a file "somefile.txt"

Parameters:

file - The name of the file to read, files inside zip files are denoted with '!'.

Returns:

The text-contents of the file

Throws:

java.io.IOException - If the file cannot be found or an error occurs while opening the file.

extractZip

public static final void extractZip(java.io.File zip,
                                    java.io.File toDir)
                             throws java.io.IOException

Extracts all files in the specified ZIP file and stores them in the denoted directory. The directory needs to exist before running this method. Note: nested ZIP files are not extracted here.

Parameters:

zip - The zip-file to process

toDir - Target directory, should already exist.

Throws:

java.io.IOException - Thrown if files can not be read or any other error occurs while handling the Zip-files

extractZip

public static final void extractZip(java.io.InputStream zip,
                                    java.io.File toDir)
                             throws java.io.IOException

Extracts all files in the ZIP file passed as InputStream and stores them in the denoted directory. The directory needs to exist before running this method. Note: nested ZIP files are not extracted here.

Parameters:

zip - An InputStream to read zipped files from

toDir - Target directory, should already exist.

Throws:

java.io.IOException - Thrown if files can not be read or any other error occurs while handling the Zip-files

replaceInZip

public static void replaceInZip(java.lang.String zipFile,
                                java.lang.String data,
                                java.lang.String encoding)
                         throws java.io.IOException

Replace the file denoted by the zipFile with the provided data. The zipFile specifies both the zip and the file inside the zip using '!' as separator.

Parameters:

zipFile - The zip-file to process

data - The string-data to replace

encoding - The encoding that should be used when writing the string data to the file

Throws:

java.io.IOException - Thrown if files can not be read or any other error occurs while handling the Zip-files

replaceInZip

public static void replaceInZip(java.io.File zip,
                                java.lang.String file,
                                java.lang.String data,
                                java.lang.String encoding)
                         throws java.io.IOException

Replaces the specified file in the provided ZIP file with the provided content.

Parameters:

zip - The zip-file to process

file - The file to look for

data - The string-data to replace

encoding - The encoding that should be used when writing the string data to the file

Throws:

java.io.IOException - Thrown if files can not be read or any other error occurs while handling the Zip-files