|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Objectcom.docomostar.fs.InternalStorageFolder
public class InternalStorageFolder
内部ストレージに作成されたフォルダを定義します。
このクラスのインスタンスはフォルダへのパス名を保持します。
各メソッドは、呼び出された時点で内部ストレージデバイスのそのパス名のフォルダに対して各種の処理を行います。
なお、 "/" をパス区切り文字として扱います。
getFolderPath()
を実行することで得られるパス名に、実行したインスタンスのフォルダ名も含まれます。
フォルダ名は、パス名の最後のパス区切り文字("/")から文字列の最後までが該当します。
実装によっては、同じフォルダの実体(内部ストレージ上の実際のフォルダ)を表す複数の
InternalStorageFolder インスタンスが存在する場合があります。
その場合でも、 InternalStorageFolder インスタンスへのメソッド呼び出しは、
どのインスタンスに対するものであっても同一フォルダへのアクセスとみなされます。
すなわち、ある InternalStorageFolder インスタンス f1 でファイルを新たに生成した場合は、
同じフォルダを表す異なる InternalStorageFolder インスタンス f2
に対してそのフォルダに含まれる全てのファイルのインスタンスを取得するメソッドを呼び出すと、
新たに生成したファイルも含む全てのファイルのインスタンスが返されます。
メソッドの概要 | |
---|---|
InternalStorageFile |
createFile(String fileName)
内部ストレージにファイルを作成します。 |
InternalStorageFolder |
createSubFolder(String folderName)
内部ストレージにフォルダを作成します。 |
void |
deleteFolder()
フォルダを削除します。 |
boolean |
equals(Object obj)
渡されたオブジェクトとインスタンスを比較します。 |
InternalStorageFile[] |
getAllFiles()
ファイルの一覧を取得します。 |
InternalStorageFolder[] |
getAllFolders()
フォルダの一覧を取得します。 |
InternalStorageFile |
getFile(String fileName)
ファイル名を指定してファイルインスタンスを取得します。 |
InternalStorageFolder |
getFolder(String folderName)
フォルダ名を指定してフォルダインスタンスを取得します。 |
String |
getFolderPath()
このフォルダのパス名(絶対パス)を取得します。 |
InternalStorageFolder |
getParentFolder()
このフォルダが存在する フォルダ インスタンスを取得します。 |
int |
hashCode()
このオブジェクトに対応するハッシュコードを返します。 |
クラス Object から継承されたメソッド |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
メソッドの詳細 |
---|
public InternalStorageFolder createSubFolder(String folderName) throws java.io.IOException
内部ストレージにフォルダを作成します。
作成するフォルダのフォルダ名は、以下の形式で指定可能です。
ただし、フォルダ名として指定可能な文字数を超過した場合は、超過分を切り捨てます。
なお、フォルダ名は、超過分の切り捨てを行ってから指定可能な文字の確認を行います。
フォルダを作成する階層に、既に同名のフォルダまたはファイルが存在している場合は例外が発生します。
folderName
- フォルダ名を指定します。
NullPointerException
-
IllegalArgumentException
-
FolderException
- FolderException
- FileSystemFullException
-
IllegalStateException
-
FolderException
- public void deleteFolder() throws java.io.IOException
フォルダを削除します。
削除対象のフォルダの配下にあるフォルダおよびファイルを全て削除します。
配下にあるファイルが既にオープンされている場合は、削除を中止し、例外が発生します。
配下に複数のファイルが存在する場合も同様で、一つでもファイルがオープンされている場合は例外が発生します。
このとき、オープンされていない他のファイルが削除されることはありません。
IllegalStateException
-
FolderException
- FileNotAccessibleException
- FolderException
- public InternalStorageFile createFile(String fileName) throws java.io.IOException
内部ストレージにファイルを作成します。
作成するファイルのファイル名は、以下の形式で指定可能です。
ファイル名として指定可能な文字数を超過した場合は、x・・・xとy・・・yそれぞれの部分について超過分を切り捨てます。
なお、ファイル名は、超過分の切り捨てを行ってから指定可能な文字の確認を行います。
また、yyyを0桁とした場合に'.'を付加することはできません。その場合は例外が発生します。
ファイルを作成する階層に、既に同名のフォルダまたはファイルが存在している場合は、例外を返します。
fileName
- ファイル名を指定します。
NullPointerException
-
IllegalArgumentException
-
FileNotAccessibleException
- FolderException
- FileSystemFullException
-
IllegalStateException
-
FolderException
- public InternalStorageFolder[] getAllFolders() throws java.io.IOException
フォルダの一覧を取得します。 このメソッドを実行するフォルダインスタンスが表すフォルダの直下に存在するフォルダの一覧を取得します。
フォルダが存在しない場合は長さ 0 の配列を返します。
このメソッドを呼び出すたびに新たなインスタンスを生成して返すか、
それとも、毎回同じインスタンスを返すかは機種依存です。
返される配列は、このオブジェクトが内部で保持している配列のコピーです。
IllegalStateException
-
FolderException
- public InternalStorageFile[] getAllFiles() throws java.io.IOException
ファイルの一覧を取得します。 このメソッドを実行するフォルダインスタンスが表すフォルダの直下に存在するファイルの一覧を取得します。
ファイルが存在しない場合は長さ 0 の配列を返します。
このメソッドを呼び出すたびに新たなインスタンスを生成して返すか、
それとも、毎回同じインスタンスを返すかは機種依存です。
返される配列は、このオブジェクトが内部で保持している配列のコピーです。
IllegalStateException
-
FolderException
- public InternalStorageFolder getParentFolder() throws java.io.IOException
このフォルダが存在するフォルダ
インスタンスを取得します。
ルートフォルダを表すインスタンスに対して実行した場合は、例外が発生します。
IllegalStateException
-
FolderException
- FolderException
- public InternalStorageFolder getFolder(String folderName) throws java.io.IOException
フォルダ名を指定してフォルダインスタンスを取得します。
引数に指定可能なフォルダ名は、フォルダインスタンスが表すフォルダの直下に存在するフォルダの名前です。
小文字を指定した場合は、大文字として扱われます。
引数で指定したフォルダ名に対して超過分の切り捨てを行うことはありません。 つまり、フォルダを新規作成する際に FOLDER1234567 というフォルダ名を指定して作成した場合 FOLDER123456 というフォルダ名で作成されますが、このメソッドの引数に FOLDER1234567 を指定した場合は 取得対象のフォルダが存在しない場合に該当するとして例外が発生します。
folderName
- 取得したいフォルダのフォルダ名を指定します。
NullPointerException
-
IllegalArgumentException
-
IllegalStateException
-
FolderException
- FolderException
- public InternalStorageFile getFile(String fileName) throws java.io.IOException
ファイル名を指定してファイルインスタンスを取得します。
引数に指定可能なファイル名は、フォルダインスタンスが表すフォルダの直下に存在するファイルの名前です。
小文字を指定した場合は、大文字として扱われます。
引数で指定したファイル名に対して超過分の切り捨てを行うことはありません。 つまり、ファイルを新規作成する際に FILE12345.JPEG というファイル名を指定して作成した場合 FILE1234.JPE というファイル名で作成されますが、このメソッドの引数に FILE12345.JPEG を指定した場合は 取得対象のファイルが存在しない場合に該当するとして例外が発生します。
fileName
- 取得したいファイルのファイル名を指定します。
NullPointerException
-
IllegalArgumentException
-
IllegalStateException
-
FileNotAccessibleException
-