com.feilong.zip.ZipHandler 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 2.1.0
 */
public interface ZipHandler{

    /**
     * 压缩制定的文件 tobeZipFilePath, 成新的 {@code outputZipPath}.
     * 
     * 示例:
     * 
     * 
     * 
     *      * 
     * ZipHandler zipHandler = new AntZipHandler();
     * zipHandler.zip(
     *                 SystemUtil.USER_HOME+ "/workspace/resources/product-reports20200324.xlsx", //需要压缩的文件夹 或者文件
     *                 SystemUtil.USER_HOME+ "/feilong/logs/" + DateUtil.nowString(TIMESTAMP) + "zip"); //  需要压缩输出到的文件
     * 
     * 
     * 
     * 
     * 
     * 
     * 如果 tobeZipFilePath 是null,抛出 {@link NullPointerException}

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

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

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

     * 
     *
     * @param tobeZipFilePath
     *            需要 压缩的目录或者文件
     * @param outputZipPath
     *            需要压缩输出到的文件
     */
    void zip(String tobeZipFilePath,String outputZipPath);
}