com.badlogicgames.packr

Class ArchiveUtils

java.lang.Object

com.badlogicgames.packr.ArchiveUtils

public class ArchiveUtils
extends java.lang.Object

Utility functions for working with archives.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArchiveUtils.ArchiveType Archive types available for creation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DIRECTORY_MODE
static int	DEFAULT_FILE_MODE
static int	DEFAULT_LINK_MODE
static int	GROUP_EXECUTE_BIT_MASK
static int	GROUP_READ_BIT_MASK
static int	GROUP_WRITE_BIT_MASK
static int	OTHERS_EXECUTE_BIT_MASK
static int	OTHERS_READ_BIT_MASK
static int	OTHERS_WRITE_BIT_MASK
static int	OWNER_EXECUTE_BIT_MASK
static int	OWNER_READ_BIT_MASK
static int	OWNER_WRITE_BIT_MASK
static int	ZIP_LINK_FLAG

Method Summary

Modifier and Type	Method and Description
static void	createArchive(ArchiveUtils.ArchiveType archiveType, java.nio.file.Path directoryToArchive, java.nio.file.Path archiveFile) Creates a new archive from the contents in directoryToArchive.
static void	extractArchive(java.nio.file.Path archivePath, java.nio.file.Path extractToDirectory) Extracts an archive into extractToDirectory.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FILE_MODE

public static final int DEFAULT_FILE_MODE

See Also:

Constant Field Values

DEFAULT_DIRECTORY_MODE

public static final int DEFAULT_DIRECTORY_MODE

See Also:

Constant Field Values

DEFAULT_LINK_MODE

public static final int DEFAULT_LINK_MODE

See Also:

Constant Field Values

ZIP_LINK_FLAG

public static final int ZIP_LINK_FLAG

See Also:

Constant Field Values

OWNER_READ_BIT_MASK

public static final int OWNER_READ_BIT_MASK

See Also:

Constant Field Values

OWNER_WRITE_BIT_MASK

public static final int OWNER_WRITE_BIT_MASK

See Also:

Constant Field Values

OWNER_EXECUTE_BIT_MASK

public static final int OWNER_EXECUTE_BIT_MASK

See Also:

Constant Field Values

GROUP_READ_BIT_MASK

public static final int GROUP_READ_BIT_MASK

See Also:

Constant Field Values

GROUP_WRITE_BIT_MASK

public static final int GROUP_WRITE_BIT_MASK

See Also:

Constant Field Values

GROUP_EXECUTE_BIT_MASK

public static final int GROUP_EXECUTE_BIT_MASK

See Also:

Constant Field Values

OTHERS_READ_BIT_MASK

public static final int OTHERS_READ_BIT_MASK

See Also:

Constant Field Values

OTHERS_WRITE_BIT_MASK

public static final int OTHERS_WRITE_BIT_MASK

See Also:

Constant Field Values

OTHERS_EXECUTE_BIT_MASK

public static final int OTHERS_EXECUTE_BIT_MASK

See Also:

Constant Field Values

Method Detail

extractArchive

public static void extractArchive(java.nio.file.Path archivePath,
                                  java.nio.file.Path extractToDirectory)
                           throws java.io.IOException,
                                  org.apache.commons.compress.compressors.CompressorException,
                                  org.apache.commons.compress.archivers.ArchiveException

Extracts an archive into extractToDirectory.

NOTE: Symbolic links are not handled.

Parameters:

archivePath - the archive to extract

extractToDirectory - the directory to extract into

Throws:

java.io.IOException - if an IO error occurs

org.apache.commons.compress.compressors.CompressorException - if a compression exception occurs

org.apache.commons.compress.archivers.ArchiveException - if an archive exception occurs

createArchive

public static void createArchive(ArchiveUtils.ArchiveType archiveType,
                                 java.nio.file.Path directoryToArchive,
                                 java.nio.file.Path archiveFile)
                          throws java.io.IOException,
                                 org.apache.commons.compress.archivers.ArchiveException

Creates a new archive from the contents in directoryToArchive.

Parameters:

archiveType - the type of archive to create

directoryToArchive - the directory to archive the contents of

archiveFile - the file to write the archive to

Throws:

java.io.IOException - if an IO error occurs

org.apache.commons.compress.archivers.ArchiveException - if an archive error occurs