org.sonar.api.utils

Class ZipUtils

java.lang.Object

org.sonar.api.utils.ZipUtils

public final class ZipUtils
extends java.lang.Object

Utility to zip directories and unzip files.

Since:

1.10

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ZipUtils.ZipEntryFilter Deprecated. replaced by Predicate in 6.2.

Method Summary

Modifier and Type	Method and Description
static java.io.File	unzip(java.io.File zip, java.io.File toDir) Unzip a file into a directory.
static java.io.File	unzip(java.io.File zip, java.io.File toDir, java.util.function.Predicate<java.util.zip.ZipEntry> filter) Unzip a file to a directory.
static java.io.File	unzip(java.io.File zip, java.io.File toDir, ZipUtils.ZipEntryFilter filter) Deprecated. replaced by unzip(File, File, Predicate) in 6.2.
static java.io.File	unzip(java.io.InputStream zip, java.io.File toDir)
static java.io.File	unzip(java.io.InputStream stream, java.io.File toDir, java.util.function.Predicate<java.util.zip.ZipEntry> filter) Unzip a file to a directory.
static java.io.File	unzip(java.io.InputStream stream, java.io.File toDir, ZipUtils.ZipEntryFilter filter) Deprecated. replaced by unzip(InputStream, File, Predicate) in 6.2.
static void	zipDir(java.io.File dir, java.io.File zip)

Methods inherited from class java.lang.Object

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

Method Detail

unzip

public static java.io.File unzip(java.io.File zip,
                                 java.io.File toDir)
                          throws java.io.IOException

Unzip a file into a directory. The directory is created if it does not exist.

Returns:

the target directory

Throws:

java.io.IOException

unzip

public static java.io.File unzip(java.io.InputStream zip,
                                 java.io.File toDir)
                          throws java.io.IOException

Throws:

java.io.IOException

unzip

@Deprecated
public static java.io.File unzip(java.io.InputStream stream,
                                             java.io.File toDir,
                                             ZipUtils.ZipEntryFilter filter)
                                      throws java.io.IOException

Deprecated. replaced by unzip(InputStream, File, Predicate) in 6.2.

Throws:

java.io.IOException

unzip

public static java.io.File unzip(java.io.InputStream stream,
                                 java.io.File toDir,
                                 java.util.function.Predicate<java.util.zip.ZipEntry> filter)
                          throws java.io.IOException

Unzip a file to a directory.

Parameters:

stream - the zip input file

toDir - the target directory. It is created if needed.

filter - filter zip entries so that only a subset of directories/files can be extracted to target directory.

Returns:

the parameter toDir

Throws:

java.io.IOException

Since:

6.2

unzip

@Deprecated
public static java.io.File unzip(java.io.File zip,
                                             java.io.File toDir,
                                             ZipUtils.ZipEntryFilter filter)
                                      throws java.io.IOException

Deprecated. replaced by unzip(File, File, Predicate) in 6.2.

Throws:

java.io.IOException

unzip

public static java.io.File unzip(java.io.File zip,
                                 java.io.File toDir,
                                 java.util.function.Predicate<java.util.zip.ZipEntry> filter)
                          throws java.io.IOException

Unzip a file to a directory.

Parameters:

zip - the zip file. It must exist.

toDir - the target directory. It is created if needed.

filter - filter zip entries so that only a subset of directories/files can be extracted to target directory.

Returns:

the parameter toDir

Throws:

java.io.IOException

Since:

6.2

zipDir

public static void zipDir(java.io.File dir,
                          java.io.File zip)
                   throws java.io.IOException

Throws:

java.io.IOException