Class ZipUtil

java.lang.Object

jodd.io.ZipUtil

public class ZipUtil
extends Object

Performs zip/gzip/zlib operations on files and directories. These are just tools over existing java.util.zip classes, meaning that existing behavior and bugs are persisted. Most common issue is not being able to use UTF8 in file names, because implementation uses old ZIP format that supports only IBM Code Page 437. This bug was resolved in JDK7: http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4244499

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GZIP_EXT
static final String	ZIP_EXT
static final String	ZLIB_EXT

Constructor Summary

Constructors

Constructor	Description
ZipUtil()

Method Summary

Modifier and Type	Method	Description
static void	addFolderToZip(ZipOutputStream zos, String path, String comment)
static void	addToZip(ZipOutputStream zos, byte[] content, String path, String comment)	Adds byte content into the zip as a file.
static void	addToZip(ZipOutputStream zos, File file, String path, String comment, boolean recursive)	Adds single entry to ZIP output stream.
static void	close(ZipFile zipFile)	Closes zip file safely.
static File	gzip(File file)	Compresses a file into gzip archive.
static File	gzip(String fileName)	Compresses a file into gzip archive.
static List<String>	listZip(File zipFile)	Lists zip content.
static File	ungzip(File file)	Decompress gzip archive.
static File	ungzip(String file)	Decompress gzip archive.
static void	unzip(File zipFile, File destDir, String... patterns)	Extracts zip file to the target directory.
static void	unzip(String zipFile, String destDir, String... patterns)	Extracts zip file content to the target directory.
static File	zip(File file)	Zips a file or a folder.
static File	zip(String file)	Zips a file or a folder.
static File	zlib(File file)	Compresses a file into zlib archive.
static File	zlib(String file)	Compresses a file into zlib archive.

Methods inherited from class Object

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

Field Details

ZIP_EXT

public static final String ZIP_EXT

See Also:

• Constant Field Values

GZIP_EXT

public static final String GZIP_EXT

See Also:

• Constant Field Values

ZLIB_EXT

public static final String ZLIB_EXT

See Also:

• Constant Field Values

Constructor Details

ZipUtil

public ZipUtil()

Method Details

zlib

public static File zlib(String file)
                 throws IOException

Compresses a file into zlib archive.

Throws:

IOException

zlib

public static File zlib(File file)
                 throws IOException

Compresses a file into zlib archive.

Throws:

IOException

gzip

public static File gzip(String fileName)
                 throws IOException

Compresses a file into gzip archive.

Throws:

IOException

gzip

public static File gzip(File file)
                 throws IOException

Compresses a file into gzip archive.

Throws:

IOException

ungzip

public static File ungzip(String file)
                   throws IOException

Decompress gzip archive.

Throws:

IOException

ungzip

public static File ungzip(File file)
                   throws IOException

Decompress gzip archive.

Throws:

IOException

zip

public static File zip(String file)
                throws IOException

Zips a file or a folder.

Throws:

IOException

See Also:

• zip(java.io.File)

zip

public static File zip(File file)
                throws IOException

Zips a file or a folder. If adding a folder, all its content will be added.

Throws:

IOException

listZip

public static List<String> listZip(File zipFile)
                            throws IOException

Lists zip content.

Throws:

IOException

unzip

public static void unzip(String zipFile,
 String destDir,
 String... patterns)
                  throws IOException

Extracts zip file content to the target directory.

Throws:

IOException

See Also:

• unzip(java.io.File, java.io.File, String...)

unzip

public static void unzip(File zipFile,
 File destDir,
 String... patterns)
                  throws IOException

Extracts zip file to the target directory. If patterns are provided only matched paths are extracted.

Parameters:

zipFile - zip file

destDir - destination directory

patterns - optional wildcard patterns of files to extract, may be null

Throws:

IOException

addToZip

public static void addToZip(ZipOutputStream zos,
 File file,
 String path,
 String comment,
 boolean recursive)
                     throws IOException

Adds single entry to ZIP output stream.

Parameters:

zos - zip output stream

file - file or folder to add

path - relative path of file entry; if null files name will be used instead

comment - optional comment

recursive - when set to true content of added folders will be added, too

Throws:

IOException

addToZip

public static void addToZip(ZipOutputStream zos,
 byte[] content,
 String path,
 String comment)
                     throws IOException

Adds byte content into the zip as a file.

Throws:

IOException

addFolderToZip

public static void addFolderToZip(ZipOutputStream zos,
 String path,
 String comment)
                           throws IOException

Throws:

IOException

close

public static void close(ZipFile zipFile)

Closes zip file safely.