MultipartFormData (javadoc-platform-all-dev 8.0.0 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.ArrayList
    - - jp.co.intra_mart.foundation.http.MultipartFormData

すべての実装されたインタフェース:

Serializable, Cloneable, Iterable, Collection, List, RandomAccess

非推奨です。
MultipartFormData クラスを使用してください。
```
public class MultipartFormData
extends ArrayList
```
フォームから enctype が multipart/form-data で送信されてきた情報を解析するオブジェクトです。
このオブジェクトは、ブラウザから multipart/form-data 形式でリクエストされたデータを解析し、boundary で区切られた各情報(エンティティ)をとしてリストに保管します。
このクラスを利用する事により、ブラウザからサーバに対するファイルのアップロードなどが簡単に実装する事ができます。

留意点

intra-mart6.1.11から、アップロードされたファイルが指定した閾値を超えた場合、メモリ上ではなく一時ファイルに書き出し、OutOfMemoryErrorの発生を抑えることができるようになりました。内部では Apache Commons FileUpload を利用しています。

一時ファイルは、ガベージコレクタがMultiPartFormData.Entityを解放するタイミングで削除されます。従いまして、MultiPartFormData.Entityが解放される前にintra-martが停止すると一時ファイルは削除されません。

一時ファイルの格納先は、デフォルトではJavaのテンポラリフォルダ(java.io.tmpdir)です。ファイル名は upload_ランダムな文字列.tmp です。

なお、アップロードされたファイルを常にメモリ上で扱う実装と一時ファイルに書き出す実装の切り替え、一時ファイルの格納先、一時ファイルに書き出すかどうかの閾値を設定ファイルで指定することができます。設定ファイルは、 %ApplicationRuntime%/doc/imart/WEB-INF/classes/jp/co/intra_mart/common/aid/javaee/http/MultipartFormData.properties です。
設定ファイルの内容はMultipartFormDataResourceBundleを参照してください。

関連項目:

直列化された形式

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`static interface`	`MultipartFormData.Entity` 非推奨です。 `MultipartFormData.Entity` インタフェースを使用してください。

フィールドのサマリー
- クラスから継承されたフィールド java.util.AbstractList
  modCount

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`MultipartFormData(javax.servlet.ServletRequest req)` 非推奨です。 `MultipartFormData.MultipartFormData(ServletRequest)` を使用してください。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`void`	`add(int index, Object element)` 非推奨です。 `MultipartFormData.add(int, Object)` を使用してください。
`boolean`	`add(Object o)` 非推奨です。 `MultipartFormData.add(Object)` を使用してください。
`boolean`	`addAll(Collection c)` 非推奨です。 `MultipartFormData.addAll(Collection)` を使用してください。
`boolean`	`addAll(int index, Collection c)` 非推奨です。 `MultipartFormData.addAll(int, Collection)` を使用してください。
`void`	`clear()` 非推奨です。 `MultipartFormData.clear()` を使用してください。
`boolean`	`contains(Object elem)` 非推奨です。 `MultipartFormData.contains(Object)` を使用してください。
`boolean`	`containsAll(Collection c)` 非推奨です。 `MultipartFormData.containsAll(Collection)` を使用してください。
`void`	`ensureCapacity(int minCapacity)` 非推奨です。 `MultipartFormData.ensureCapacity(int)` を使用してください。
`boolean`	`equals(Object o)` 非推奨です。 `MultipartFormData.equals(Object)` を使用してください。
`Object`	`get(int index)` 非推奨です。 `MultipartFormData.get(int)` を使用してください。
`MultipartFormData.Entity[]`	`getEntities(String name)` 非推奨です。 `MultipartFormData.getEntities(String)` を使用してください。
`MultipartFormData.Entity`	`getEntity(int index)` 非推奨です。 `MultipartFormData.getEntity(int)` を使用してください。
`MultipartFormData.Entity`	`getEntity(String name)` 非推奨です。 `MultipartFormData.getEntity(String)` を使用してください。
`int`	`hashCode()` 非推奨です。 `MultipartFormData.hashCode()` を使用してください。
`int`	`indexOf(Object elem)` 非推奨です。 `MultipartFormData.indexOf(Object)` を使用してください。
`boolean`	`isEmpty()` 非推奨です。 `MultipartFormData.isEmpty()` を使用してください。
`Iterator`	`iterator()` 非推奨です。 `MultipartFormData.iterator()` を使用してください。
`int`	`lastIndexOf(Object elem)` 非推奨です。 `MultipartFormData.lastIndexOf(Object)` を使用してください。
`ListIterator`	`listIterator()` 非推奨です。 `MultipartFormData.listIterator()` を使用してください。
`ListIterator`	`listIterator(int index)` 非推奨です。 `MultipartFormData.listIterator(int)` を使用してください。
`Object`	`remove(int index)` 非推奨です。 `MultipartFormData.remove(int)` を使用してください。
`boolean`	`remove(Object o)` 非推奨です。 `MultipartFormData.remove(Object)` を使用してください。
`boolean`	`removeAll(Collection c)` 非推奨です。 `MultipartFormData.removeAll(Collection)` を使用してください。
`boolean`	`retainAll(Collection c)` 非推奨です。 `MultipartFormData.retainAll(Collection)` を使用してください。
`Object`	`set(int index, Object element)` 非推奨です。 `MultipartFormData.set(int, Object)` を使用してください。
`int`	`size()` 非推奨です。 `MultipartFormData.size()` を使用してください。
`List`	`subList(int fromIndex, int toIndex)` 非推奨です。 `MultipartFormData.subList(int, int)` を使用してください。
`Object[]`	`toArray()` 非推奨です。 `MultipartFormData.toArray()` を使用してください。
`Object[]`	`toArray(Object[] a)` 非推奨です。 `MultipartFormData.toArray(Object[])` を使用してください。
`void`	`trimToSize()` 非推奨です。 `MultipartFormData.trimToSize()` を使用してください。

クラスから継承されたメソッド java.util.ArrayList
clone, forEach, removeIf, removeRange, replaceAll, sort, spliterator

クラスから継承されたメソッド java.util.AbstractCollection
toString

クラスから継承されたメソッド java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド java.util.Collection
parallelStream, stream

- コンストラクタの詳細
  - MultipartFormData
```
public MultipartFormData(javax.servlet.ServletRequest req)
                  throws IOException,
                         IllegalArgumentException
```
    非推奨です。 MultipartFormData.MultipartFormData(ServletRequest) を使用してください。
    
    リクエストされた情報を解析して、新しいオブジェクトを構築します。
    multipart/form-data 形式のリクエストを解析します。
    req が multipart/form-data で受信したリクエストではない場合、 IllegalArgumentException をスローします。
    
    パラメータ:
    
    req - サーブレットエンジンから渡されるリクエスト情報オブジェクト
    
    例外:
    
    IOException - リクエストデータ解析時の入出力エラー
    
    IllegalArgumentException - 引数が不正の場合
- メソッドの詳細
  - getEntity
```
public MultipartFormData.Entity getEntity(int index)
```
    非推奨です。 MultipartFormData.getEntity(int) を使用してください。
    
    指定のインデックスに該当するエンティティを取得します。
    インデックスが範囲外の場合(インデックスが負または size() よりも大きい) IndexOutOfBoundsException をスローします。
    
    パラメータ:
    
    index - 返すエンティティのインデックス
    
    戻り値:
    
    リスト内の指定された位置にあるエンティティ
  - getEntity
```
public MultipartFormData.Entity getEntity(String name)
```
    非推奨です。 MultipartFormData.getEntity(String) を使用してください。
    
    指定の名前を持つエンティティを取得します。
    エンティティの名前とは、フォームのコントロール名称のことです。指定の名前を持つエンティティが複数存在する場合、その中のいずれか一つが返されます。該当するエンティティが存在しない場合 null を返します。
    
    戻り値:
    
    指定の名前を持つエンティティ
    
    関連項目:
    
    MultipartFormData.Entity.getName()
  - getEntities
```
public MultipartFormData.Entity[] getEntities(String name)
```
    非推奨です。 MultipartFormData.getEntities(String) を使用してください。
    
    指定の名前を持つエンティティをすべて取得します。
    エンティティの名前とは、フォームのコントロール名称のことです。該当するエンティティが存在しない場合、空の配列を返します。
    
    戻り値:
    
    指定の名前を持つエンティティ
    
    関連項目:
    
    MultipartFormData.Entity.getName()
  - add
```
public void add(int index,
                Object element)
```
    非推奨です。 MultipartFormData.add(int, Object) を使用してください。
    
    リストの指定された位置に、指定された要素を挿入します。
    
    定義:
    
    add インタフェース内 List
    
    オーバーライド:
    
    add クラス内 ArrayList
  - add
```
public boolean add(Object o)
```
    非推奨です。 MultipartFormData.add(Object) を使用してください。
    
    リストの最後に、指定された要素を追加します。
    
    定義:
    
    add インタフェース内 Collection
    
    定義:
    
    add インタフェース内 List
    
    オーバーライド:
    
    add クラス内 ArrayList
  - addAll
```
public boolean addAll(Collection c)
```
    非推奨です。 MultipartFormData.addAll(Collection) を使用してください。
    
    リストの末尾に、指定された Collection のすべての要素を追加します。
    
    定義:
    
    addAll インタフェース内 Collection
    
    定義:
    
    addAll インタフェース内 List
    
    オーバーライド:
    
    addAll クラス内 ArrayList
  - addAll
```
public boolean addAll(int index,
                      Collection c)
```
    非推奨です。 MultipartFormData.addAll(int, Collection) を使用してください。
    
    リスト内の指定された位置から、指定された Collection のすべての要素を挿入します。
    
    定義:
    
    addAll インタフェース内 List
    
    オーバーライド:
    
    addAll クラス内 ArrayList
  - clear
```
public void clear()
```
    非推奨です。 MultipartFormData.clear() を使用してください。
    
    リストからすべての要素を削除します。
    
    定義:
    
    clear インタフェース内 Collection
    
    定義:
    
    clear インタフェース内 List
    
    オーバーライド:
    
    clear クラス内 ArrayList
  - contains
```
public boolean contains(Object elem)
```
    非推奨です。 MultipartFormData.contains(Object) を使用してください。
    
    リストに指定の要素がある場合に true を返します。
    
    定義:
    
    contains インタフェース内 Collection
    
    定義:
    
    contains インタフェース内 List
    
    オーバーライド:
    
    contains クラス内 ArrayList
  - containsAll
```
public boolean containsAll(Collection c)
```
    非推奨です。 MultipartFormData.containsAll(Collection) を使用してください。
    
    このコレクション内に、指定されたコレクションのすべての要素がある場合に true を返します。
    
    定義:
    
    containsAll インタフェース内 Collection
    
    定義:
    
    containsAll インタフェース内 List
    
    オーバーライド:
    
    containsAll クラス内 AbstractCollection
  - ensureCapacity
```
public void ensureCapacity(int minCapacity)
```
    非推奨です。 MultipartFormData.ensureCapacity(int) を使用してください。
    
    必要に応じて、この ArrayList のインスタンスのサイズを拡大し、少なくとも最小サイズ引数で指定された数の要素を格納できるようにします。
    
    オーバーライド:
    
    ensureCapacity クラス内 ArrayList
  - equals
```
public boolean equals(Object o)
```
    非推奨です。 MultipartFormData.equals(Object) を使用してください。
    
    指定されたオブジェクトとリストが等しいかどうかを比較します。
    
    定義:
    
    equals インタフェース内 Collection
    
    定義:
    
    equals インタフェース内 List
    
    オーバーライド:
    
    equals クラス内 AbstractList
  - get
```
public Object get(int index)
```
    非推奨です。 MultipartFormData.get(int) を使用してください。
    
    リスト内の指定された位置にある要素を返します。
    
    定義:
    
    get インタフェース内 List
    
    オーバーライド:
    
    get クラス内 ArrayList
  - hashCode
```
public int hashCode()
```
    非推奨です。 MultipartFormData.hashCode() を使用してください。
    
    このリストのハッシュコード値を返します。
    
    定義:
    
    hashCode インタフェース内 Collection
    
    定義:
    
    hashCode インタフェース内 List
    
    オーバーライド:
    
    hashCode クラス内 AbstractList
  - indexOf
```
public int indexOf(Object elem)
```
    非推奨です。 MultipartFormData.indexOf(Object) を使用してください。
    
    equals メソッドを使って等しいかどうかを判定しながら、指定された引数と同じ内容の要素を先頭から検索します。
    
    定義:
    
    indexOf インタフェース内 List
    
    オーバーライド:
    
    indexOf クラス内 ArrayList
  - isEmpty
```
public boolean isEmpty()
```
    非推奨です。 MultipartFormData.isEmpty() を使用してください。
    
    リストに要素がないかどうかを判定します。
    
    定義:
    
    isEmpty インタフェース内 Collection
    
    定義:
    
    isEmpty インタフェース内 List
    
    オーバーライド:
    
    isEmpty クラス内 ArrayList
  - iterator
```
public Iterator iterator()
```
    非推奨です。 MultipartFormData.iterator() を使用してください。
    
    このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。
    
    定義:
    
    iterator インタフェース内 Iterable
    
    定義:
    
    iterator インタフェース内 Collection
    
    定義:
    
    iterator インタフェース内 List
    
    オーバーライド:
    
    iterator クラス内 ArrayList
  - lastIndexOf
```
public int lastIndexOf(Object elem)
```
    非推奨です。 MultipartFormData.lastIndexOf(Object) を使用してください。
    
    指定されたオブジェクトがリスト内で最後に現れるインデックスを返します。
    
    定義:
    
    lastIndexOf インタフェース内 List
    
    オーバーライド:
    
    lastIndexOf クラス内 ArrayList
  - listIterator
```
public ListIterator listIterator()
```
    非推奨です。 MultipartFormData.listIterator() を使用してください。
    
    このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。
    
    定義:
    
    listIterator インタフェース内 List
    
    オーバーライド:
    
    listIterator クラス内 ArrayList
  - listIterator
```
public ListIterator listIterator(int index)
```
    非推奨です。 MultipartFormData.listIterator(int) を使用してください。
    
    リスト内の要素を適切な順序で繰り返し処理する、リスト内の指定された位置から開始する反復子を返します。
    
    定義:
    
    listIterator インタフェース内 List
    
    オーバーライド:
    
    listIterator クラス内 ArrayList
  - remove
```
public Object remove(int index)
```
    非推奨です。 MultipartFormData.remove(int) を使用してください。
    
    リスト内の指定された位置から要素を削除します。
    
    定義:
    
    remove インタフェース内 List
    
    オーバーライド:
    
    remove クラス内 ArrayList
  - remove
```
public boolean remove(Object o)
```
    非推奨です。 MultipartFormData.remove(Object) を使用してください。
    
    指定された要素のインスタンスがこのコレクションにあれば、そのインスタンスをコレクションから 1 つ削除します。
    
    定義:
    
    remove インタフェース内 Collection
    
    定義:
    
    remove インタフェース内 List
    
    オーバーライド:
    
    remove クラス内 ArrayList
  - removeAll
```
public boolean removeAll(Collection c)
```
    非推奨です。 MultipartFormData.removeAll(Collection) を使用してください。
    
    このコレクションから、指定されたコレクションに含まれる要素をすべて削除します。
    
    定義:
    
    removeAll インタフェース内 Collection
    
    定義:
    
    removeAll インタフェース内 List
    
    オーバーライド:
    
    removeAll クラス内 ArrayList
  - retainAll
```
public boolean retainAll(Collection c)
```
    非推奨です。 MultipartFormData.retainAll(Collection) を使用してください。
    
    このコレクションにおいて、指定されたコレクションに格納されている要素だけを保持します。
    
    定義:
    
    retainAll インタフェース内 Collection
    
    定義:
    
    retainAll インタフェース内 List
    
    オーバーライド:
    
    retainAll クラス内 ArrayList
  - set
```
public Object set(int index,
                  Object element)
```
    非推奨です。 MultipartFormData.set(int, Object) を使用してください。
    
    リストの指定された位置にある要素を、指定された要素で置き換えます。
    
    定義:
    
    set インタフェース内 List
    
    オーバーライド:
    
    set クラス内 ArrayList
  - size
```
public int size()
```
    非推奨です。 MultipartFormData.size() を使用してください。
    
    リスト内にある要素の数を返します。
    
    定義:
    
    size インタフェース内 Collection
    
    定義:
    
    size インタフェース内 List
    
    オーバーライド:
    
    size クラス内 ArrayList
  - subList
```
public List subList(int fromIndex,
                    int toIndex)
```
    非推奨です。 MultipartFormData.subList(int, int) を使用してください。
    
    このリストの、fromIndex (これを含む) から toIndex (これを含まない) の範囲の部分のビューを返します。
    
    定義:
    
    subList インタフェース内 List
    
    オーバーライド:
    
    subList クラス内 ArrayList
  - toArray
```
public Object[] toArray()
```
    非推奨です。 MultipartFormData.toArray() を使用してください。
    
    リスト内のすべての要素が正しい順序で格納されている配列を返します。
    
    定義:
    
    toArray インタフェース内 Collection
    
    定義:
    
    toArray インタフェース内 List
    
    オーバーライド:
    
    toArray クラス内 ArrayList
  - toArray
```
public Object[] toArray(Object[] a)
```
    非推奨です。 MultipartFormData.toArray(Object[]) を使用してください。
    
    リスト内のすべての要素が正しい順序で格納されている配列を返します。
    
    定義:
    
    toArray インタフェース内 Collection
    
    定義:
    
    toArray インタフェース内 List
    
    オーバーライド:
    
    toArray クラス内 ArrayList
  - trimToSize
```
public void trimToSize()
```
    非推奨です。 MultipartFormData.trimToSize() を使用してください。
    
    この ArrayList のインスタンスのサイズをリストの現在のサイズに縮小します。
    
    オーバーライド:
    
    trimToSize クラス内 ArrayList

クラス MultipartFormData

留意点

ネストされたクラスのサマリー

フィールドのサマリー

クラスから継承されたフィールド java.util.AbstractList

コンストラクタのサマリー

メソッドのサマリー

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

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

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

インタフェースから継承されたメソッド java.util.Collection

コンストラクタの詳細

MultipartFormData

メソッドの詳細

getEntity

getEntity

getEntities

add

add

addAll

addAll

clear

contains

containsAll

ensureCapacity

equals

get

hashCode

indexOf

isEmpty

iterator

lastIndexOf

listIterator

listIterator

remove

remove

removeAll

retainAll

set

size

subList

toArray

toArray

trimToSize