summaryrefslogtreecommitdiff
path: root/gee/sortedmap.vala
diff options
context:
space:
mode:
Diffstat (limited to 'gee/sortedmap.vala')
-rw-r--r--gee/sortedmap.vala66
1 files changed, 66 insertions, 0 deletions
diff --git a/gee/sortedmap.vala b/gee/sortedmap.vala
new file mode 100644
index 0000000..ef5904e
--- /dev/null
+++ b/gee/sortedmap.vala
@@ -0,0 +1,66 @@
+/* sortedset.vala
+ *
+ * Copyright (C) 2009-2011 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>
+ */
+
+public interface Gee.SortedMap<K,V> : Gee.Map<K,V> {
+ /**
+ * Returns map containing pairs with key strictly lower the the argument.
+ */
+ public abstract SortedMap<K,V> head_map (K before);
+
+ /**
+ * Returns map containing pairs with key equal or larger then the argument.
+ */
+ public abstract SortedMap<K,V> tail_map (K after);
+
+ /**
+ * Returns right-open map (i.e. containing all pair which key is strictly
+ * lower then the second argument and equal or bigger then the first one).
+ *
+ * Null as one parameter means that it should include all from this side.
+ */
+ public abstract SortedMap<K,V> sub_map (K before, K after);
+
+ /**
+ * Returns the keys in ascending order.
+ */
+ public abstract SortedSet<K> ascending_keys { owned get; }
+
+ /**
+ * Returns the entries in ascending order.
+ */
+ public abstract SortedSet<Map.Entry<K,V>> ascending_entries { owned get; }
+
+ /**
+ * The read-only view this map.
+ */
+ public new abstract SortedMap<K,V> read_only_view { owned get; }
+
+ /**
+ * Returns an immutable empty map.
+ *
+ * @return an immutable empty map
+ */
+ public static Map<K,V> empty<K,V> () {
+ return new TreeMap<K,V> ().read_only_view;
+ }
+}
+