SFXProperty

文字列のキーと文字列の値からなるペア要素の集合を管理するクラスです。

#include <SFXProperty.h.hpp>

class SFXProperty;

SFMTYPEDEFCLASS(SFXProperty)

解説

SFXProperty クラスは SFXArray クラスや SFXHashmap クラスと似ていますが、　　　　要素を構成するキーとその値が共に文字列である点、および複数の要素が同一のキーを持てる点が異なります。

例 485. インスタンス変数の定義

SFXProperty property;

例 486. 要素の設定

property.Set("unix", "??");
property.Append("macos", "CR");
property.Insert(1, "windows", "CRLF");
property.Set("unix", "LF");
property.Append("macos", "LF");

例 487. 要素の取得

SFXAnsiString str1 = property.Get("unix");
SFXAnsiString str2 = property.GetKey(2);
SFXAnsiString str3 = property.GetValue(2);

例 488. 要素数の取得

SInt32 n = property.GetSize();

例 489. 要素の削除

property.Remove(2);
property.Clear("macos");
property.Clear();

参照

SFXArray | SFXHashmap

メンバ

コンストラクタ/デストラクタ
SFXProperty( `Void` ) SFXProperty クラスのコンストラクタです。
~SFXProperty( `Void` ) SFXProperty クラスのデストラクタです。

パブリック関数
`SFCError`	Append( `SFXAnsiStringConstRef` key , `SFXAnsiStringConstRef` value ) 文字列キーとその文字列値のペア要素を追加します。(キーの重複は可能です)
`Void`	Clear( `SFXAnsiStringConstRef` key , `Bool` sensitive = true ) Clear( `Void` ) 指定したキーを持つ要素、またはすべての要素を削除します。
`Bool`	Contains( `SFXAnsiStringConstRef` key , `Bool` sensitive = true ) 指定したキーが存在するか調べます。
static `SFXPropertyConstRef`	EmptyInstance( `Void` ) 空のプロパティを取得します。
`SInt32`	FirstIndexOf( `SFXAnsiStringConstRef` key , `SInt32` index = SINT32_MINIMUM , `Bool` sensitive = true ) 先頭から検索して、指定したキーと一致する最初の要素のインデックスを取得します。
`SFXAnsiStringConstRef`	Get( `SFXAnsiStringConstRef` key , `Bool` sensitive = true ) 指定したキーに関連付けられた値を取得します。
`SFXAnsiStringConstRef`	GetKey( `SInt32` index ) 指定した位置にあるキーを取得します。
`SInt32`	GetSize( `Void` ) キーと値のペアの数を取得します。
`SFXAnsiStringConstRef`	GetValue( `SInt32` index ) 指定した位置の値を取得します。
`SFCError`	Insert( `SInt32` index , `SFXAnsiStringConstRef` key , `SFXAnsiStringConstRef` value ) 指定した位置にキーに関連付けられた値を挿入します。
`Bool`	IsEmpty( `Void` ) プロパティが空であるか判定します。
`SInt32`	LastIndexOf( `SFXAnsiStringConstRef` key , `SInt32` index = SINT32_MAXIMUM , `Bool` sensitive = true ) 末尾から検索して、指定したキーと一致する最後の要素のインデックスを取得します。
`Void`	Remove( `SInt32` begin , `SInt32` end ) Remove( `SInt32` index ) 指定したキーを削除します。
`SFCError`	Set( `SFXAnsiStringConstRef` key , `SFXAnsiStringConstRef` value , `Bool` sensitive = true ) キーに関連付けられた値を設定します。
`SFCError`	SetKey( `SInt32` index , `SFXAnsiStringConstRef` key ) 指定した位置のキーを設定します。
`SFCError`	SetValue( `SInt32` index , `SFXAnsiStringConstRef` value ) 指定した位置の値を設定します。

SFXProperty::SFXProperty

SFXProperty クラスのコンストラクタです。

[ public, explicit ]
SFXProperty(Void);

SFXProperty::~SFXProperty

SFXProperty クラスのデストラクタです。

[ public ]
~SFXProperty(Void);

SFXProperty::Append

文字列キーとその文字列値のペア要素を追加します。(キーの重複は可能です)

