コンストラクタの概要

Permanent (String domain, String group)
コンストラクタ。

メソッドの概要

返却値の型 メソッド名
Object elements ()
カテゴリ内のすべての設定済みデータを取得します。
Array entries (String domain) static
カテゴリ・キーの一覧を取得します。
Object extinction ()
カテゴリ・データを削除します。
Object get (String key)
カテゴリ内の指定保存キーにマップされているデータを取得します。
Array keys ()
カテゴリ内の保存キーの一覧を取得します。
Object remove (String key)
カテゴリ内の指定保存キーとマップされているデータを削除します。
Object set (String key, Object value)
カテゴリ内の指定保存キーで指定データを保存します。

コンストラクタの詳細

Permanent (String domain, String group)
コンストラクタ。

domain および group で解決される一意のカテゴリに対するデータ操作オブジェクトを提供します。
引数 domain は、データファイルの保存先ディレクトリ名称として利用されるので、OS環境に依存したファイル命名規則に準じた文字列を指定する必要があります。
domain がファイル命名規則に違反した場合は、正しくデータを入出力できません。
このインスタンスで操作されるデータは、 システムストレージの treasure/box/articles/ 以下に保存されます。
パラメータ
domain : String
保存先ディレクトリ名
group : String
カテゴリ名称

メソッドの詳細

Object elements ()
カテゴリ内のすべての設定済みデータを取得します。

コンストラクタで指定されたカテゴリに対して設定済みのすべてのデータを返却します。
返却オブジェクトは、保存キーがプロパティ名称で保存キーにマップされているデータが該当するプロパティの値として保存されます。
返却値
Object
Object カテゴリ内の保存データ群
Array entries (String domain) static
カテゴリ・キーの一覧を取得します。

domain に含まれる設定済みのカテゴリ・キーの一覧を返却します。
カテゴリの設定順と配列内のキーの格納順は保証されません。
パラメータ
domain : String
保存先ディレクトリ名称
返却値
Array
Array カテゴリ・キーの一覧(Stringの配列)
Object extinction ()
カテゴリ・データを削除します。

コンストラクタで指定されたカテゴリに対して設定済みのすべてのデータを削除すると共にカテゴリ自身を削除します。
削除に成功した場合は、削除されたカテゴリ内データ群を返却します。
削除できなかった場合は、空のオブジェクトを返却します。
返却オブジェクトは、保存キーがプロパティ名称で保存キーにマップされているデータが該当するプロパティの値として保存されます。
返却値
Object
Object 削除したカテゴリ・データ群
Object get (String key)
カテゴリ内の指定保存キーにマップされているデータを取得します。

コンストラクタで指定されたカテゴリ内において指定保存キーにマップされているデータを取得します。
指定保存キーに対応するキーが存在しない場合 null を返却します。
パラメータ
key : String
値へのキーコード
返却値
Object
Object 保存キーにマップされているデータ
Array keys ()
カテゴリ内の保存キーの一覧を取得します。

コンストラクタで指定されたカテゴリに対してすべての設定済みの保存キーを返却します。
保存キーの設定順と配列内の保存キーの格納順は保証されません。
返却値
Array
Array カテゴリ内の保存キー一覧(Stringの配列)
Object remove (String key)
カテゴリ内の指定保存キーとマップされているデータを削除します。

コンストラクタで指定されたカテゴリ内において指定保存キーにマップされているデータと指定保存キーを削除します。
返却値は削除されたデータを返却します。
指定保存キーにマップされたデータが存在しない場合は null を返却します。
パラメータ
key : String
値へのキーコード
返却値
Object
Object 保存キーにマップされていた値
Object set (String key, Object value)
カテゴリ内の指定保存キーで指定データを保存します。

コンストラクタで指定されたカテゴリに対して指定保存キーを指定データにマップする形で保存します。
パラメータ
key : String
保存キー
value : Object
保存対象データ
返却値
Object
Object 指定されたキーに関連した以前の値。キーが新しいものの場合は null。