/* readonlycollection.vala
*
* Copyright (C) 2007-2008 Jürg Billeter
* Copyright (C) 2010-2014 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:
* Jürg Billeter <j@bitron.ch>
*/
using GLib;
/**
* Read-only view for {@link Collection} collections.
*
* This class decorates any class which implements the {@link Collection}
* interface by making it read only. Any method which normally modify data will
* throw an error.
*
* @see Collection
*/
internal class Gee.ReadOnlyCollection<G> : Object, Traversable<G>, Iterable<G>, Collection<G> {
/**
* {@inheritDoc}
*/
public int size {
get { return _collection.size; }
}
/**
* {@inheritDoc}
*/
public bool is_empty {
get { return _collection.is_empty; }
}
/**
* {@inheritDoc}
*/
public bool read_only {
get { return true; }
}
protected Collection<G> _collection;
/**
* Constructs a read-only collection that mirrors the content of the
* specified collection.
*
* @param collection the collection to decorate.
*/
public ReadOnlyCollection (Collection<G> collection) {
this._collection = collection;
}
/**
* {@inheritDoc}
*/
public bool foreach (ForallFunc<G> f) {
return _collection.foreach (f);
}
/**
* {@inheritDoc}
*/
public Gee.Iterator<A> stream<A> (owned StreamFunc<G, A> f) {
return _collection.stream<A> ((owned)f);
}
/**
* {@inheritDoc}
*/
public Gee.Iterator<G> filter (owned Predicate<G> f) {
return _collection.filter ((owned)f);
}
/**
* {@inheritDoc}
*/
public Gee.Iterator<G> chop (int offset, int length = -1) {
return _collection.chop (offset, length);
}
/**
* {@inheritDoc}
*/
public Type element_type {
get { return typeof (G); }
}
/**
* {@inheritDoc}
*/
public Gee.Iterator<G> iterator () {
return new Iterator<G> (_collection.iterator ());
}
/**
* {@inheritDoc}
*/
public bool contains (G item) {
return _collection.contains (item);
}
/**
* Unimplemented method (read only collection).
*/
public bool add (G item) {
assert_not_reached ();
}
/**
* Unimplemented method (read only collection).
*/
public bool remove (G item) {
assert_not_reached ();
}
/**
* Unimplemented method (read only collection).
*/
public void clear () {
assert_not_reached ();
}
/**
* Unimplemented method (read only collection).
*/
public bool add_all (Collection<G> collection) {
assert_not_reached ();
}
/**
* {@inheritDoc}
*/
public bool contains_all (Collection<G> collection) {
return _collection.contains_all (collection);
}
/**
* Unimplemented method (read only collection).
*/
public bool remove_all (Collection<G> collection) {
assert_not_reached ();
}
/**
* Unimplemented method (read only collection).
*/
public bool retain_all (Collection<G> collection) {
assert_not_reached ();
}
/**
* {@inheritDoc}
*/
public G[] to_array () {
return _collection.to_array ();
}
protected class Iterator<G> : Object, Traversable<G>, Gee.Iterator<G> {
protected Gee.Iterator<G> _iter;
public Iterator (Gee.Iterator<G> iterator) {
_iter = iterator;
}
public bool next () {
return _iter.next ();
}
public bool has_next () {
return _iter.has_next ();
}
public new G get () {
return _iter.get ();
}
public void remove () {
assert_not_reached ();
}
public bool valid {
get {
return _iter.valid;
}
}
public bool read_only {
get {
return true;
}
}
public Type element_type {
get { return typeof (G); }
}
public bool foreach (ForallFunc<G> f) {
return _iter.foreach (f);
}
public Gee.Iterator<A> stream<A> (owned StreamFunc<G, A> f) {
return _iter.stream<A> ((owned)f);
}
public Gee.Iterator<G> filter (owned Predicate<G> f) {
return _iter.filter ((owned)f);
}
public Gee.Iterator<G> chop (int offset, int length = -1) {
return _iter.chop ( offset, length);
}
public Gee.Iterator<G>[] tee (uint forks) {
if (forks == 0) {
return new Gee.Iterator<G>[0];
} else {
Gee.Iterator<G>[] iters = _iter.tee (forks);
Gee.Iterator<G>[] result = new Gee.Iterator<G>[forks];
if (iters[0] == _iter) {
result[0] = this;
} else {
result[0] = new Iterator<G> (iters[0]);
}
for (uint i = 1; i < forks; i++) {
result[i] = new Iterator<G> (iters[i]);
}
return result;
}
}
}
public virtual Collection<G> read_only_view {
owned get { return this; }
}
}