com.nttdocomo.io
クラス FileEntity

Object
  com.nttdocomo.io.FileEntity

public class FileEntity

extends Object

[iアプリオプションAPI]

ファイルの実体を定義します。 ファイルシステム上のフォルダやファイルといったエントリは、 com.nttdocomo.fs パッケージの Folder や File クラスによって表されます。 このクラスは File.open(int) メソッドによってオープンされたファイルの実体を表し、 ファイルに対する読み書きなどのアクセス手段を提供します。

ファイルの読み書きを行うには、 ストリームとしてアクセスする方法とファイルとしてアクセスする方法とがあります。 ストリームとしてアクセスする場合は、 既存の java.io パッケージのクラスや DoJa API のクラスとの親和性が高いという利点があります。 一方、ファイルとしてアクセスする場合は、 ランダムアクセスが容易であるという利点があります。 ただし、このクラスの同一インスタンスに対して、 ストリームとしてのアクセスとファイルとしてのアクセスを同時に行うことはできません。

ファイルの読み書きについては、 読み出しメソッドや書き込みメソッドを連続して呼び出している最中に i アプリがサスペンドしても読み書きの一貫性が保たれることが保証されています。

このクラスのインスタンスでは、ファイルアクセスの際のバッファサイズを設定したり取得したりすることができます。 なお、バッファサイズは、ストレージデバイスやメディアやドライバやメモリ等の制限により、 実装において引数で指定した値とは異なる値が使用される場合があります。

導入されたバージョン:

DoJa-4.1(902i)

メソッドの概要

void	close() ファイルをクローズします。
int	getBufferSize() バッファサイズを取得します。
FileDataInput	openDataInput() ファイルを読み出すためのデータ入力インスタンスをオープンし、返します。
FileDataOutput	openDataOutput() ファイルに書き込むためのデータ出力インスタンスをオープンし、返します。
java.io.InputStream	openInputStream() ファイルを読み出すための入力ストリームをオープンし、返します。
java.io.OutputStream	openOutputStream() ファイルに書き込むための出力ストリームをオープンし、返します。
void	setBufferSize(int bufferSize) バッファサイズを設定します。

クラス Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

close

public void close()
           throws java.io.IOException

ファイルをクローズします。 ファイルが既にクローズされている場合は何もしません。

例外:

MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。

java.io.IOException - I/O エラーが発生した場合に発生します。

setBufferSize

public void setBufferSize(int bufferSize)
                   throws java.io.IOException

バッファサイズを設定します。

なお、バッファサイズは、ストレージデバイスやメディアやドライバやメモリ等の制限により、 実装において引数で指定した値とは異なる値が使用される場合があります。

また、データがバッファにある状態で、 setBufferSize() メソッドを呼び出した場合の振る舞いは機種依存です。

パラメータ:

bufferSize - バッファサイズを指定します。

例外:

RuntimeException - このオブジェクトが既にクローズされている場合に発生します。

IllegalArgumentException - 引数 bufferSize が負の場合に発生します。

MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。

java.io.IOException - I/O エラーが発生した場合に発生します。

getBufferSize

public int getBufferSize()
                  throws java.io.IOException

バッファサイズを取得します。

このメソッドは setBufferSize(int) の引数に指定された値をそのまま返すとは限りません。 ストレージデバイスやメディアやドライバやメモリ等の制限によって引数に指定された値と異なる値が使用されている場合は、 実際に使用されているバッファサイズを返します。

戻り値:

バッファサイズを返します。

例外:

RuntimeException - このオブジェクトが既にクローズされている場合に発生します。

MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。

java.io.IOException - I/O エラーが発生した場合に発生します。

openDataInput

public FileDataInput openDataInput()
                            throws java.io.IOException

ファイルを読み出すためのデータ入力インスタンスをオープンし、返します。

openInputStream(), openOutputStream() とは排他利用となります。 すなわち、それらのメソッド呼び出しによってストリームがオープンされている最中にデータ入力インスタンスを取得しようとした場合は例外が発生します。

戻り値:

データ入力インスタンスを返します。

例外:

RuntimeException - このオブジェクトが既にクローズされている場合に発生します。

ConnectionException - 書き込み専用でオープンしたファイルに対して呼び出された場合に発生します (ILLEGAL_STATE)。

ConnectionException - InputStream または OutputStream のオープン中に呼び出された場合に発生します (ILLEGAL_STATE)。

ConnectionException - DataInput のオープン中に呼び出された場合に発生します(ILLEGAL_STATE)。

MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。

java.io.IOException - I/O エラーが発生した場合に発生します。

openDataOutput

public FileDataOutput openDataOutput()
                              throws java.io.IOException

ファイルに書き込むためのデータ出力インスタンスをオープンし、返します。

openInputStream(), openOutputStream() とは排他利用となります。 すなわち、それらのメソッド呼び出しによってストリームがオープンされている最中にデータ出力インスタンスを取得しようとした場合は例外が発生します。

戻り値:

データ出力インスタンスを返します。

例外:

RuntimeException - このオブジェクトが既にクローズされている場合に発生します。

ConnectionException - 読み出し専用でオープンしたファイルに対して呼び出された場合に発生します (ILLEGAL_STATE)。

ConnectionException - InputStream または OutputStream のオープン中に呼び出された場合に発生します (ILLEGAL_STATE)。

ConnectionException - DataOutput のオープン中に呼び出された場合に発生します(ILLEGAL_STATE)。

MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。

java.io.IOException - I/O エラーが発生した場合に発生します。

openInputStream

public java.io.InputStream openInputStream()
                                    throws java.io.IOException

ファイルを読み出すための入力ストリームをオープンし、返します。

openDataInput(), openDataOutput() とは排他利用となります。 すなわち、それらのメソッド呼び出しによってデータ入出力インスタンスがオープンされている最中に入力ストリームを取得しようとした場合は例外が発生します。

戻り値:

入力ストリームを返します。

例外:

RuntimeException - このオブジェクトが既にクローズされている場合に発生します。

ConnectionException - 書き込み専用でオープンしたファイルに対して呼び出された場合に発生します (ILLEGAL_STATE)。

ConnectionException - DataInput または DataOutput のオープン中に呼び出された場合に発生します (ILLEGAL_STATE)。

ConnectionException - InputStream のオープン中に呼び出された場合に発生します(ILLEGAL_STATE)。

MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。

java.io.IOException - I/O エラーが発生した場合に発生します。

openOutputStream

public java.io.OutputStream openOutputStream()
                                      throws java.io.IOException

ファイルに書き込むための出力ストリームをオープンし、返します。

openDataInput(), openDataOutput() とは排他利用となります。 すなわち、それらのメソッド呼び出しによってデータ入出力インスタンスがオープンされている最中に出力ストリームを取得しようとした場合は例外が発生します。

戻り値:

出力ストリームを返します。

例外:

RuntimeException - このオブジェクトが既にクローズされている場合に発生します。

ConnectionException - 読み出し専用でオープンしたファイルに対して呼び出された場合に発生します (ILLEGAL_STATE)。

ConnectionException - DataInput, DataOutput オープン中に呼び出された場合に発生します (ILLEGAL_STATE)。

ConnectionException - OutputStream のオープン中に呼び出された場合に発生します(ILLEGAL_STATE)。

MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。

java.io.IOException - I/O エラーが発生した場合に発生します。