1: <?php
 2: /*
 3:  * Copyright (c) 2014 @trashtoy
 4:  * https://github.com/trashtoy/
 5:  * 
 6:  * Permission is hereby granted, free of charge, to any person obtaining a copy of
 7:  * this software and associated documentation files (the "Software"), to deal in
 8:  * the Software without restriction, including without limitation the rights to use,
 9:  * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
10:  * Software, and to permit persons to whom the Software is furnished to do so,
11:  * subject to the following conditions:
12:  * 
13:  * The above copyright notice and this permission notice shall be included in all
14:  * copies or substantial portions of the Software.
15:  * 
16:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18:  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19:  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20:  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21:  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22:  */
23: /**
24:  * PHP class file.
25:  * @auhtor trashtoy
26:  * @since  2.0.0
27:  */
28: namespace Peach\Util;
29: 
30: /**
31:  * マップに含まれるキーと値のペアをあらわすインタフェースです.
32:  * {@link Map::entryList} の返り値として使用されます.
33:  */
34: interface MapEntry
35: {
36: 
37:     /**
38:      * このエントリーのキーです.
39:      * 
40:      * @return mixed このエントリーのキー
41:      */
42:     public function getKey();
43:     
44:     /**
45:      * このエントリーの値です.
46:      * 
47:      * @return mixed このエントリーの値.
48:      */
49:     public function getValue();
50:     
51:     /**
52:      * このエントリーの値を新しい値に更新します. 更新はもとの Map に反映されます.
53:      * ただし, このエントリーがもとのマップから削除されている場合は
54:      * このメソッドの動作は定義されません.
55:      * 
56:      * @param mixed $value 新しい値
57:      */
58:     public function setValue($value);
59: }
60: