基本信息
將鍵映射到值的對象。一個映射不能包含重複的鍵;每個鍵最多只能映射到一個值。此接口取代 Dictionary類,後者完全是一個抽象類,而不是一個接口。
Map 接口提供三種collection 視圖,允許以鍵集、值集或鍵-值映射關係集的形式查看某個映射的內容。映射順序 定義為疊代器在映射的 collection視圖上返回其元素的順序。某些映射實現可明確保證其順序,如 TreeMap類;另一些映射實現則不保證順序,如 HashMap類。
註:將可變對象用作映射鍵時必須格外小心。當對象是映射中某個鍵時,如果以影響 equals比較的方式更改了對象的值,則映射的行為將是不確定的。此項禁止的一種特殊情況是不允許某個映射將自身作為一個鍵包含。雖然允許某個映射將自身作為值包含,但請格外小心:在這樣的映射上 equals 和 hashCode方法的定義將不再是明確的。
所有通用的映射實現類應該提供兩個“標準的”構造方法:一個 void(無參數)構造方法,用於創建空映射;一個是帶有單個 Map 類型參數的構造方法,用於創建一個與其參數具有相同鍵-值映射關係的新映射。實際上,後一個構造方法允許用戶複製任意映射,生成所需類的一個等價映射。儘管無法強制執行此建議(因為接口不能包含構造方法),但是 JDK中所有通用的映射實現都遵從它。
此接口中包含的“破壞”方法可修改其操作的映射,如果此映射不支持該操作,這些方法將拋出 UnsupportedOperationException。如果是這樣,那么在調用對映射無效時,這些方法可以(但不要求)拋出 UnsupportedOperationException。例如,如果某個不可修改的映射(其映射關係是“重疊”的)為空,則對該映射調用 putAll(Map) 方法時,可以(但不要求)拋出異常。
某些映射實現對可能包含的鍵和值有所限制。例如,某些實現禁止 null 鍵和值,另一些則對其鍵的類型有限制。嘗試插入不合格的鍵或值將拋出一個未經檢查的異常,通常是 NullPointerException 或 ClassCastException。試圖查詢是否存在不合格的鍵或值可能拋出異常,或者返回 false;某些實現將表現出前一種行為,而另一些則表現後一種。一般來說,試圖對不合格的鍵或值執行操作且該操作的完成不會導致不合格的元素被插入映射中時,將可能拋出一個異常,也可能操作成功,這取決於實現本身。這樣的異常在此接口的規範中標記為“可選”。
此接口是 Java Collections Framework 的成員。
Collections Framework 接口中的很多方法是根據 equals 方法定義的。例如,containsKey(Object key) 方法的規範中寫道:“若且唯若此映射包含針對滿足 (key==null k==null : key.equals(k)) 的鍵 k 的映射關係時,返回 true”。不 應將此規範解釋為:調用具有非空參數 key 的 Map.containsKey 將導致對任意的鍵 k 調用 key.equals(k)。實現可隨意進行最佳化,以避免調用 equals,例如,可首先比較兩個鍵的哈希碼(Object.hashCode() 規範保證哈希碼不相等的兩個對象不會相等)。一般來說,只要實現者認為合適,各種 Collections Framework 接口的實現可隨意利用底層 Object 方法的指定行為。
常用操作說明
void clear()
從此映射中移除所有映射關係(可選操作)。
boolean containsKey(Object key)
如果此映射包含指定鍵的映射關係,則返回 true。
boolean containsValue(Object value)
如果此映射將一個或多個鍵映射到指定值,則返回 true。
Set<Map.Entry<K,V>> entrySet()
返回此映射中包含的映射關係的 Set 視圖。
boolean equals(Object o)
比較指定的對象與此映射是否相等。
V get(Object key)
返回指定鍵所映射的值;如果此映射不包含該鍵的映射關係,則返回 null。
int hashCode()
返回此映射的哈希碼值。
boolean isEmpty()
如果此映射未包含鍵-值映射關係,則返回 true。
Set<K> keySet()
返回此映射中包含的鍵的 Set 視圖。
V put(K key,V value)
將指定的值與此映射中的指定鍵關聯(可選操作)。
void putAll(Map<? extends K,? extends V> m)
從指定映射中將所有映射關係複製到此映射中(可選操作)。
V remove(Object key)
如果存在一個鍵的映射關係,則將其從此映射中移除(可選操作)。
int size()
返回此映射中的鍵-值映射關係數。
Collection<V> values()
返回此映射中包含的值的 Collection 視圖。