[ public ]
SFCError Append(
    SFXAnsiStringConstRef key     // 文字列のキー
    SFXAnsiStringConstRef value   // 文字列の値
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMOERY
失敗したとき : SFERR_FAILED

参照

SFXProperty::Insert | SFXProperty::Set

SFXProperty::Clear

指定したキーを持つ要素、またはすべての要素を削除します。

[ public ]
Void Clear(
    SFXAnsiStringConstRef key   // 文字列のキー
    Bool sensitive = true       // キーの大小文字を区別するか
);

[ public ]
Void Clear(Void);

解説

引数にキーを指定した場合、そのキーに関連付けられる要素をすべて削除します。

引数が空の場合、すべての要素を削除します。

SFXProperty::Contains

指定したキーが存在するか調べます。

[ public, const ]
Bool Contains(
    SFXAnsiStringConstRef key   // 文字列のキー
    Bool sensitive = true       // キーの大小文字を区別するか
);

戻り値

存在するとき : true
存在しないとき : false

SFXProperty::EmptyInstance

空のプロパティを取得します。

[ public, static ]
SFXPropertyConstRef EmptyInstance(Void);

解説

空のプロパティを表すインスタンスを取得します。

SFXProperty::FirstIndexOf

先頭から検索して、指定したキーと一致する最初の要素のインデックスを取得します。

[ public, const ]
SInt32 FirstIndexOf(
    SFXAnsiStringConstRef key       // 文字列のキー
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
    Bool sensitive = true           // キーの大小文字を区別するか
);

戻り値

成功したとき : 見つかった位置の最初のインデックス
失敗したとき : -1

解説

要素を先頭から末尾に向かって検索し、最初に見つかった位置のインデックスを取得します。

検索開始位置を指定することで、先頭以外の位置から検索できます。

参照

SFXProperty::LastIndexOf

SFXProperty::Get

指定したキーに関連付けられた値を取得します。

[ public, const ]
SFXAnsiStringConstRef Get(
    SFXAnsiStringConstRef key   // 文字列のキー
    Bool sensitive = true       // キーの大小文字を区別するか
);

戻り値

指定したキーに関連付けられた値を返します。

指定したキーが存在しない場合は空文字列を返します。

参照

SFXProperty::Set

SFXProperty::GetKey

指定した位置にあるキーを取得します。

[ public, const ]
SFXAnsiStringConstRef GetKey(
    SInt32 index   // 位置
);

戻り値

指定した位置のキーを返します。

指定した位置にキーと値のペア要素が存在しない場合は空文字列を返します。

参照

SFXProperty::SetKey

SFXProperty::GetSize

キーと値のペアの数を取得します。

[ public, const ]
SInt32 GetSize(Void);

SFXProperty::GetValue

指定した位置の値を取得します。

[ public, const ]
SFXAnsiStringConstRef GetValue(
    SInt32 index   // 位置
);

戻り値

指定した位置の値を返します。

指定した位置にキーと値のペアが存在しない場合は空文字列を返します。

参照

SFXProperty::SetValue

SFXProperty::Insert

指定した位置にキーに関連付けられた値を挿入します。

[ public ]
SFCError Insert(
    SInt32 index                  // 挿入位置
    SFXAnsiStringConstRef key     // 文字列のキー
    SFXAnsiStringConstRef value   // 文字列の値
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMOERY
失敗したとき : SFERR_FAILED

参照

SFXProperty::Append | SFXProperty::Set

SFXProperty::IsEmpty

プロパティが空であるか判定します。

[ public, const ]
Bool IsEmpty(Void);

戻り値

空のとき : true
空でないとき : false

SFXProperty::LastIndexOf

末尾から検索して、指定したキーと一致する最後の要素のインデックスを取得します。

[ public, const ]
SInt32 LastIndexOf(
    SFXAnsiStringConstRef key       // 文字列のキー
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
    Bool sensitive = true           // キーの大小文字を区別するか
);

戻り値

成功したとき : 見つかった位置の最後のインデックス
失敗したとき : -1

解説

要素を末尾から先頭に向かって検索し、最初に見つかった位置のインデックスを取得します

検索開始位置を指定することで、末尾以外の位置から検索できます。

参照

SFXProperty::FirstIndexOf

SFXProperty::Remove

指定したキーを削除します。

[ public ]
Void Remove(
    SInt32 begin   // 削除開始位置
    SInt32 end     // 削除終了位置
);

[ public ]
Void Remove(
    SInt32 index   // 削除する文字列のキーの位置
);

SFXProperty::Set

キーに関連付けられた値を設定します。

[ public ]
SFCError Set(
    SFXAnsiStringConstRef key     // 文字列のキー
    SFXAnsiStringConstRef value   // 文字列の値
    Bool sensitive = true         // キーの大小文字を区別するか
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMOERY
失敗したとき : SFERR_FAILED

解説

指定したキーが既に存在する場合は値が上書きされます。また、同じキーに対する値が複数存在する場合はインデックスが最も小さな要素の値が上書きされます。

参照

SFXProperty::Append | SFXProperty::Insert

SFXProperty::SetKey

指定した位置のキーを設定します。

[ public ]
SFCError SetKey(
    SInt32 index                // 位置
    SFXAnsiStringConstRef key   // 文字列のキー
);

戻り値

成功したとき : SFERR_NO_ERROR
キーと値のペアが存在しないとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMOERY

参照

SFXProperty::GetKey

SFXProperty::SetValue

指定した位置の値を設定します。

[ public ]
SFCError SetValue(
    SInt32 index                  // 位置
    SFXAnsiStringConstRef value   // 文字列の値
);

戻り値

成功したとき : SFERR_NO_ERROR
キーと値のペアが存在しないとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMOERY

参照

SFXProperty::GetValue