summaryrefslogtreecommitdiff
path: root/gee/readonlymultimap.vala
blob: 214f28ef50cd9076c53cbebe20f0aa981b79be43 (plain)
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
/* readonlymultimap.vala
 *
 * Copyright (C) 2013  Maciej Piechotka
 *
 * 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:
 * 	Maciej Piechotka <uzytkownik2@gmail.com>
 */

using GLib;

/**
 * Read-only view for {@link MultiMap} collections.
 *
 * This class decorates any class which implements the {@link MultiMap}
 * interface by making it read only. Any method which normally modify data will
 * throw an error.
 *
 * @see MultiMap
 */
internal class Gee.ReadOnlyMultiMap<K, V> : Object, MultiMap<K, V> {
	/**
	 * Constructs a read-only multi-set that mirrors the content of the specified
	 * list.
	 *
	 * @param multiset the multi-set to decorate.
	 */
	public ReadOnlyMultiMap (MultiMap<K, V> multimap) {
		this._multimap = multimap;
	}

	/**
	 * {@inheritDoc}
	 */
	public int size { get { return _multimap.size; } }

	/**
	 * {@inheritDoc}
	 */
	public bool read_only { get { return true; } }

	/**
	 * {@inheritDoc}
	 */
	public Set<K> get_keys () {
		return _multimap.get_keys ();
	}

	/**
	 * {@inheritDoc}
	 */
	public MultiSet<K> get_all_keys () {
		return _multimap.get_all_keys ();
	}

	/**
	 * {@inheritDoc}
	 */
	public Collection<V> get_values () {
		return _multimap.get_values ();
	}

	/**
	 * {@inheritDoc}
	 */
	public bool contains (K key) {
		return _multimap.contains (key);
	}

	/**
	 * {@inheritDoc}
	 */
	public new Collection<V> get (K key) {
		return _multimap.get (key);
	}

	/**
	 * {@inheritDoc}
	 */
	public new void set (K key, V value) {
		assert_not_reached ();
	}

	/**
	 * {@inheritDoc}
	 */
	public bool remove (K key, V value) {
		assert_not_reached ();
	}

	/**
	 * {@inheritDoc}
	 */
	public bool remove_all (K key) {
		assert_not_reached ();
	}

	/**
	 * {@inheritDoc}
	 */
	public void clear () {
		assert_not_reached ();
	}

	/**
	 * {@inheritDoc}
	 */
	public MapIterator<K, V> map_iterator () {
		return new ReadOnlyMap.MapIterator<K, V> (_multimap.map_iterator ());
	}

	/**
	 * {@inheritDoc}
	 */
	public virtual new MultiMap<K, V> read_only_view { owned get { return this; } }

	private MultiMap<K, V> _multimap;
}