1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/* multimap.vala
*
* Copyright (C) 2009 Ali Sabil
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Author:
* Ali Sabil <ali.sabil@gmail.com>
*/
/**
* A map with multiple values per key.
*/
[GenericAccessors]
public interface Gee.MultiMap<K,V> : Object {
/**
* The number of key/value pairs in this map.
*/
public abstract int size { get; }
/**
* Specifies whether this collection can change - i.e. wheather {@link set},
* {@link remove} etc. are legal operations.
*/
public abstract bool read_only { get; }
/**
* Returns the keys of this multimap as a read-only set.
*
* @return the keys of the map
*/
public abstract Set<K> get_keys ();
/**
* Returns the keys of this multimap as a read-only set.
*
* @return the keys of the map
*/
public abstract MultiSet<K> get_all_keys ();
/**
* Returns the values of this map as a read-only collection.
*
* @return the values of the map
*/
public abstract Collection<V> get_values ();
/**
* Determines whether this map contains the specified key.
*
* @param key the key to locate in the map
*
* @return ``true`` if key is found, ``false`` otherwise
*/
public abstract bool contains (K key);
/**
* Returns the values for the specified key in this map.
*
* @param key the key whose values are to be retrieved
*
* @return a Collection of values associated with the given key
*/
public abstract Collection<V> get (K key);
/**
* Inserts a key/value pair into this map.
*
* @param key the key to insert
* @param value the value to associate with the key
*/
public abstract void set (K key, V value);
/**
* Removes the specified key/value pair from this multimap.
*
* @param key the key to remove from the map
* @param value the value to remove from the map
*
* @return ``true`` if the map has been changed, ``false`` otherwise
*/
public abstract bool remove (K key, V value);
/**
* Removes the specified key and all the associated values from this
* multimap.
*
* @param key the key to remove from the map
*
* @return ``true`` if the map has been changed, ``false`` otherwise
*/
public abstract bool remove_all (K key);
/**
* Removes all items from this collection.
*/
public abstract void clear ();
/**
* Returns an iterator for this map.
*
* @return a map iterator
*/
public abstract MapIterator<K, V> map_iterator ();
/**
* The type of the keys in this multimap.
*/
public Type key_type { get { return typeof (K); } }
/**
* The type of the values in this multimap.
*/
public Type value_type { get { return typeof (V); } }
public virtual MultiMap<K, V> read_only_view {
owned get {
return new ReadOnlyMultiMap<K, V> (this);
}
}
}
|
