dextuploadjk.engine
Class FileSaveOption

最小サポートバージョン

1.0.0

最小サポート環境

Java 17, Jakarta EE 9+

説明

一時ファイルを保存するときに必要なオプションを設定するクラスです。

FileSaveOption option = new FileSaveOption();
option.setTargetDirectoryPath("/home/user/others/");
option.setTargetFilename("uploaded_file.txt");
item.save(option);

コンストラクタ

FileSaveOption

FileSaveOptionクラスのオブジェクトを作成します。

形式

public FileSaveOption()
public FileSaveOption(String targetDirectoryPath, String targetFilename, boolean overwrite, boolean copy, boolean nfc)

パラメータ

名前	形式	説明
targetDirectoryPath	java.lang.String	ファイルを保存するディレクトリパス
targetFilename	java.lang.String	一時ファイルの保存時に使用するファイル名
overwrite	boolean	重複したファイルを上書きするかどうか
copy	boolean	一時ファイルを削除するかどうか
nfc	boolean	Unicode正規化フォームに変更するかどうか

メソッド

getTargetDirectoryPath

ファイルを保存するディレクトリパスを返します。
形式
```
public String getTargetDirectoryPath()
```
リターン

ディレクトリパス

setTargetDirectoryPath

ファイルを保存するディレクトリパスを設定します。

形式

public void setTargetDirectoryPath(String targetDirectoryPath)

パラメータ

名前	形式	説明
targetDirectoryPath	java.lang.String	ディレクトリパス

使い方

FileSaveOption option = new FileSaveOption();
option.setTargetDirectoryPath("/home/user/others/");

getTargetFilename

一時ファイルの保存時に使用するファイル名を返します。
形式
```
public String getTargetFilename()
```
リターン

ファイル名

setTargetFilename

一時ファイルの保存時に使用するファイル名を設定します。

形式

public void setTargetFilename(String targetFilename)

パラメータ

名前	形式	説明
targetFilename	java.lang.String	ファイル名

使い方

FileSaveOption option = new FileSaveOption();
option.setTargetFilename("uploaded_file.txt");

isOverwrite

Returns whether duplicate files are overwritten.
形式
```
public boolean isOverwrite()
```
リターン

trueまたはfalse(デフォルト)

setOverwrite

重複したファイルの上書きを設定します。

DEXTUploadJKは、ファイルを保存するときに、同じファイル名を持つ重複ファイルがある場合、ファイル名にsuffix値を自動的に付けます。しかし、ウェブのように同時に多くの要求を処理するシステムの場合、非常に短い時間の間、suffix値でさえ重複する可能性があります。したがって、overwrite引数の値がfalseの場合でも、ファイルの書き込みに失敗することがよくあります。このような状況をできるだけ避けるために、ファイルを保存するときは、元のファイル名のまま保存せずにファイル名を変更して、できるだけ重複した名前が発生しないように処理する必要があります。

形式

public void setOverwrite(boolean overwrite)

パラメータ

名前	形式	説明
overwrite	boolean	trueまたはfalse

使い方

FileSaveOption option = new FileSaveOption();
option.setOverwrite(true);

isCopy

一時ファイルを削除するかどうかを返します。
形式
```
public boolean isCopy()
```
リターン

trueまたはfalse(デフォルト)

setCopy

一時ファイルを削除するかどうかを設定します。

DEXTUploadJKはファイルを保存した直後に一時ファイルを削除します。したがって、FileItem.saveメソッドを何度も呼び出して使用することはできません。もし一時ファイルを削除せずに維持したい場合、 copy 属性を true に設定すればよい。
形式
```
public void setCopy(boolean copy)
```

パラメータ

名前	形式	説明
copy	boolean	trueまたはfalse

使い方

FileSaveOption option = new FileSaveOption();
option.setCopy(true);

isNfc

ファイル名をnfc Unicode正規化フォームに変更するかどうかを返します。
形式
```
public boolean isNfc()
```
リターン

trueまたはfalse(デフォルト)

setNfc

ファイル名をnfc Unicode正規化フォームに変更するかどうかを設定します。

Windows / Linuxとは異なり、macOSの場合は、nfd正規化フォームでファイルまたはディレクトリ名を管理します。 macOSとWindows / Linux間の名前互換のためにnfc変更操作が必要な場合は、nfc属性をtrueに設定するだけです。
形式
```
public void setNfc(boolean nfc)
```

パラメータ

名前	形式	説明
nfc	boolean	trueまたはfalse

使い方

FileSaveOption option = new FileSaveOption();
option.setNfc(true);

dextuploadjk.engineClass FileSaveOption

dextuploadjk.engine
Class FileSaveOption