org.dromara.hutool.extra.compress.archiver

Interface Archiver

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

SevenZArchiver, StreamArchiver

public interface Archiver
extends Closeable

数据归档封装，归档即将几个文件或目录打成一个压缩包

Author:

looly

Method Summary

Modifier and Type	Method and Description
default Archiver	add(File file) 将文件或目录加入归档，目录采取递归读取方式按照层级加入
default Archiver	add(File file, Predicate<File> predicate) 将文件或目录加入归档，目录采取递归读取方式按照层级加入
Archiver	add(File file, String path, Function<String,String> fileNameEditor, Predicate<File> filter) 将文件或目录加入归档包，目录采取递归读取方式按照层级加入
default Archiver	add(File file, String path, Predicate<File> filter) 将文件或目录加入归档包，目录采取递归读取方式按照层级加入
void	close() 无异常关闭
Archiver	finish() 结束已经增加的文件归档，此方法不会关闭归档流，可以继续添加文件

Method Detail

add

default Archiver add(File file)

将文件或目录加入归档，目录采取递归读取方式按照层级加入

Parameters:

file - 文件或目录

Returns:

this

add

default Archiver add(File file,
                     Predicate<File> predicate)

将文件或目录加入归档，目录采取递归读取方式按照层级加入

Parameters:

file - 文件或目录

predicate - 文件过滤器，指定哪些文件或目录可以加入，Predicate.test(Object)为true时加入，null表示全部加入

Returns:

this

add

default Archiver add(File file,
                     String path,
                     Predicate<File> filter)

将文件或目录加入归档包，目录采取递归读取方式按照层级加入

Parameters:

file - 文件或目录

path - 文件或目录的初始路径，null表示位于根路径

filter - 文件过滤器，指定哪些文件或目录可以加入，Predicate.test(Object)为true保留，null表示全部加入

Returns:

this

add

Archiver add(File file,
             String path,
             Function<String,String> fileNameEditor,
             Predicate<File> filter)

将文件或目录加入归档包，目录采取递归读取方式按照层级加入

Parameters:

file - 文件或目录

path - 文件或目录的初始路径，null表示位于根路径

fileNameEditor - 文件名编辑器

filter - 文件过滤器，指定哪些文件或目录可以加入，Predicate.test(Object)为true保留，null表示全部加入

Returns:

this

Since:

6.0.0

finish

Archiver finish()

结束已经增加的文件归档，此方法不会关闭归档流，可以继续添加文件

Returns:

this

close

void close()

无异常关闭

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable