com.docomostar.fs
クラス InternalStorageFile

Object
  com.docomostar.fs.InternalStorageFile

public class InternalStorageFile
extends Object

内部ストレージに作成されたファイルを定義します。

このクラスのインスタンスはファイルへのパス名を保持します。
各メソッドは、呼び出された時点でストレージデバイスのそのパス名のファイルに対して各種の処理を行います。
なお、 "/" をパス区切り文字として扱います。
getFilePath() を実行することで得られるパス名に、実行したインスタンスのファイル名も含まれます。 ファイル名は、パス名の最後のパス区切り文字("/")から文字列の最後までが該当します。

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

導入されたバージョン:

Star-2.0

フィールドの概要

static int	MODE_READ_ONLY 読み出し専用でファイルをオープンすることを表すモードです(=0)。
static int	MODE_READ_WRITE 読み書き可能としてファイルをオープンすること表すモードです(=2)。
static int	MODE_WRITE_ONLY 書き込み専用でファイルをオープンすることを表すモードです(=1)。

メソッドの概要

void	deleteFile() ファイルを削除します。
boolean	equals(Object obj) 渡されたオブジェクトとインスタンスを比較します。
String	getFilePath() このファイルのパス名(絶対パス)を取得します。
InternalStorageFolder	getFolder() このファイルが存在するフォルダインスタンスを取得します。
long	getLength() ファイルのデータサイズを取得します。
int	hashCode() このオブジェクトに対応するハッシュコードを返します。
FileEntity	open(int mode) ファイルをオープンします。

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

getClass, 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)。

関連項目:

定数フィールド値

メソッドの詳細

deleteFile

public void deleteFile()
                throws java.io.IOException

ファイルを削除します。

既にファイルが削除されている場合(同じファイルを表す異なるインスタンスから削除している場合、ファイルが存在するフォルダを削除している場合を含む)は例外が発生します。

例外:

FileNotAccessibleException -
(IN_USE)
既にファイルがオープンされている場合に発生します。

FileNotAccessibleException -
(NOT_FOUND)
既にこのファイルが削除されている場合に発生します。

open

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

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

パラメータ:

mode - ファイルをオープンする際のモードを指定します。

戻り値:

ファイルの実体を返します。

例外:

IllegalArgumentException -
引数の mode が不正な場合に発生します。

FileNotAccessibleException -
(IN_USE)
既に読み出し専用以外のモードで、 このファイルがオープンされている場合に発生します。

FileNotAccessibleException -
(IN_USE)
引数 mode に MODE_READ_ONLY 以外を指定して多重オープンしようとした場合に発生します。

FileNotAccessibleException -
(NOT_FOUND)
既にこのファイルが削除されている場合に発生します。

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

getFolder

public InternalStorageFolder getFolder()
                                throws java.io.IOException

このファイルが存在するフォルダインスタンスを取得します。

戻り値:

このファイルが存在するフォルダインスタンスを返します。

例外:

FileNotAccessibleException -
(NOT_FOUND)
既にこのファイルが削除されている場合に発生します。

getFilePath

public String getFilePath()
                   throws java.io.IOException

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

戻り値:

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

例外:

FileNotAccessibleException -
(NOT_FOUND)
既にこのファイルが削除されている場合に発生します。

getLength

public long getLength()
               throws java.io.IOException

ファイルのデータサイズを取得します。

戻り値:

データサイズ [bytes] を返します。

例外:

FileNotAccessibleException -
(NOT_FOUND)
既にこのファイルが削除されている場合に発生します。

equals

public boolean equals(Object obj)

渡されたオブジェクトとインスタンスを比較します。 渡されたオブジェクトが InternalStorageFile クラスであり、保持しているパスが同等である場合に true を返します。

オーバーライド:

クラス Object 内の equals

パラメータ:

obj - 比較対象のオブジェクトを渡します。

戻り値:

比較対象のオブジェクトと等しい場合に true、等しくない場合に false を返します。

hashCode

public int hashCode()

このオブジェクトに対応するハッシュコードを返します。

getFilePath() で取得するパス名が同じ場合、同じハッシュコードが返ります。

オーバーライド:

クラス Object 内の hashCode

戻り値:

このオブジェクトに対応するハッシュコードを返します。