Util

クラス: Peach_Util_HashMap

定義: /Peach/Util/HashMap.php

任意の値やオブジェクトをキーに指定することが出来る Map です. 格納のアルゴリズムは java.util.HashMap を参考にしています.

キーに使用するオブジェクトは, 出来る限り不変 (イミュータブル) なものを使用してください. キーに設定したオブジェクトに対して外部から変更が加わった場合, このオブジェクトの動作は保障されません.

すべての実装されたインタフェース

メソッド

メソッド 詳細

constructor __construct

line 99

Peach_Util_HashMap __construct([Peach_Util_Map|array $map = null], [Peach_Util_Equator $e = null], [int $capacity = 16])

新しい HashMap を構築します.

引数で設定された容量は, オブジェクト構築後に変更することは出来ません.

Tags

  • access : public

引数

Peach_Util_Map|array   $map   デフォルトのマッピング (オプション)
Peach_Util_Equator   $e   オブジェクトの等価性を判断するための Equator (NULL の場合は Peach_Util_DefaultEquator が適用されます)
int   $capacity   容量 (デフォルトは 16, 最小で 2)

clear

line 219

void clear()

マッピングを空にします.

Tags

  • access : public

定義

Peach_Util_Map::clear()
このマップを空にします.

containsKey

line 261

bool containsKey(mixed $key)

指定されたキーによるマッピングが存在するかどうかを調べます.

マッピングが存在する場合に TRUE を返します.

Tags

  • return : マッピングが存在する場合に TRUE
  • access : public

引数

mixed   $key   キー

定義

Peach_Util_Map::containsKey()
指定されたキーによるマッピングが存在するかどうかを調べます.

createEntry

line 339

HashMapEntry createEntry(mixed $key, mixed $value)

指定されたキーと値をマッピングする, 新しいエントリーを構築します.

ユーザーは, 必要に応じてこのメソッドをオーバーライドし, 機能拡張した HashMapEntry を返すようにすることもできます.

Tags

  • return : 引数の $key と $value をマッピングした HashMapEntry
  • access : protected

引数

mixed   $key   マッピングのキー
mixed   $value   マッピングの値

entryList

line 316

array entryList()

この HashMap に登録されているすべてのエントリーを返します.

Tags

定義

Peach_Util_Map::entryList()
このマップのすべてのエントリーを Peach_Util_MapEntry オブジェクトの配列で返します.

get

line 202

mixed get(mixed $key, [mixed $defaultValue = null])

指定されたキーにマッピングされている値を返します.

マッピングが存在しない場合は代替値 (デフォルトは NULL) を返します. このメソッドの返り値が NULL (または指定した代替値) の場合, 必ずしもマッピングが存在しないとは限りません. マッピングの存在を確認する場合は Peach_Util_HashMap::conainsKey($key) を使用してください.

Tags

  • access : public

引数

mixed   $key   マッピングのキー
mixed   $defaultValue   マッピングが存在しない場合に返される代替値

定義

Peach_Util_Map::get()
指定されたキーにマッピングされている値を返します.

keys

line 243

array keys()

この HashMap に含まれるキーの一覧を返します.

Tags

  • return : この HashMap に含まれるキーの配列
  • access : public

定義

Peach_Util_Map::keys()
このマップに登録されているすべてのキーを配列で返します.

put

line 159

void put(mixed $key, mixed $value)

指定されたキーと値をこの Map に関連づけます.

Tags

  • access : public

引数

mixed   $key   キー
mixed   $value  

定義

Peach_Util_Map::put()
指定されたキーと値を関連づけます.

putAll

line 184

void putAll(Peach_Util_Map $map)

指定された Map の中身をすべて追加します。 もしも引数の Map とこの Map に同じキーが存在していた場合, 引数のマッピングで上書きされます.

Tags

  • see : Peach_Util_Map::putAll($map)
  • access : public

引数

Peach_Util_Map   $map   格納される Map

定義

Peach_Util_Map::putAll()
指定されたマップのマッピングすべてを登録します.

remove

line 279

void remove(mixed $key)

指定されたキーのマッピングを削除します.

Tags

  • access : public

引数

mixed   $key   キー

定義

Peach_Util_Map::remove()
指定されたキー名によるマッピングが存在する場合に, そのマッピングを削除します.

size

line 230

int size()

この Map が持つマッピングの個数を返します.

Tags

定義

Peach_Util_Map::size()
登録されているマッピングの個数を返します.

values

line 300

array values()

このマップに登録されているすべての値を配列で返します.

返される配列に対する操作はこのマップには反映されません.

Tags

  • access : public

定義

Peach_Util_Map::values()
このマップに登録されているすべての値を配列で返します.