com.feilong.zip.UnzipHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation

feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.

There is a newer version: 4.0.8

Show newest version

/*
 * Copyright (C) 2008 feilong
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.feilong.zip;

/**
 * 解压缩的接口.
 *
 * @author feilong
 * @since 1.11.4
 */
public interface UnzipHandler{

    /**
     * 将指定的压缩文件 unZipFilePath, 解压缩到指定的目录 {@code outputDirectory}.
     * 
     * 示例:
     * 
     * 
     * 
     *      * 
     * UnzipHandler unzipHandler = new CompressUnzipHandler();
     * unzipHandler.unzip(
     *                 SystemUtil.USER_HOME+ "/feilong/logs/test.zip", //需要被解压的zip文件
     *                 SystemUtil.USER_HOME+ "/feilong/logs/" + DateUtil.nowString(TIMESTAMP) + "Compress"); // 解压到文件路径
     * 
     * 
     * 
     * 
     * 
     * 
     * 如果 unZipFilePath 是null,抛出 {@link NullPointerException}

     * 如果 unZipFilePath 是blank,抛出 {@link IllegalArgumentException}

     * 如果 outputDirectory 是null,抛出 {@link NullPointerException}

     * 如果 outputDirectory 是blank,抛出 {@link IllegalArgumentException}

     * 
     * 
     * @param unZipFilePath
     *            需要被解压缩的文件路径
     * @param outputDirectory
     *            解压到哪个目录
     */
    void unzip(String unZipFilePath,String outputDirectory);
}