org.spf4j.io.compress

Class Compress

java.lang.Object

org.spf4j.io.compress.Compress

@Beta
 @ParametersAreNonnullByDefault
public final class Compress
extends Object

Author:

zoly

Method Summary

Modifier and Type	Method and Description
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 List<Path>	unzip(Path zipFile, Path destinationDirectory, Predicate<Path> filter) Unzip a zip file to a destination folder.
static List<Path>	unzip2(Path zipFile, Path destinationDirectory)
static List<Path>	unzip2(Path zipFile, Path destDir, Predicate<Path> filter)
static Path	zip(Path fileOrFolderToCompress) Zip a file or folder.
static void	zip(Path fileOrFolderToCompress, Path destFile) Zip a file or folder.
static void	zip(Path fileOrFolderToCompress, Path destFile, Predicate<Path> filter) 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

@Nonnull
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

@Nonnull
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

zip

@Nonnull
public static void zip(Path fileOrFolderToCompress,
                                Path destFile,
                                Predicate<Path> filter)
                         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

@Nonnull
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

@Nonnull
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.

unzip

@Nonnull
public static List<Path> unzip(Path zipFile,
                                        Path destinationDirectory,
                                        Predicate<Path> filter)
                                 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.

unzip2

@Nonnull
public static List<Path> unzip2(Path zipFile,
                                         Path destinationDirectory)
                                  throws IOException

Throws:

IOException

unzip2

@Nonnull
public static List<Path> unzip2(Path zipFile,
                                         Path destDir,
                                         Predicate<Path> filter)
                                  throws IOException

Throws:

IOException