com.partnersoft.formats.zip

Class ZipLib

java.lang.Object

com.partnersoft.formats.zip.ZipLib

All Implemented Interfaces:

Lib

public class ZipLib
extends java.lang.Object
implements Lib

Convenience library for reading and writing .zip files.

Copyright 2008 Partner Software, Inc.

Author:

Paul Reavis

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.List<Path>	listContents(VfsFile zipFile) Lists the contents of a zip archive.
static void	pack(java.io.OutputStream output, java.lang.Iterable<VfsNode> nodes) Archives to the given stream in the zip format.
static void	pack(VfsFile zipFile, java.lang.Iterable<VfsNode> nodes) Creates a new zip archive.
static void	pack(VfsFile zipFile, VfsNode... nodes) Creates a new zip archive.
static void	unpack(VfsFile zipFile) Unpacks the given zip file to the current installation directory.
static void	unpack(VfsFile zipFile, VfsDirectory destinationDir) Unpacks a zip archive to the given root directory.
static void	unpack(VfsFile zipFile, VfsDirectory destinationDir, int discardDepth) Unpacks a zip archive to the given root directory, but discards the given amount of directory depth from the top.

Methods inherited from class java.lang.Object

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

Method Detail

pack

public static void pack(VfsFile zipFile,
        VfsNode... nodes)
                 throws java.io.IOException

Creates a new zip archive. The supplied list of nodes are included; any directories in the list are added recursively with all their contents.

Throws:

java.io.IOException

pack

public static void pack(VfsFile zipFile,
        java.lang.Iterable<VfsNode> nodes)
                 throws java.io.IOException

Creates a new zip archive. The supplied list of nodes are included; any directories in the list are added recursively with all their contents.

Throws:

java.io.IOException

pack

public static void pack(java.io.OutputStream output,
        java.lang.Iterable<VfsNode> nodes)
                 throws java.io.IOException

Archives to the given stream in the zip format. Does NOT automatically buffer; supply your own buffering if you want it (and you generally do!). Flushes but does not close the output stream. The supplied list of nodes are included; any directories in the list are added recursively with all their contents.

Throws:

java.io.IOException

unpack

public static void unpack(VfsFile zipFile)
                   throws java.io.IOException

Unpacks the given zip file to the current installation directory.

Parameters:

zipFile - file to unpack

Throws:

java.io.IOException - if unpacking fails

unpack

public static void unpack(VfsFile zipFile,
          VfsDirectory destinationDir)
                   throws java.io.IOException

Unpacks a zip archive to the given root directory.

Throws:

java.io.IOException

unpack

public static void unpack(VfsFile zipFile,
          VfsDirectory destinationDir,
          int discardDepth)
                   throws java.io.IOException

Unpacks a zip archive to the given root directory, but discards the given amount of directory depth from the top. This is used in archives where there's always a top level root directory, that is stored in the zipfile, but that you want to discard and use your own directory when you unpack.

Throws:

java.io.IOException

listContents

public static java.util.List<Path> listContents(VfsFile zipFile)
                                         throws java.io.IOException

Lists the contents of a zip archive.

Throws:

java.io.IOException