com.docomostar.fs
クラス InternalStorage

Object
  com.docomostar.fs.InternalStorage

public class InternalStorage
extends Object

内部ストレージを定義します。

内部ストレージ機能では Star アプリからマルチメディア系ファイル保存用メモリ領域にある内部ストレージに フォルダやファイルの作成などを行うことができますが、このクラスからはそれら各操作を行うことはできません。
各操作は、 InternalStorageFolder クラス、および InternalStorageFile クラスで行います。

内部ストレージ機能におけるフォルダやファイルは、最上層をルートフォルダとし、ルートフォルダの直下に Star アプリ固有フォルダ、 その配下に Star アプリが作成したフォルダまたはファイルという階層構造によって管理されます。

ルートフォルダ

最上層のフォルダです。最上層はルートフォルダのみが存在し、それ以外のフォルダおよびファイルは存在しません。 これより上位にはフォルダが存在しないため、上位のフォルダを取得しようとした場合は例外が発生します。

内部ストレージ機能の最上層は単一であるため、全ての Star アプリで共通です。
つまり、異なる Star アプリからルートフォルダにあたるインスタンスを取得した場合、得られたフォルダインスタンスは常に同じ場所を表します。
また、ルートフォルダを削除することはできません。削除しようとした場合は例外が発生します。

Star アプリ固有フォルダ

ルートフォルダ直下に存在するフォルダです。Star アプリと一対一に対応する Star アプリ固有フォルダのみ存在します。

ある Star アプリから見て対になるフォルダを、自 Star アプリ固有フォルダ、 対にならない別の Star アプリの固有フォルダを、他 Star アプリ固有フォルダとします。

初めて内部ストレージ機能を利用する際には、まだ自 Star アプリ固有フォルダは存在しません。

そのため、 getMyFolder() を呼び出して自 Star アプリ固有フォルダを作成する必要があります。

getFolder(String) 、 InternalStorageFolder.getAllFolders() を用いることで、他 Star アプリ固有フォルダのインスタンスを取得することはできますが、 得られたインスタンスを用いても他 Star アプリ固有フォルダおよびその配下に対して各操作を行うことはできません。 その場合は例外が発生します。

この階層には Star アプリ固有フォルダ以外のフォルダやファイルは作成できません。その場合は例外が発生します。

Star アプリ固有フォルダ配下のフォルダやファイル

自 Star アプリ固有フォルダ配下のフォルダやファイルに対してのみ各操作を行うことができます。

ただし、内部ストレージ機能において、フォルダを作成できる階層数には上限があります。 上限を超えてフォルダを作成しようとした場合は例外が発生します。

導入されたバージョン:

Star-2.0

メソッドの概要

static InternalStorageFile	getFile(String path) パス(パス区切り文字 "/" から始まる絶対パス)を指定してファイルを取得します。
static InternalStorageFolder	getFolder(String path) パス(パス区切り文字 "/" から始まる絶対パス)を指定してフォルダを取得します。
static long	getFreeSize() 内部ストレージで使用できる空き容量を取得します。
static InternalStorageFolder	getMyFolder() 自 Star アプリ固有フォルダを取得します。

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

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

メソッドの詳細

getMyFolder

public static InternalStorageFolder getMyFolder()
                                         throws java.io.IOException

自 Star アプリ固有フォルダを取得します。
自 Star アプリ固有フォルダが存在しない場合は、自動的に新規作成されます。

Star アプリ固有フォルダのフォルダ名は、新規作成時に自動的に付与されます。
他 Star アプリ固有フォルダが既に存在する場合は 重複しない別のフォルダ名が自動的に付与され、フォルダが新規作成されます。

戻り値:

自 Star アプリ固有フォルダを返します。

例外:

FileSystemFullException -
空き容量の範囲を超過して作成しようとした場合に発生します。

getFolder

public static InternalStorageFolder getFolder(String path)
                                       throws java.io.IOException

パス(パス区切り文字 "/" から始まる絶対パス)を指定してフォルダを取得します。
パス区切り文字("/")のみを指定した場合はルートフォルダを返します。

複数のパス区切り文字("/")を連続で指定した場合は、パス区切り文字("/")一つ分として扱います。
また、フォルダ名として小文字を指定した場合は大文字として扱われます。

引数に指定したパスの末尾がパス区切り文字("/")である場合は、 末尾のパス区切り文字("/")とその一つ前のパス区切り文字("/")の間のフォルダを取得します。

パラメータ:

path - 取得したいフォルダの絶対パスを指定します。

戻り値:

フォルダインスタンスを返します。

例外:

NullPointerException -
引数 path が null の場合に発生します。

IllegalArgumentException -
パス区切り文字("/")を除くフォルダ名として指定できない文字が含まれている場合に発生します。 パス区切り文字("/")から始まらない場合も含みます。

FolderException -
(NOT_FOUND)
取得対象のフォルダが存在しない場合に発生します。 他 Star アプリ固有フォルダ配下のフォルダへのパスが指定された場合にも、この例外が発生します。

getFile

public static InternalStorageFile getFile(String path)
                                   throws java.io.IOException

パス(パス区切り文字 "/" から始まる絶対パス)を指定してファイルを取得します。

複数のパス区切り文字("/")を連続で指定した場合は、パス区切り文字("/")一つ分として扱います。
また、フォルダ名およびファイル名として小文字を指定した場合は大文字として扱われます。

パラメータ:

path - 取得したいファイルの絶対パスを指定します。

戻り値:

ファイルインスタンスを返します。

例外:

NullPointerException -
引数 path が null の場合に発生します。

IllegalArgumentException -
パス区切り文字("/")を除くフォルダ名またはファイル名として指定できない文字が含まれている場合に発生します。 パス区切り文字("/")から始まらない場合も含みます。

FileNotAccessibleException -
(NOT_FOUND)
取得対象のファイルが存在しない場合に発生します。 他 Star アプリ固有フォルダ配下のファイルへのパスが指定された場合にも、この例外が発生します。

getFreeSize

public static long getFreeSize()

内部ストレージで使用できる空き容量を取得します。

戻り値:

空き容量 [bytes] を返します。