be.yildizgames.common.compression.Unpacker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-compression Show documentation

Common Compression library for the yildiz project, contains utilities to compression and decompress files.

There is a newer version: 2.5.2

/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *
 *  Copyright (c) 2019 Grégory Van den Borre
 *
 *  More infos available: https://engine.yildiz-games.be
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 *  documentation files (the "Software"), to deal in the Software without restriction, including without
 *  limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 *  of the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all copies or substantial
 *  portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT  HOLDERS BE LIABLE FOR ANY CLAIM,
 *  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  SOFTWARE.
 *
 */

package be.yildizgames.common.compression;

import be.yildizgames.common.compression.exception.ArchiveException;

import java.nio.file.Path;

/**
 * Unpack an archive.
 *
 * @author Grégory Van den Borre
 */
public interface Unpacker {

    /**
     * Extract a directory and all its content from an archive.
     *
     * @param archive     Zip file to extract the data from.
     * @param destination Path where the directory will be extracted.
     * @param keepRootDir Keep the root directory or extract all its content.
     * @throws ArchiveException If the archive file does not exists.
     */
    void unpack(Path archive, Path destination, boolean keepRootDir);

    /**
     * Extract a directory and all its content from an archive file.
     *
     * @param archive     Archive file to extract the data from.
     * @param directoryToExtract   Directory to extract.
     * @param destination Path where the directory will be extracted.
     * @throws ArchiveException If the archive file does not exists.
     */
    void unpackDirectoryToDirectory(Path archive, String directoryToExtract, Path destination);
}