Class HashMap

任意の値やオブジェクトをキーに指定することが出来る Map です. 格納のアルゴリズムは java.util.HashMap を参考にしています. キーに使用するオブジェクトは, 出来る限り不変 (イミュータブル) なものを使用してください. キーに設定したオブジェクトに対して外部から変更が加わった場合, このオブジェクトの動作は保障されません.

Peach\Util\HashMap implements Peach\Util\Map

Namespace: Peach\Util
Located at Peach/Util/HashMap.php

Methods summary
`public`	# `__construct( Peach\Util\Map\|array $map = null, Peach\Util\Equator $e = null, integer $capacity = 16 )` 新しい HashMap を構築します. 引数で設定された容量は, オブジェクト構築後に変更することは出来ません. 新しい HashMap を構築します. 引数で設定された容量は, オブジェクト構築後に変更することは出来ません. Parameters `$map` デフォルトのマッピング (オプション) `$e` オブジェクトの等価性を判断するための Equator (NULL の場合は `Peach\Util\DefaultEquator` が適用されます) `$capacity` 容量 (デフォルトは 16, 最小で 2)
`public`	# `put( mixed $key, mixed $value )` 指定されたキーと値をこの Map に関連づけます. 指定されたキーと値をこの Map に関連づけます. Parameters `$key` キー `$value` 値 Implementation of `Peach\Util\Map::put()`
`public`	# `putAll( Peach\Util\Map $map )` 指定された Map の中身をすべて追加します。もしも引数の Map とこの Map に同じキーが存在していた場合, 引数のマッピングで上書きされます. 指定された Map の中身をすべて追加します。もしも引数の Map とこの Map に同じキーが存在していた場合, 引数のマッピングで上書きされます. Parameters `$map` 格納される Map See `Peach\Util\Map::putAll()` Implementation of `Peach\Util\Map::putAll()`
`public mixed`	# `get( mixed $key, mixed $defaultValue = null )` 指定されたキーにマッピングされている値を返します. マッピングが存在しない場合は代替値 (デフォルトは NULL) を返します. このメソッドの返り値が NULL (または指定した代替値) の場合, 必ずしもマッピングが存在しないとは限りません. マッピングの存在を確認する場合は HashMap::containsKey を使用してください. 指定されたキーにマッピングされている値を返します. マッピングが存在しない場合は代替値 (デフォルトは NULL) を返します. このメソッドの返り値が NULL (または指定した代替値) の場合, 必ずしもマッピングが存在しないとは限りません. マッピングの存在を確認する場合は HashMap::containsKey を使用してください. Parameters `$key` マッピングのキー `$defaultValue` マッピングが存在しない場合に返される代替値 Returns mixed Implementation of `Peach\Util\Map::get()`
`public`	# `clear( )` マッピングを空にします. マッピングを空にします. Implementation of `Peach\Util\Map::clear()`
`public integer`	# `size( )` この Map が持つマッピングの個数を返します. この Map が持つマッピングの個数を返します. Returns integer See `Peach\Util\Map::size()` Implementation of `Peach\Util\Map::size()`
`public array`	# `keys( )` この HashMap に含まれるキーの一覧を返します. この HashMap に含まれるキーの一覧を返します. Returns array この HashMap に含まれるキーの配列 Implementation of `Peach\Util\Map::keys()`
`public boolean`	# `containsKey( mixed $key )` 指定されたキーによるマッピングが存在するかどうかを調べます. マッピングが存在する場合に TRUE を返します. 指定されたキーによるマッピングが存在するかどうかを調べます. マッピングが存在する場合に TRUE を返します. Parameters `$key` キー Returns boolean マッピングが存在する場合に TRUE Implementation of `Peach\Util\Map::containsKey()`
`public`	# `remove( mixed $key )` 指定されたキーのマッピングを削除します. 指定されたキーのマッピングを削除します. Parameters `$key` キー Implementation of `Peach\Util\Map::remove()`
`public array`	# `values( )` このマップに登録されているすべての値を配列で返します. 返される配列に対する操作はこのマップには反映されません. このマップに登録されているすべての値を配列で返します. 返される配列に対する操作はこのマップには反映されません. Returns array Implementation of `Peach\Util\Map::values()`
`public array`	# `entryList( )` この HashMap に登録されているすべてのエントリーを返します. この HashMap に登録されているすべてのエントリーを返します. Returns array `Peach\Util\HashMapEntry` の配列 Implementation of `Peach\Util\Map::entryList()`
`protected Peach\Util\HashMapEntry`	# `createEntry( mixed $key, mixed $value )` 指定されたキーと値をマッピングする, 新しい `Peach\Util\HashMapEntry` を構築します. ユーザーは, 必要に応じてこのメソッドをオーバーライドし, 機能拡張した HashMapEntry を返すようにすることもできます. 指定されたキーと値をマッピングする, 新しい `Peach\Util\HashMapEntry` を構築します. ユーザーは, 必要に応じてこのメソッドをオーバーライドし, 機能拡張した HashMapEntry を返すようにすることもできます. Parameters `$key` マッピングのキー `$value` マッピングの値 Returns `Peach\Util\HashMapEntry` 引数の $key と $value をマッピングした HashMapEntry

Namespaces

Classes

Interfaces

Class HashMap

Parameters

Parameters

Implementation of

Parameters

See

Implementation of

Parameters

Returns

Implementation of

Implementation of

Returns

See

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns