MultipartFormData.Entity (javadoc-all-dev 8.0.0 API)

含まれているクラス:

MultipartFormData

非推奨です。
MultipartFormData.Entity インタフェースを使用してください。
```
public static interface MultipartFormData.Entity
```
フォームデータのエンティティです。
フォームから送信された情報を解析した結果の各エンティティは、ヘッダ情報とデータで構成されます。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`containsHeader(String name)` 非推奨です。 `MultipartFormData.Entity.containsHeader(String)` を使用してください。
`byte[]`	`getBytes()` 非推奨です。 `MultipartFormData.Entity.getBytes()` を使用してください。
`String`	`getContent()` 非推奨です。 `MultipartFormData.Entity.getContent()` を使用してください。
`String`	`getContent(String enc)` 非推奨です。 `MultipartFormData.Entity.getContent(String)` を使用してください。
`int`	`getContentLength()` 非推奨です。 `MultipartFormData.Entity.getContentLength()` を使用してください。
`String`	`getFileName()` 非推奨です。 `MultipartFormData.Entity.getFileName()` を使用してください。
`String`	`getHeader(String name)` 非推奨です。 `MultipartFormData.Entity.getHeader(String)` を使用してください。
`String[]`	`getHeaderNames()` 非推奨です。 `MultipartFormData.Entity.getHeaderNames()` を使用してください。
`InputStream`	`getInputStream()` 非推奨です。 `MultipartFormData.Entity.getInputStream()` を使用してください。
`String`	`getName()` 非推奨です。 `MultipartFormData.Entity.getName()` を使用してください。
`Reader`	`getReader()` 非推奨です。 `MultipartFormData.Entity.getReader()` を使用してください。
`Reader`	`getReader(String encoding)` 非推奨です。 `MultipartFormData.Entity.getReader(String)` を使用してください。

- メソッドの詳細
  - getName
```
String getName()
```
    非推奨です。 MultipartFormData.Entity.getName() を使用してください。
    
    フォームのコントロール名称の取得。
    フォームから送信された情報のうち、このエンティティが表す情報のもととなったフォーム中に定義されたコントロールの名称を返します。
    
    戻り値:
    
    コントロール名称
  - getFileName
```
String getFileName()
```
    非推奨です。 MultipartFormData.Entity.getFileName() を使用してください。
    
    アップロードされたファイルのファイル名を取得します。
    
    ファイルアップロードをしたリクエストではない場合は、null を返します。
    
    Content-Disposition: form-data; name="ctrl_name"; filename="file_path"
    ヘッダは、上記のような形式で受け取れる
    ctrl_name: <INPUT type="file"> の name 属性
    file_path: クライアントでのファイル名
    ヘッダ情報は他にもあるが、上記の行のみを対象に解析を行う
    
    戻り値:
    
    String ファイル名
  - getHeaderNames
```
String[] getHeaderNames()
```
    非推奨です。 MultipartFormData.Entity.getHeaderNames() を使用してください。
    
    ヘッダ名称一覧の取得。
    このエンティティのもつヘッダ情報の名称一覧を返します。
    
    戻り値:
    
    ヘッダ名称の取得
  - getHeader
```
String getHeader(String name)
```
    非推奨です。 MultipartFormData.Entity.getHeader(String) を使用してください。
    ヘッダの取得。
    
    返却値は、文字エンコーディングの変換が行われていない状態の文字列を返却します。具体的には、javax.servlet.ServletRequest#getInputStream()を利用してリクエストの内容をバイト配列で取得し、それを「ISO-8859-1」で文字列化した内容が返却されます。
    
    別のエンコーディングに変換する場合、以下のようなコードで変換する必要があります。
```
 byte[] rawData = entity.getHeader(headerName).getBytes("ISO-8859-1");
 String encodedValue = new String(rawData, request.getCharacterEncoding());
 
```
    パラメータ:
    
    name - ヘッダ名称
    
    戻り値:
    
    ヘッダ名称にマップされている値
  - containsHeader
```
boolean containsHeader(String name)
```
    非推奨です。 MultipartFormData.Entity.containsHeader(String) を使用してください。
    
    指定された文字列がヘッダの名称かどうかを判定します。
    
    パラメータ:
    
    name - ヘッダ名称
    
    戻り値:
    
    ヘッダ名称が値にマップされている場合 true
  - getContentLength
```
int getContentLength()
```
    非推奨です。 MultipartFormData.Entity.getContentLength() を使用してください。
    
    データ部のバイト長を取得します。
    
    戻り値:
    
    データのサイズ
  - getContent
```
String getContent()
```
    非推奨です。 MultipartFormData.Entity.getContent() を使用してください。
    
    データ部を文字列表現として取得します。
    入力されたバイトデータから文字列への変換には、Application Runtimeが稼動しているJavaVMのデフォルト文字エンコーディングを使います。
    
    戻り値:
    
    データ
  - getContent
```
String getContent(String enc)
           throws UnsupportedEncodingException
```
    非推奨です。 MultipartFormData.Entity.getContent(String) を使用してください。
    
    データ部を指定された文字コードで変換した結果を文字列表現として取得します。
    指定のエンコード名がサポートされていない場合 UnsupportedEncodingException がスローされます。
    
    パラメータ:
    
    enc - エンコード名
    
    戻り値:
    
    データ
    
    例外:
    
    UnsupportedEncodingException
    
    関連項目:
    
    UnsupportedEncodingException
  - getBytes
```
byte[] getBytes()
```
    非推奨です。 MultipartFormData.Entity.getBytes() を使用してください。
    
    データ部をバイト配列として取得します。
    
    戻り値:
    
    データ
  - getReader
```
Reader getReader()
```
    非推奨です。 MultipartFormData.Entity.getReader() を使用してください。
    
    データ部を Reader として取得します。
    Application Runtimeが稼動しているJavaVMのデフォルト文字エンコーディングを使うReaderを返します。
    
    戻り値:
    
    データ
  - getReader
```
Reader getReader(String encoding)
```
    非推奨です。 MultipartFormData.Entity.getReader(String) を使用してください。
    
    データ部を Reader として取得します。
    
    パラメータ:
    
    データ部の文字エンコーディング -
    
    戻り値:
    
    データ
    
    導入されたバージョン:
    
    6.1.12
  - getInputStream
```
InputStream getInputStream()
```
    非推奨です。 MultipartFormData.Entity.getInputStream() を使用してください。
    
    データ部を入力ストリームとして取得します。
    
    戻り値:
    
    データ

インタフェース MultipartFormData.Entity

メソッドのサマリー

メソッドの詳細

getName

getFileName

getHeaderNames

getHeader

containsHeader

getContentLength

getContent

getContent

getBytes

getReader

getReader

getInputStream