1 dojo.provide("calitha.collections.IMap");
  2 dojo.require("calitha.exception.VirtualFunctionException");
  3 
  4 /**
  5  * @name calitha.collections.IMap
  6  * @class An object that maps keys to values.
  7  * <p>
  8  * It is based on the
  9  * <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html">Java Map interface</a>.
 10  */
 11 dojo.declare("calitha.collections.IMap", null,
 12 /** @lends calitha.collections.IMap# */
 13 {
 14     /**
 15      * @function
 16      * @description Removes all of the mappings from this map.
 17      */
 18     clear: function()
 19     {throw new calitha.exception.VirtualFunctionException(Error());}
 20     ,
 21     /**
 22      * @function
 23      * @param key key whose presence in this map is to be tested 
 24      * @returns {Boolean} true if this map contains a mapping for the specified key
 25      * @description Returns true if this map contains a mapping for the specified key.
 26      */
 27     containsKey: function(/**Object*/ key)
 28     {throw new calitha.exception.VirtualFunctionException(Error());}
 29     ,
 30     /**
 31      * @function
 32      * @param value whose presence in this map is to be tested 
 33      * @returns {Boolean} true if this map maps one or more keys to the specified value
 34      * @description Returns true if this map maps one or more keys to the specified value.
 35      */
 36     containsValue: function(/**Object*/ value)
 37     {throw new calitha.exception.VirtualFunctionException(Error());}
 38     ,
 39     /**
 40      * @function
 41      * @returns {calitha.collections.ICollection} <{@link calitha.collections.imap.IEntry}>
 42      * a set view of the mappings contained in this map
 43      * @description Returns a Set view of the mappings contained in this map.
 44      */
 45     entrySet: function()
 46     {throw new calitha.exception.VirtualFunctionException(Error());}
 47     ,
 48     /**
 49      * @function
 50      * @returns {Boolean} true if the specified object is equal to this map
 51      * @description Compares the specified object with this map for equality.
 52      */
 53     equals: function(/**Object*/ o)
 54     {throw new calitha.exception.VirtualFunctionException(Error());}
 55     ,
 56     /**
 57      * @function
 58      * @param key the key whose associated value is to be returned 
 59      * @returns {Object} the value to which the specified key is mapped, or null if this map contains no mapping for the key
 60      * @description Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
 61      */
 62     get: function(/**Object*/ key)
 63     {throw new calitha.exception.VirtualFunctionException(Error());}
 64     ,
 65     /**
 66      * @function
 67      * @returns {Number} the hash code value for this map
 68      * @description Returns the hash code value for this map.
 69      */
 70     hashCode: function()
 71     {throw new calitha.exception.VirtualFunctionException(Error());}
 72     ,
 73     /**
 74      * @function
 75      * @returns {Boolean} true if this map contains no key-value mappings
 76      * @description Returns true if this map contains no key-value mappings.
 77      */
 78     isEmpty: function()
 79     {throw new calitha.exception.VirtualFunctionException(Error());}
 80     ,
 81     /**
 82      * @function
 83      * @returns {calitha.collections.ICollection} <Object> a set view of the keys contained in this map
 84      * @description Returns a Set view of the keys contained in this map.
 85      */
 86     keySet: function()
 87     {throw new calitha.exception.VirtualFunctionException(Error());}
 88     ,
 89     /**
 90      * @function
 91      * @returns {Object} the previous value associated with key, or null if there was no mapping for key.
 92      * (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.) 
 93      * @param key key with which the specified value is to be associated
 94      * @param value value to be associated with the specified key
 95      * @description Associates the specified value with the specified key in this map.
 96      */
 97     put: function(/**Object*/ key, /**Object*/ value)
 98     {throw new calitha.exception.VirtualFunctionException(Error());}
 99     ,
100     /**
101      * @function
102      * @param m mappings to be stored in this map 
103      * @description Copies all of the mappings from the specified map to this map
104      */
105     putAll: function(/**calitha.collections.IMap*/ m)
106     {throw new calitha.exception.VirtualFunctionException(Error());}
107     ,
108     /**
109      * @function
110      * @param key key whose mapping is to be removed from the map 
111      * @returns {Object} the previous value associated with key, or null if there was no mapping for key.
112      * @description Removes the mapping for a key from this map if it is present.
113      */
114     remove: function(/**Object*/ key)
115     {throw new calitha.exception.VirtualFunctionException(Error());}
116     ,
117     /**
118      * @function
119      * @returns {Number} the number of key-value mappings in this map
120      * @description Returns the number of key-value mappings in this map.
121      */
122     size: function()
123     {throw new calitha.exception.VirtualFunctionException(Error());}
124     ,
125     /**
126      * @function
127      * @returns {calitha.collections.ICollection} <Object> a collection view of the values contained in this map
128      * @description Returns a Collection view of the values contained in this map.
129      */
130     values: function()
131     {throw new calitha.exception.VirtualFunctionException(Error());}
132 });
133