dextuploadjk.engine
Class CompressUtil

最小サポートバージョン

1.0.0

最小サポート環境

Java 17, Jakarta EE 9+

説明

CompressUtilクラスは、ファイルやディレクトリを圧縮してファイルを作成する機能を持つ。

List<File> files = new ArrayList<File>();
files.add(new File("/src/test/resources/compress/....txt"));
files.add(new File("/src/test/resources/compress/....pdf"));
files.add(new File("/src/test/resources/compress/subA/subB/....txt"));
files.add(new File("/src/test/resources/compress/....jpg"));
files.add(new File("/src/test/resources/compress/....docx"));
		
CompressUtil zipper = new CompressUtil();
File zip = zipper.zip(files, new File("/tmp"), "UTF-8", false, true);

ファイルリストの代わりにディレクトリを指定することができる。

CompressUtil zipper = new CompressUtil();
File zip = zipper.zip(new File("/src/test/resources/compress/"), true, new File("/tmp"), "UTF-8", false, true);

CompressUtilクラスは、zip形式で圧縮するためにjava.util.zipパッケージを使用せず、Apache Commons Compress™ライブラリを使用します。したがって、zip圧縮機能を使用するには、Apache Commons Compress™ライブラリ（commons-compress-{version}.jar）を参照する必要があります。

詳細は https://commons.apache.org/proper/commons-compress/を参照する。

コンストラクタ

CompressUtil

CompressUtilクラスのオブジェクトを生成する。
形式
```
public CompressUtil()
```

メソッド

zip

指定されたファイルまたはディレクトリを圧縮して1つのzipファイルに返します。

形式

public File zip(List<File> targets, File tempZipDir, String zipCharsetName, boolean includeHiddenFile, boolean persist)
public File zip(List<File> targets, List<String> names, List File tempZipDir, String zipCharsetName, boolean includeHiddenFile, boolean persist)
public File zip(File targetDir, boolean includeTargetDirName, File tempZipDir, String zipCharsetName, boolean includeHiddenFile, boolean persist)

パラメータ

名前	形式	説明
targets	java.util.List<java.io.File>	圧縮するファイルのリストを指すオブジェクトである。
targetDir	java.io.File	圧縮するディレクトリを指すオブジェクトである。
includeTargetDirName	boolean	ディレクトリを圧縮する際に、ルートディレクトリを含めるかどうかを設定する。パラメータの値がtrueの場合、ターゲットディレクトリを含む圧縮をし、falseの場合は対象を除く子ファイルまたは子ディレクトリを圧縮する。
tempZipDir	java.io.File	zipファイルが作成される一時ディレクトリを指すオブジェクトである。 nullの場合、オペレーティングシステムが一時ディレクトリの場所を決定する。
zipCharsetName	java.lang.String	多言語を含むファイル名をエンコードする過程で使用される文字セットの名前を設定する。一般的に、 "UTF-8"に設定し、nullの場合、デフォルトの文字セットを使用する。
includeHiddenFile	boolean	圧縮するとき、隠しファイルも圧縮するかどうかを設定する。
persist	boolean	圧縮ファイルを維持条件を設定する。パラメータの値をfalseに設定すると、仮想マシンを終了すると、生成された圧縮ファイルが消去さ。逆にtrueの場合マシンを終了するかどうかにかかわらず、ファイルを維持する。
names	java.util.List<java.lang.String>	圧縮するファイルの名前のリストで、targetsパラメータのサイズと同じでなければなりません。

リターン

圧縮されたファイルを指しているjava.io.Fileオブジェクトを返します。

dextuploadjk.engineClass CompressUtil

dextuploadjk.engine
Class CompressUtil