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
|
/* map.vala
*
* Copyright (C) 2007 Jürg Billeter
*
* 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>
*/
/**
* A map is a generic collection of key/value pairs.
*/
public interface Gee.Map<K,V> : GLib.Object {
/**
* The number of items in this map.
*/
public abstract int size { get; }
/**
* Returns the keys of this map as a read-only set.
*
* @return the keys of the map
*/
public abstract Set<K> get_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 value of the specified key in this map.
*
* @param key the key whose value is to be retrieved
*
* @return the value associated with the key, or null if the key
* couldn't be found
*/
public abstract V? get (K key);
/**
* Inserts a new key and value 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 from this map.
*
* @param key the key to remove from the map
*
* @return true if the map has been changed, false otherwise
*/
public abstract bool remove (K key);
/**
* Removes all items from this collection. Must not be called on
* read-only collections.
*/
public abstract void clear ();
}
|