org.spf4j.jdiff.utils

Class Compress

java.lang.Object

org.spf4j.jdiff.utils.Compress

public final class Compress
extends Object

Author:

zoly

Method Summary

Modifier and Type	Method and Description
static long	copy(InputStream is, OutputStream os)
static long	copy(InputStream is, OutputStream os, int buffSize) Equivalent to guava ByteStreams.copy, with one special behavior: if is has no bytes immediately available for read, the os is flushed prior to the next read that will probably block.
static void	copyFileAtomic(Path source, Path destinationFile) Copy file atomic.
static List<Path>	unzip(Path zipFile) Unzip a zip archive to same folder.
static List<Path>	unzip(Path zipFile, Path destinationDirectory) Unzip a zip file to a destination folder.
static Path	zip(Path fileOrFolderToCompress) Zip a file or folder.
static void	zip(Path fileOrFolderToCompress, Path destFile) Zip a file or folder.

Methods inherited from class java.lang.Object

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

Method Detail

zip

public static Path zip(Path fileOrFolderToCompress)
                throws IOException

Zip a file or folder.

Parameters:

fileOrFolderToCompress - file or folder to compress.

Returns:

the Path of the compressed file. It will created in the same folder as the input parent.

Throws:

IOException

zip

public static void zip(Path fileOrFolderToCompress,
                       Path destFile)
                throws IOException

Zip a file or folder.

Parameters:

fileOrFolderToCompress - file or folder to compress.

destFile - the destination zip file.

Throws:

IOException

copyFileAtomic

public static void copyFileAtomic(Path source,
                                  Path destinationFile)
                           throws IOException

Copy file atomic. file will be written to a tmp file in the destination folder, and atomically renamed (if file system supports)

Parameters:

source -

destinationFile -

Throws:

IOException

unzip

public static List<Path> unzip(Path zipFile)
                        throws IOException

Unzip a zip archive to same folder.

Parameters:

zipFile -

Returns:

list of unzipped files.

Throws:

IOException

unzip

public static List<Path> unzip(Path zipFile,
                               Path destinationDirectory)
                        throws IOException

Unzip a zip file to a destination folder.

Parameters:

zipFile -

destinationDirectory -

Returns:

the list of files that were extracted.

Throws:

IOException - in case extraction fails for whatever reason.

copy

public static long copy(InputStream is,
                        OutputStream os)
                 throws IOException

Throws:

IOException

copy

public static long copy(InputStream is,
                        OutputStream os,
                        int buffSize)
                 throws IOException

Equivalent to guava ByteStreams.copy, with one special behavior: if is has no bytes immediately available for read, the os is flushed prior to the next read that will probably block. I believe this behavior will yield better performance in most scenarios. This method also makes use of: Arrays.getBytesTmp. THis method should not be invoked from any context making use of Arrays.getBytesTmp.

Parameters:

is -

os -

buffSize -

Throws:

IOException