MockMultipartFile (Spring Framework API)

java.lang.ObjectSE
- org.springframework.mock.web.MockMultipartFile

実装されているすべてのインターフェース:
InputStreamSource, MultipartFile
```
public class MockMultipartFile
extends ObjectSE
implements MultipartFile
```
MultipartFile インターフェースのモック実装。
マルチパートアップロードにアクセスするアプリケーションコントローラーをテストするために、MockMultipartHttpServletRequest と組み合わせて使用すると便利です。
導入:
2.0
作成者:
Juergen Hoeller, Eric Crampton
関連事項:
MockMultipartHttpServletRequest

コンストラクターの概要

コンストラクター
コンストラクターと説明
`MockMultipartFile(StringSE name, byte[] content)` 指定されたコンテンツで新しい MockMultipartFile を作成します。
`MockMultipartFile(StringSE name, InputStreamSE contentStream)` 指定されたコンテンツで新しい MockMultipartFile を作成します。
`MockMultipartFile(StringSE name, StringSE originalFilename, StringSE contentType, byte[] content)` 指定されたコンテンツで新しい MockMultipartFile を作成します。
`MockMultipartFile(StringSE name, StringSE originalFilename, StringSE contentType, InputStreamSE contentStream)` 指定されたコンテンツで新しい MockMultipartFile を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`byte[]`	`getBytes()` ファイルの内容をバイトの配列として返します。
`StringSE`	`getContentType()` ファイルのコンテンツ型を返します。
`InputStreamSE`	`getInputStream()` ファイルの内容を読み取る InputStream を返します。
`StringSE`	`getName()` マルチパート形式でパラメーターの名前を返します。
`StringSE`	`getOriginalFilename()` クライアントのファイルシステムにある元のファイル名を返します。
`long`	`getSize()` ファイルのサイズをバイト単位で返します。
`boolean`	`isEmpty()` アップロードされたファイルが空かどうか、つまり、マルチパート形式でファイルが選択されていないか、選択されたファイルにコンテンツがないかを返します。
`void`	`transferTo(FileSE dest)` 受信したファイルを指定された宛先ファイルに転送します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.web.multipart.MultipartFile から継承されたメソッド
getResource, transferTo

- コンストラクターの詳細
  - MockMultipartFile
```
public MockMultipartFile(StringSE name,
                         @Nullable
                         byte[] content)
```
    指定されたコンテンツで新しい MockMultipartFile を作成します。
    パラメーター:
    name - ファイルの名前
    content - ファイルの内容
  - MockMultipartFile
```
public MockMultipartFile(StringSE name,
                         InputStreamSE contentStream)
                  throws IOExceptionSE
```
    指定されたコンテンツで新しい MockMultipartFile を作成します。
    パラメーター:
    name - ファイルの名前
    contentStream - ストリームとしてのファイルのコンテンツ
    例外:
    IOExceptionSE - ストリームからの読み取りに失敗した場合
  - MockMultipartFile
```
public MockMultipartFile(StringSE name,
                         @Nullable
                         StringSE originalFilename,
                         @Nullable
                         StringSE contentType,
                         @Nullable
                         byte[] content)
```
    指定されたコンテンツで新しい MockMultipartFile を作成します。
    パラメーター:
    name - ファイルの名前
    originalFilename - 元のファイル名 (クライアントのマシン上)
    contentType - コンテンツ型 (既知の場合)
    content - ファイルの内容
  - MockMultipartFile
```
public MockMultipartFile(StringSE name,
                         @Nullable
                         StringSE originalFilename,
                         @Nullable
                         StringSE contentType,
                         InputStreamSE contentStream)
                  throws IOExceptionSE
```
    指定されたコンテンツで新しい MockMultipartFile を作成します。
    パラメーター:
    name - ファイルの名前
    originalFilename - 元のファイル名 (クライアントのマシン上)
    contentType - コンテンツ型 (既知の場合)
    contentStream - ストリームとしてのファイルのコンテンツ
    例外:
    IOExceptionSE - ストリームからの読み取りに失敗した場合
- メソッドの詳細
  - getName
```
public StringSE getName()
```
    インターフェースからコピーされた説明: MultipartFile
    マルチパート形式でパラメーターの名前を返します。
    次で指定:
    インターフェース MultipartFile の getName
    戻り値:
    パラメーターの名前 (null または空ではない)
  - getOriginalFilename
