com.nttdocomo.fs
クラス File

Object
  拡張com.nttdocomo.fs.File

public class File
extends Object
 [iアプリオプションAPI]

ファイルを定義します。 このクラスのインスタンスはファイルへのパス名を保持します。 各メソッドは、呼び出された時点でストレージデバイスのそのパス名のファイルに対して各種の処理を行います。 なお、 "/" をパス区切り文字として扱います。

ファイルクラスでは以下の操作を行うことができます。

実装によっては、同じファイルの実体(ストレージデバイス上の実際のファイル)を表す複数の File インスタンスが存在する場合があります。 その場合でも、File インスタンスへのメソッド呼び出しはどのインスタンスに対するものであっても同一ファイルへのアクセスとみなされます。 すなわち、例えばある File インスタンス f1 を書き込み用にオープンしている場合は、 同じファイルを表す異なる File インスタンス f2 に対して読み出し用にオープンしようとしても例外が発生します。


フィールドの概要
static int MODE_READ_ONLY
           読み出し専用でファイルをオープンすることを表すモードです(=0)。
static int MODE_READ_WRITE
           読み書き可能としてファイルをオープンすること表すモードです(=2)。
static int MODE_WRITE_ONLY
           書き込み専用でファイルをオープンすることを表すモードです(=1)。
 
メソッドの概要
 void delete()
           ファイルを削除します。
 AccessToken getAccessToken()
           このファイルへのアクセス権を取得します。
 Folder getFolder()
           このファイルの取得元のフォルダインスタンスを取得します。
 long getLastModified()
           ファイルの更新日時を取得します。
 long getLength()
           ファイルサイズを取得します。
 String getPath()
           このファイルのパス名(絶対パス)を取得します。
 FileEntity open(int mode)
           ファイルをオープンします。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

MODE_READ_ONLY

public static final int MODE_READ_ONLY

読み出し専用でファイルをオープンすることを表すモードです(=0)。

関連項目:
定数フィールド値

MODE_WRITE_ONLY

public static final int MODE_WRITE_ONLY

書き込み専用でファイルをオープンすることを表すモードです(=1)。

関連項目:
定数フィールド値

MODE_READ_WRITE

public static final int MODE_READ_WRITE

読み書き可能としてファイルをオープンすること表すモードです(=2)。

関連項目:
定数フィールド値
メソッドの詳細

getFolder

public Folder getFolder()

このファイルの取得元のフォルダインスタンスを取得します。

戻り値:
このファイルの取得元のフォルダインスタンスを返します。

getAccessToken

public AccessToken getAccessToken()

このファイルへのアクセス権を取得します。

戻り値:
このファイルへのアクセス権を返します。

getPath

public String getPath()

このファイルのパス名(絶対パス)を取得します。

戻り値:
このファイルのパス名(絶対パス)を返します。

open

public FileEntity open(int mode)
                throws java.io.IOException

ファイルをオープンします。 既にファイルがオープンされている場合は多重オープンしようとします。 既に読み出し専用でファイルがオープンされている場合は、 多重に読み出し専用でオープンすることができます。 既に書き込み専用または読み書き可能でファイルがオープンされている場合は、 多重にオープンすることはできません。

[DoJa-5.0 (903i) 以降]
暗号化ブロックサイズが64KBを超えているファイルは「書き込み不可」 とみなされます。 したがって、そのようなファイルを MODE_WRITE_ONLY, MODE_READ_WRITE を指定してオープンしようとすると例外が発生します。

パラメータ:
mode - ファイルをオープンする際のモードを指定します。 MODE_READ_ONLY, MODE_WRITE_ONLY, MODE_READ_WRITE のいずれかを指定します。
戻り値:
ファイルの実体を返します。
例外:
IllegalArgumentException - 引数の mode が不正な場合に発生します。
FileNotAccessibleException - 既に読み出し専用以外のモードで、 このファイルがオープンされている場合に発生します(IN_USE)。
FileNotAccessibleException - 引数 mode に MODE_READ_ONLY 以外を指定して多重オープンしようとした場合に発生します(IN_USE)。
FileNotAccessibleException - 読み込み不可であるファイルに対して MODE_READ_ONLY, MODE_READ_WRITE を指定してオープンしようとした場合に発生します(ACCESS_DENIED)。
FileNotAccessibleException - 書き込み不可 (暗号化ブロックサイズが 64KB を超えている場合や、 メディアのライトプロテクト等による場合も含む) であるファイルに対して MODE_WRITE_ONLY, MODE_READ_WRITE を指定してオープンしようとした場合に発生します(ACCESS_DENIED)。
MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。
FileNotAccessibleException - 既にこのファイルが削除されている場合に発生します(NOT_FOUND)。
java.io.IOException - I/O エラーが発生した場合に発生します。

delete

public void delete()
            throws java.io.IOException

ファイルを削除します。 ただし、オープンされているファイルを削除することはできません。

ファイルを削除した後にこのクラスのメソッドを呼び出すことはできません。

例外:
MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。
FileNotAccessibleException - 既にこのファイルが削除されている場合に発生します(NOT_FOUND)。
FileNotAccessibleException - このオブジェクトまたは別オブジェクトにより、 このファイルがオープンされている場合に発生します(IN_USE)。
FileNotAccessibleException - ファイルシステム上のアクセス制限やメディアのライトプロテクト等に起因して、 ファイルの削除が拒否された場合に発生します(ACCESS_DENIED)。
java.io.IOException - I/O エラーが発生した場合に発生します。

getLength

public long getLength()
               throws java.io.IOException

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

戻り値:
ファイルサイズを返します。
例外:
MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。
FileNotAccessibleException - 既にこのファイルが削除されている場合に発生します(NOT_FOUND)。
java.io.IOException - I/O エラーが発生した場合に発生します。

getLastModified

public long getLastModified()
                     throws java.io.IOException

ファイルの更新日時を取得します。

戻り値:
ファイルの更新日時と 1970 年 1 月 1 日午前 0 時 (GMT) との差をミリ秒単位で返します。
例外:
MediaNotFoundException - このファイルが記録されているメディアが存在しないことを、 システムが検知した場合に発生します。
FileNotAccessibleException - 既にこのファイルが削除されている場合に発生します(NOT_FOUND)。
java.io.IOException - I/O エラーが発生した場合に発生します。


NTT DOCOMO,INC.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ(その他に許諾者がある場合は当該許諾者も含めて)の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

FeliCaは、ソニー株式会社が開発した非接触ICカードの技術方式です。FeliCaは、ソニー株式会社の登録商標です。

「iモード」、「iアプリ/アイアプリ」、「i-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

その他記載された会社名、製品名などは該当する各社の商標または登録商標です。