org.dromara.hutool.extra.compress.extractor

Class StreamExtractor

java.lang.Object

org.dromara.hutool.extra.compress.extractor.StreamExtractor

All Implemented Interfaces:

Closeable, AutoCloseable, Extractor

public class StreamExtractor
extends Object
implements Extractor

数据解压器，即将归档打包的数据释放

Since:

5.5.0

Author:

looly

Constructor Summary

Constructors

Constructor and Description
StreamExtractor(Charset charset, File file) 构造
StreamExtractor(Charset charset, InputStream in) 构造
StreamExtractor(Charset charset, String archiverName, File file) 构造
StreamExtractor(Charset charset, String archiverName, InputStream in) 构造

Method Summary

Modifier and Type	Method and Description
void	close() 无异常关闭
void	extract(File targetDir, Predicate<org.apache.commons.compress.archivers.ArchiveEntry> predicate) 释放（解压）到指定目录，结束后自动关闭流，此方法只能调用一次
InputStream	getFirst(Predicate<org.apache.commons.compress.archivers.ArchiveEntry> predicate) 获取满足指定过滤要求的压缩包内的第一个文件流

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dromara.hutool.extra.compress.extractor.Extractor

extract, get

Constructor Detail

StreamExtractor

public StreamExtractor(Charset charset,
                       File file)

构造

Parameters:

charset - 编码

file - 包文件

StreamExtractor

public StreamExtractor(Charset charset,
                       String archiverName,
                       File file)

构造

Parameters:

charset - 编码

archiverName - 归档包格式，null表示自动检测

file - 包文件

StreamExtractor

public StreamExtractor(Charset charset,
                       InputStream in)

构造

Parameters:

charset - 编码

in - 包流

StreamExtractor

public StreamExtractor(Charset charset,
                       String archiverName,
                       InputStream in)

构造

Parameters:

charset - 编码

archiverName - 归档包格式，null表示自动检测

in - 包流

Method Detail

getFirst

public InputStream getFirst(Predicate<org.apache.commons.compress.archivers.ArchiveEntry> predicate)

Description copied from interface: Extractor

获取满足指定过滤要求的压缩包内的第一个文件流

Specified by:

getFirst in interface Extractor

Parameters:

predicate - 用于指定需要释放的文件，null表示不过滤。当Predicate.test(Object)为true返回对应流。

Returns:

满足过滤要求的第一个文件的流, 无满足条件的文件返回null

extract

public void extract(File targetDir,
                    Predicate<org.apache.commons.compress.archivers.ArchiveEntry> predicate)

释放（解压）到指定目录，结束后自动关闭流，此方法只能调用一次

Specified by:

extract in interface Extractor

Parameters:

targetDir - 目标目录

predicate - 解压文件过滤器，用于指定需要释放的文件，null表示不过滤。当Predicate.test(Object)为true时释放。

close

public void close()

Description copied from interface: Extractor

无异常关闭

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Extractor