```
@NonNull
public StringSE getOriginalFilename()
```
    インターフェースからコピーされた説明: MultipartFile
    クライアントのファイルシステムにある元のファイル名を返します。
    これには、使用するブラウザーによってはパス情報が含まれる場合がありますが、通常は Opera 以外には含まれません。
    注意 : このファイル名はクライアントから提供されたものであり、盲目的に使用しないでください。ファイル名には、ディレクトリ部分を使用しないだけでなく、".." などの悪意のある文字を含めることもできます。このファイル名を直接使用しないことをお勧めします。できれば、一意のものを生成し、必要に応じて、参照用にこれをどこかに保存してください。
    次で指定:
    インターフェース MultipartFile の getOriginalFilename
    戻り値:
    元のファイル名、またはマルチパート形式でファイルが選択されていない場合は空の文字列、定義されていないか利用できない場合は null
    関連事項:
    FileItem.getName(), CommonsMultipartFile.setPreserveFilename(boolean), RFC 7578、セクション 4.2 , 無制限のファイルアップロード
  - getContentType
```
@Nullable
public StringSE getContentType()
```
    インターフェースからコピーされた説明: MultipartFile
    ファイルのコンテンツ型を返します。
    次で指定:
    インターフェース MultipartFile の getContentType
    戻り値:
    コンテンツ型、または定義されていない場合は null (または、マルチパート形式でファイルが選択されていません)
  - isEmpty
```
public boolean isEmpty()
```
    インターフェースからコピーされた説明: MultipartFile
    アップロードされたファイルが空かどうか、つまり、マルチパート形式でファイルが選択されていないか、選択されたファイルにコンテンツがないかを返します。
    次で指定:
    インターフェース MultipartFile の isEmpty
  - getSize
```
public long getSize()
```
    インターフェースからコピーされた説明: MultipartFile
    ファイルのサイズをバイト単位で返します。
    次で指定:
    インターフェース MultipartFile の getSize
    戻り値:
    ファイルのサイズ、または空の場合は 0
  - getBytes
```
public byte[] getBytes()
                throws IOExceptionSE
```
    インターフェースからコピーされた説明: MultipartFile
    ファイルの内容をバイトの配列として返します。
    次で指定:
    インターフェース MultipartFile の getBytes
    戻り値:
    バイトとしてのファイルの内容、または空の場合は空のバイト配列
    例外:
    IOExceptionSE - アクセスエラーの場合 (一時ストアが失敗した場合)
  - getInputStream
```
public InputStreamSE getInputStream()
                           throws IOExceptionSE
```
    インターフェースからコピーされた説明: MultipartFile
    ファイルの内容を読み取る InputStream を返します。
    ユーザーは、返されたストリームを閉じる責任があります。
    次で指定:
    インターフェース InputStreamSource の getInputStream
    次で指定:
    インターフェース MultipartFile の getInputStream
    戻り値:
    ストリームとしてのファイルのコンテンツ、または空の場合は空のストリーム
    例外:
    IOExceptionSE - アクセスエラーの場合 (一時ストアが失敗した場合)
    関連事項:
    Resource.isReadable()
  - transferTo
```
public void transferTo(FileSE dest)
                throws IOExceptionSE,
                       IllegalStateExceptionSE
```
    インターフェースからコピーされた説明: MultipartFile
    受信したファイルを指定された宛先ファイルに転送します。
    これにより、ファイルシステム内のファイルを移動したり、ファイルシステム内のファイルをコピーしたり、メモリ内のコンテンツを宛先ファイルに保存したりできます。宛先ファイルがすでに存在する場合、最初に削除されます。
    ターゲットファイルがファイルシステム内で移動されている場合、この操作は後で再度呼び出すことはできません。ストレージメカニズムを使用するには、このメソッドを 1 回だけ呼び出します。
    注意 : 基礎となるプロバイダーに応じて、一時ストレージは、ここで指定された相対的な宛先のベースディレクトリなど、コンテナーに依存する場合があります（例: Servlet 3.0 マルチパート処理）。絶対的な宛先の場合、一時コピーがすでに存在していても、ターゲットファイルの名前が変更されたり、一時的な場所から移動されたり、新しくコピーされたりすることがあります。
    次で指定:
    インターフェース MultipartFile の transferTo
    パラメーター:
    dest - 宛先ファイル (通常は絶対)
    例外:
    IOExceptionSE - 読み取りまたは書き込みエラーの場合
    IllegalStateExceptionSE - ファイルがファイルシステム内ですでに移動されており、別の転送に使用できない場合
    関連事項:
    FileItem.write(File), Part.write(String)EE

クラス MockMultipartFile

コンストラクターの概要

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.web.multipart.MultipartFile から継承されたメソッド

コンストラクターの詳細

MockMultipartFile

MockMultipartFile

MockMultipartFile

MockMultipartFile

メソッドの詳細

getName

getOriginalFilename

getContentType

isEmpty

getSize

getBytes

getInputStream

transferTo