com.lf.commons.io

Class ZIPUtils

java.lang.Object

com.lf.commons.io.ZIPUtils

public class ZIPUtils
extends java.lang.Object

This class holds various methods around ZIP archives.

Since:

1.6

Version:

$Revision: 1.5 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
ZIPUtils() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
static void	collectZIPChildEntries(java.util.Vector<java.util.zip.ZipEntry> childs, java.util.zip.ZipFile archive, java.util.zip.ZipEntry entry) Collects all child entries from a given ZIP/JAR file.
static boolean	extractZipArchive(java.io.File zipfile, java.io.File targetdir) This extracts a given local ZIP/JAR file directly to a specified directory.
static boolean	getAndExtractZipArchive(java.net.URL archive, java.lang.String targetdir) Downloads a given local ZIP/JAR file and extracts it to a specified directory.
static byte[]	loadZIPEntryData(java.lang.String archive, java.lang.String toload) Does the loading of of a file entry within a JAR/ZIP file.
static java.io.InputStream	openZIPEntryData(java.lang.String archive, java.lang.String toload) Does the loading of of a file entry within a JAR/ZIP file.
static boolean	saveZIPEntry(java.util.zip.ZipFile archive, java.util.zip.ZipEntry entry, java.io.File target) This method stores the content of a ZIP/JAR entry to a local file.
static void	searchFilesInZIP(java.lang.String zipfile, java.lang.String[] suffices, java.util.Hashtable<java.lang.String,java.lang.String> candidates) Searches the given JAR file (may be a ZIP file as well) for files with one of the propagated suffices and adds the results to the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZIPUtils

public ZIPUtils()
         throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

Method Detail

searchFilesInZIP

public static void searchFilesInZIP(java.lang.String zipfile,
                    java.lang.String[] suffices,
                    java.util.Hashtable<java.lang.String,java.lang.String> candidates)

Searches the given JAR file (may be a ZIP file as well) for files with one of the propagated suffices and adds the results to the container.

The Hashtable container avoids one and the same file to be found more than once. Errors are not reported by this method.

Parameters:

zipfile - The JAR/ZIP file to search for files

suffices - Searches all files with one of these suffices

candidates - Container for search results

Since:

1.5

loadZIPEntryData

public static byte[] loadZIPEntryData(java.lang.String archive,
                      java.lang.String toload)

Does the loading of of a file entry within a JAR/ZIP file.

Call it with the absolute path to the local ZIP/JAR file as first parameter and with the '/' devided entry you wish to load as array of bytes as the second parameter (something like "package/class" or so).

Can be used for any ZIP entry not only for classes!

Parameters:

archive - The ZIP/JAR file to search the file to load

toload - The ZIP/JAR entry file to load data from

Returns:

Byte contents of the file, null in error case

Since:

1.5

openZIPEntryData

public static java.io.InputStream openZIPEntryData(java.lang.String archive,
                                   java.lang.String toload)

Does the loading of of a file entry within a JAR/ZIP file.

Call it with the absolute path to the local ZIP/JAR file as first parameter and with the '/' devided entry you wish to load as array of bytes as the second parameter (something like "package/class" or so). Use this variant if you are unsure about the size of the entry.

Can be used for any ZIP entry not only for classes!

Parameters:

archive - The ZIP/JAR file to search the file to load

toload - The ZIP/JAR entry file to load data from

Returns:

Byte input stream, null in error case

Since:

1.6

collectZIPChildEntries

public static void collectZIPChildEntries(java.util.Vector<java.util.zip.ZipEntry> childs,
                          java.util.zip.ZipFile archive,
                          java.util.zip.ZipEntry entry)

Collects all child entries from a given ZIP/JAR file.

If this method is called with a file entry it will return an empty container. If it is called to search for directory childs it will collect all its child entries.

Parameters:

childs - Container with child entries

archive - Archive to search for child entries

entry - Parental ZIP/JAR file entry

Since:

1.5

saveZIPEntry

public static boolean saveZIPEntry(java.util.zip.ZipFile archive,
                   java.util.zip.ZipEntry entry,
                   java.io.File target)

This method stores the content of a ZIP/JAR entry to a local file.

Parameters:

archive - ZIP/JAR archive to copy file from

entry - Source to be copied

target - The local file to store the content

Returns:

true, if saving worked

Since:

1.5

getAndExtractZipArchive

public static boolean getAndExtractZipArchive(java.net.URL archive,
                              java.lang.String targetdir)

Downloads a given local ZIP/JAR file and extracts it to a specified directory.

The archive is first of all copied to the user's home directory since we cannot extract non-local files (ZipFile has only constructor with File parameter). This method uses the name of the ZIP archive directly. Then the file is extracted.

Parameters:

archive - ZIP/JAR archive to extract (URL)

targetdir - The local destination directory

Returns:

true, if saving worked, false else

Since:

1.5

extractZipArchive

public static boolean extractZipArchive(java.io.File zipfile,
                        java.io.File targetdir)

This extracts a given local ZIP/JAR file directly to a specified directory.

The archive is first of all copied to the user's home directory since we cannot extract non-local files (ZipFile has only constructor with File parameter). This method uses the name of the ZIP archive directly. Then the file is extracted.

Parameters:

zipfile - ZIP/JAR archive to extract

targetdir - The local destination directory

Returns:

true, if saving worked, false else

Since:

1.6