org.apache.commons.fileupload
インタフェース FileItem

すべてのスーパーインタフェース:

Serializable

既知の実装クラスの一覧:

DefaultFileItem

public interface FileItem

extends Serializable

このクラスはクライアントから受け取る multipart/form-data のPOSTリクエスト内のファイルまたはアイテムを表現したものです。

FileUpload からこのクラスインスタンスを取得した後 ( #parseRequest(javax.servlet.http.HttpServletRequest) を参照) 、 get() メソッドを使ってすべてのファイルの内容を(メモリ上に)取得するか、 getInputStream() メソッドを使って InputStream を取得し、メモリ上に展開することなくファイルを処理する (大きなファイルを扱う場合に有用)かを選択することができます。

このインターフェイスは(めったに使われない依存関係を避けるため) javax.activation.DataSource を継承していませんが、 定義されたいくつかのメソッドはこのインターフェイスとまったく同じ名称で定義されています。 そのため、このインターフェイスの実装クラスに最低限の修正を加えることで javax.activation.DataSource も実装することができます。

バージョン:

$Id: FileItem.java,v 1.5 2004/04/13 09:29:57 hioki Exp $

作成者:

Rafal Krzewski, Sean Legassick, Jason van Zyl, Martin Cooper

翻訳者:

日置 聡

校正者:

入江 弘憲

メソッドの概要

void	delete() 関係する一時ディスク領域も含むストレージ上のファイルアイテムを削除します。
byte[]	get() ファイルアイテムの内容をバイト配列で返します。
String	getContentType() ブラウザによって付加されたコンテントタイプを返します。
String	getFieldName() ファイルアイテムに対応したマルチパートフォームフィールド名を返します。
InputStream	getInputStream() ファイルの内容を取得するための InputStream を返します。
String	getName() ブラウザ(または他のクライアントソフトウェア)によって渡された クライアントのファイルシステム上でのオリジナルのファイル名を返します。
OutputStream	getOutputStream() ファイルの内容を保持するための OutputStream を返します。
long	getSize() ファイルアイテムのサイズを返します。
String	getString() デフォルトのキャラクタエンコーディングを使用してファイルアイテムの内容の文字列表現を返します。
String	getString(String encoding) 指定されたエンコーディングを使用してファイルアイテムの内容の文字列表現を返します。
boolean	isFormField() FileItem インスタンスが単純なフォームフィールドを示すかどうかを判断します。
boolean	isInMemory() ファイルの内容をメモリ上から読み込むことができるかどうかを示します。
void	setFieldName(String name) このファイルアイテムを参照するためのフィールド名を設定します。
void	setFormField(boolean state) FileItem インスタンスが単純なフォームフィールドを示すかどうかを設定します。
void	write(File file) アップロードアイテムをディスクに書き出すための簡易メソッドです。

メソッドの詳細

getInputStream

public InputStream getInputStream()
                           throws IOException

ファイルの内容を取得するための InputStream を返します。

戻り値:

ファイルの内容を取得するための InputStream 。

例外:

IOException - エラーが発生した場合。

getContentType

public String getContentType()

ブラウザによって付加されたコンテントタイプを返します。 定義されていない場合には null を返します。

戻り値:

ブラウザによって付加されたコンテントタイプ。 定義されていない場合には null。

getName

public String getName()

ブラウザ(または他のクライアントソフトウェア)によって渡された クライアントのファイルシステム上でのオリジナルのファイル名を返します。 大体の場合、これはパス情報を除いた元のファイル名になります。 しかし、Operaブラウザ等のいくつかのクライアントではパス情報が含まれます。

戻り値:

クライアントのファイルシステム上でのオリジナルのファイル名。

isInMemory

public boolean isInMemory()

ファイルの内容をメモリ上から読み込むことができるかどうかを示します。

戻り値:

true ファイルの内容をメモリ上から読み込むことができる場合; false その他の場合。

getSize

public long getSize()

ファイルアイテムのサイズを返します。

戻り値:

ファイルアイテムのバイト単位のサイズ 。

get

public byte[] get()

ファイルアイテムの内容をバイト配列で返します。

戻り値:

ファイルアイテムの内容を示すバイト配列。

getString

public String getString(String encoding)
                 throws UnsupportedEncodingException

指定されたエンコーディングを使用してファイルアイテムの内容の文字列表現を返します。 このメソッドはアイテムの内容を取得するために get() メソッドを使用します。

パラメータ:

encoding - 使用するキャラクタエンコーディング。

戻り値:

アイテムの内容の文字列表現。

例外:

UnsupportedEncodingException - 指定されたエンコーディングが利用できなかった場合。

getString

public String getString()

デフォルトのキャラクタエンコーディングを使用してファイルアイテムの内容の文字列表現を返します。 このメソッドはアイテムの内容を取得するために get() メソッドを使用します。

戻り値:

アイテムの内容の文字列表現。

write

public void write(File file)
           throws Exception

アップロードアイテムをディスクに書き出すための簡易メソッドです。 クライアントコードはアイテムがメモリに保持されているか、ディスクの一時領域に保持されているかを考慮しません。 アップロードアイテムをファイルに書き出すことだけを考えます。

このメソッドは同じアイテムに対して複数回コールされた場合、処理を保証しません。 この事は特別な実装を可能とします。 たとえばファイル名の変更はファイルのデータをすべてコピーするよりも 非常に大きなパフォーマンスのメリットをもたらします。

パラメータ:

file - アップロードアイテムの出力先となる File 。

例外:

Exception - エラーが発生した場合。

delete

public void delete()

関係する一時ディスク領域も含むストレージ上のファイルアイテムを削除します。 FileItem インスタンスがガベージコレクションにかかった時にこのストレージは削除されますが、 このメソッドは早く確実に削除を実施し、システムリソースを保護します。

getFieldName

public String getFieldName()

ファイルアイテムに対応したマルチパートフォームフィールド名を返します。

戻り値:

フォームフィールド名。

setFieldName

public void setFieldName(String name)

このファイルアイテムを参照するためのフィールド名を設定します。

パラメータ:

name - フォームフィールド名。

isFormField

public boolean isFormField()

FileItem インスタンスが単純なフォームフィールドを示すかどうかを判断します。

戻り値:

true インスタンスが単純なフォームフィールドを示す場合; false インスタンスがアップロードされたファイルを示す場合。

setFormField

public void setFormField(boolean state)

FileItem インスタンスが単純なフォームフィールドを示すかどうかを設定します。

パラメータ:

state - true インスタンスが単純なフォームフィールドを示す場合; false インスタンスがアップロードされたファイルを示す場合。

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

ファイルの内容を保持するための OutputStream を返します。

戻り値:

ファイルの内容を保持するための OutputStream 。

例外:

IOException - エラーが発生した場合。