org.basex.io

Class Zip

java.lang.Object

org.basex.core.jobs.Job

org.basex.io.Zip

public final class Zip
extends Job

Contains methods for zipping and unzipping archives.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.core.jobs.Job

state, updating

Constructor Summary

Constructors

Constructor and Description
Zip(IO file) Constructor.

Method Summary

Modifier and Type	Method and Description
double	progressInfo() Returns a progress value (0 - 1).
byte[]	read(String path) Returns the contents of a zip file entry.
void	unzip(IOFile target) Unzips the archive to the specified directory.
void	zip(IOFile root, StringList files) Zips the specified files.

Methods inherited from class org.basex.core.jobs.Job

active, addLocks, checkStop, detailedInfo, jc, memory, popJob, pushJob, register, shortInfo, state, stop, stopped, timeout, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

Zip

public Zip(IO file)

Constructor.

Parameters:

file - archive file

Method Detail

read

public byte[] read(String path)
            throws IOException

Returns the contents of a zip file entry.

Parameters:

path - file to be read

Returns:

resulting byte array

Throws:

IOException - I/O exception

unzip

public void unzip(IOFile target)
           throws IOException

Unzips the archive to the specified directory.

Parameters:

target - target path

Throws:

IOException - I/O exception

zip

public void zip(IOFile root,
                StringList files)
         throws IOException

Zips the specified files.

Parameters:

root - root directory

files - files to add

Throws:

IOException - I/O exception

progressInfo

public double progressInfo()

Description copied from class: Job

Returns a progress value (0 - 1). Can be overwritten to give more specific feedback.

Overrides:

progressInfo in class Job

Returns:

header information