com.atlassian.jira.util

Class ZipUtils

java.lang.Object

com.atlassian.jira.util.ZipUtils

public class ZipUtils
extends Object

Simple utility functions for dealing with zip files.

Constructor Summary

Constructors

Constructor and Description
ZipUtils()

Method Summary

Modifier and Type	Method and Description
static InputStream	streamForZipFileEntry(File zipFile, String entryName) Retrieves an input stream reading from a named entry in a zip file.
static void	unzip(File input, File outputDir) Expand a Zip file into a directory.
static void	zip(File inputDir, File output) Zip a directory into a file.

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

streamForZipFileEntry

public static InputStream streamForZipFileEntry(File zipFile,
                                                String entryName)
                                         throws IOException

Retrieves an input stream reading from a named entry in a zip file.

Parameters:

zipFile - the path to the zip file.

entryName - the name of the entry to which an input stream should be returned.

Returns:

an input stream reading from the named entry in the specified file.

Throws:

IOException - if the zip file is unreadable, or if it does not contained the named entry.

zip

public static void zip(File inputDir,
                       File output)
                throws IOException

Zip a directory into a file.

Parameters:

inputDir - Directory to be compressed.

output - Target file for the zip contents. If the file exists it will be overwritten.

Throws:

FileNotFoundException - if source does not exist

IOException - For other IO errors

Since:

v6.2

unzip

public static void unzip(File input,
                         File outputDir)
                  throws IOException

Expand a Zip file into a directory.

Parameters:

input - Zip file to be expanded

outputDir - Target directory. Files will be overwritten

Throws:

FileNotFoundException - if source does not exist

IOException - For other IO errors

Since:

v6.2