FileCompressor (orion-kit 2.0.1 API)

All Known Implementing Classes:

BaseFileCompressor, Bz2Compressor, GzCompressor, JarCompressor, TarBz2Compressor, TarCompressor, TarGzCompressor, Z7Compressor, ZipCompressor
```
public interface FileCompressor
```
文件压缩器

Since:

2021/9/27 15:57

Version:

1.0.0

Author:

Jiahang Li

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addFile(File file)` 添加文件
`void`	`addFile(String file)` 添加文件
`void`	`addFile(String name, byte[] bs)` 添加文件
`void`	`addFile(String name, File file)` 添加文件
`void`	`addFile(String name, InputStream in)` 添加文件
`void`	`addFile(String name, String file)` 添加文件
`void`	`addFilePrefix(String prefix, File file)` 添加文件
`void`	`addFilePrefix(String prefix, String file)` 添加文件
`void`	`compress()` 进行压缩
`void`	`compressNotify(Consumer<String> notify)` 压缩通知
`String`	`getAbsoluteCompressPath()` 获取压缩产物文件绝对路径
`Closeable`	`getCloseable()` 获取可关闭接口
`String`	`getSuffix()` 获取后缀
`void`	`setAbsoluteCompressPath(String path)` 设置压缩产物文件绝对路径
`void`	`setCompressPath(String compressPath)` 设置压缩产物文件目录
`void`	`setFileName(String fileName)` 设置压缩产物文件名
`void`	`setSuffix(String suffix)` 设置后缀

- Method Detail
  - addFile
```
void addFile(String file)
```
    添加文件
    
    Parameters:
    
    file - file
  - addFile
```
void addFile(File file)
```
    添加文件
    
    Parameters:
    
    file - file
  - addFile
```
void addFile(String name,
             String file)
```
    添加文件
    
    Parameters:
    
    name - name
    
    file - file
  - addFile
```
void addFile(String name,
             File file)
```
    添加文件
    
    Parameters:
    
    name - name
    
    file - file
  - addFilePrefix
```
void addFilePrefix(String prefix,
                   String file)
```
    添加文件
    
    Parameters:
    
    prefix - prefix
    
    file - file
  - addFilePrefix
```
void addFilePrefix(String prefix,
                   File file)
```
    添加文件
    
    Parameters:
    
    prefix - prefix
    
    file - file
  - addFile
```
void addFile(String name,
             byte[] bs)
```
    添加文件
    
    Parameters:
    
    name - name
    
    bs - bs
  - addFile
```
void addFile(String name,
             InputStream in)
```
    添加文件
    
    Parameters:
    
    name - name
    
    in - in
  - compressNotify
```
void compressNotify(Consumer<String> notify)
```
    压缩通知
    
    Parameters:
    
    notify - notify
  - compress
```
void compress()
       throws Exception
```
    进行压缩
    
    Throws:
    
    Exception - compressException
  - setSuffix
```
void setSuffix(String suffix)
```
    设置后缀
    
    Parameters:
    
    suffix - 后缀
  - setCompressPath
```
void setCompressPath(String compressPath)
```
    设置压缩产物文件目录
    
    Parameters:
    
    compressPath - 压缩文件目录
  - setFileName
```
void setFileName(String fileName)
```
    设置压缩产物文件名
  - setAbsoluteCompressPath
```
void setAbsoluteCompressPath(String path)
```
    设置压缩产物文件绝对路径
    
    Parameters:
    
    path - 压缩产物文件绝对路径
  - getAbsoluteCompressPath
```
String getAbsoluteCompressPath()
```
    获取压缩产物文件绝对路径
    
    Returns:
    
    压缩产物文件绝对路径
  - getSuffix
```
String getSuffix()
```
    获取后缀
    
    Returns:
    
    后缀
  - getCloseable
```
Closeable getCloseable()
```
    获取可关闭接口
    
    Returns:
    
    closeable

Interface FileCompressor

Method Summary

Method Detail

addFile

addFile

addFile

addFile

addFilePrefix

addFilePrefix

addFile

addFile

compressNotify

compress

setSuffix

setCompressPath

setFileName

setAbsoluteCompressPath

getAbsoluteCompressPath

getSuffix

getCloseable