第1部分 TreeMap介紹
TreeMap 簡介
TreeMap 是一個有序的key-value集合，它是通過紅黑樹實(shí)現(xiàn)的。
TreeMap 繼承于AbstractMap，所以它是一個Map了嚎，即一個key-value集合。
TreeMap 實(shí)現(xiàn)了NavigableMap接口廊营，意味著它支持一系列的導(dǎo)航方法歪泳。比如返回有序的key集合。
TreeMap 實(shí)現(xiàn)了Cloneable接口赘风，意味著它能被克隆夹囚。
TreeMap 實(shí)現(xiàn)了java.io.Serializable接口，意味著它支持序列化邀窃。
TreeMap基于紅黑樹（Red-Black tree）實(shí)現(xiàn)荸哟。該映射根據(jù)其鍵的自然順序進(jìn)行排序，或者根據(jù)創(chuàng)建映射時提供的 Comparator 進(jìn)行排序瞬捕，具體取決于使用的構(gòu)造方法鞍历。
TreeMap的基本操作 containsKey、get肪虎、put 和 remove 的時間復(fù)雜度是 log(n) 劣砍。
另外，TreeMap是非同步的扇救。 它的iterator 方法返回的迭代器是fail-fastl的刑枝。
TreeMap的構(gòu)造函數(shù)
// 默認(rèn)構(gòu)造函數(shù)香嗓。使用該構(gòu)造函數(shù)，TreeMap中的元素按照自然排序進(jìn)行排列装畅。
TreeMap()
// 創(chuàng)建的TreeMap包含Map
TreeMap(Map<? extends K, ? extends V> copyFrom)
// 指定Tree的比較器
TreeMap(Comparator<? super K> comparator)
// 創(chuàng)建的TreeSet包含copyFrom
TreeMap(SortedMap<K, ? extends V> copyFrom)
TreeMap的API
Entry<K, V> ceilingEntry(K key)
K ceilingKey(K key)
void clear()
Object clone()
Comparator<? super K> comparator()
boolean containsKey(Object key)
NavigableSet<K> descendingKeySet()
NavigableMap<K, V> descendingMap()
Set<Entry<K, V>> entrySet()
Entry<K, V> firstEntry()
K firstKey()
Entry<K, V> floorEntry(K key)
K floorKey(K key)
V get(Object key)
NavigableMap<K, V> headMap(K to, boolean inclusive)
SortedMap<K, V> headMap(K toExclusive)
Entry<K, V> higherEntry(K key)
K higherKey(K key)
boolean isEmpty()
Set<K> keySet()
Entry<K, V> lastEntry()
K lastKey()
Entry<K, V> lowerEntry(K key)
K lowerKey(K key)
NavigableSet<K> navigableKeySet()
Entry<K, V> pollFirstEntry()
Entry<K, V> pollLastEntry()
V put(K key, V value)
V remove(Object key)
int size()
SortedMap<K, V> subMap(K fromInclusive, K toExclusive)
NavigableMap<K, V> subMap(K from, boolean fromInclusive, K to, boolean toInclusive)
NavigableMap<K, V> tailMap(K from, boolean inclusive)
SortedMap<K, V> tailMap(K fromInclusive)
第2部分 TreeMap數(shù)據(jù)結(jié)構(gòu)
TreeMap的繼承關(guān)系
java.lang.Object
? java.util.AbstractMap<K, V>
? java.util.TreeMap<K, V>
public class TreeMap<K,V>
extends AbstractMap<K,V>
implements NavigableMap<K,V>, Cloneable, java.io.Serializable {}
TreeMap與Map關(guān)系如下圖：
從圖中可以看出：
(01) TreeMap實(shí)現(xiàn)繼承于AbstractMap靠娱，并且實(shí)現(xiàn)了NavigableMap接口。
(02) TreeMap的本質(zhì)是R-B Tree(紅黑樹)掠兄，它包含幾個重要的成員變量： root, size, comparator像云。
root 是紅黑數(shù)的根節(jié)點(diǎn)。它是Entry類型蚂夕，Entry是紅黑數(shù)的節(jié)點(diǎn)迅诬，它包含了紅黑數(shù)的6個基本組成成分：key(鍵)、value(值)婿牍、left(左孩子)侈贷、right(右孩子)、parent(父節(jié)點(diǎn))牍汹、color(顏色)铐维。Entry節(jié)點(diǎn)根據(jù)key進(jìn)行排序，Entry節(jié)點(diǎn)包含的內(nèi)容為value慎菲。
紅黑數(shù)排序時嫁蛇，根據(jù)Entry中的key進(jìn)行排序；Entry中的key比較大小是根據(jù)比較器comparator來進(jìn)行判斷的露该。
size是紅黑數(shù)中節(jié)點(diǎn)的個數(shù)睬棚。
關(guān)于紅黑數(shù)的具體算法，請參考"紅黑樹(一) 原理和算法詳細(xì)介紹"解幼。
第3部分 TreeMap源碼解析(基于JDK1.6.0_45)
為了更了解TreeMap的原理抑党，下面對TreeMap源碼代碼作出分析。我們先給出源碼內(nèi)容撵摆，后面再對源碼進(jìn)行詳細(xì)說明底靠，當(dāng)然，源碼內(nèi)容中也包含了詳細(xì)的代碼注釋特铝。讀者閱讀的時候暑中，建議先看后面的說明，先建立一個整體印象鲫剿；之后再閱讀源碼鳄逾。
package java.util;
public class TreeMap<K,V>
extends AbstractMap<K,V>
implements NavigableMap<K,V>, Cloneable, java.io.Serializable
{
// 比較器。用來給TreeMap排序
private final Comparator<? super K> comparator;
// TreeMap是紅黑樹實(shí)現(xiàn)的灵莲，root是紅黑書的根節(jié)點(diǎn)
private transient Entry<K,V> root = null;
// 紅黑樹的節(jié)點(diǎn)總數(shù)
private transient int size = 0;
// 記錄紅黑樹的修改次數(shù)
private transient int modCount = 0;
// 默認(rèn)構(gòu)造函數(shù)
public TreeMap() {
comparator = null;
}
// 帶比較器的構(gòu)造函數(shù)
public TreeMap(Comparator<? super K> comparator) {
this.comparator = comparator;
}
// 帶Map的構(gòu)造函數(shù)雕凹，Map會成為TreeMap的子集
public TreeMap(Map<? extends K, ? extends V> m) {
comparator = null;
putAll(m);
}
// 帶SortedMap的構(gòu)造函數(shù)，SortedMap會成為TreeMap的子集
public TreeMap(SortedMap<K, ? extends V> m) {
comparator = m.comparator();
try {
buildFromSorted(m.size(), m.entrySet().iterator(), null, null);
} catch (java.io.IOException cannotHappen) {
} catch (ClassNotFoundException cannotHappen) {
}
}
public int size() {
return size;
}
// 返回TreeMap中是否保護(hù)“鍵(key)”
public boolean containsKey(Object key) {
return getEntry(key) != null;
}
// 返回TreeMap中是否保護(hù)"值(value)"
public boolean containsValue(Object value) {
// getFirstEntry() 是返回紅黑樹的第一個節(jié)點(diǎn)
// successor(e) 是獲取節(jié)點(diǎn)e的后繼節(jié)點(diǎn)
for (Entry<K,V> e = getFirstEntry(); e != null; e = successor(e))
if (valEquals(value, e.value))
return true;
return false;
}
// 獲取“鍵(key)”對應(yīng)的“值(value)”
public V get(Object key) {
// 獲取“鍵”為key的節(jié)點(diǎn)(p)
Entry<K,V> p = getEntry(key);
// 若節(jié)點(diǎn)(p)為null，返回null枚抵；否則线欲，返回節(jié)點(diǎn)對應(yīng)的值
return (p==null ? null : p.value);
}
public Comparator<? super K> comparator() {
return comparator;
}
// 獲取第一個節(jié)點(diǎn)對應(yīng)的key
public K firstKey() {
return key(getFirstEntry());
}
// 獲取最后一個節(jié)點(diǎn)對應(yīng)的key
public K lastKey() {
return key(getLastEntry());
}
// 將map中的全部節(jié)點(diǎn)添加到TreeMap中
public void putAll(Map<? extends K, ? extends V> map) {
// 獲取map的大小
int mapSize = map.size();
// 如果TreeMap的大小是0,且map的大小不是0,且map是已排序的“key-value對”
if (size==0 && mapSize!=0 && map instanceof SortedMap) {
Comparator c = ((SortedMap)map).comparator();
// 如果TreeMap和map的比較器相等；
// 則將map的元素全部拷貝到TreeMap中汽摹，然后返回询筏！
if (c == comparator || (c != null && c.equals(comparator))) {
++modCount;
try {
buildFromSorted(mapSize, map.entrySet().iterator(),
null, null);
} catch (java.io.IOException cannotHappen) {
} catch (ClassNotFoundException cannotHappen) {
}
return;
}
}
// 調(diào)用AbstractMap中的putAll();
// AbstractMap中的putAll()又會調(diào)用到TreeMap的put()
super.putAll(map);
}
// 獲取TreeMap中“鍵”為key的節(jié)點(diǎn)
final Entry<K,V> getEntry(Object key) {
// 若“比較器”為null，則通過getEntryUsingComparator()獲取“鍵”為key的節(jié)點(diǎn)
if (comparator != null)
return getEntryUsingComparator(key);
if (key == null)
throw new NullPointerException();
Comparable<? super K> k = (Comparable<? super K>) key;
// 將p設(shè)為根節(jié)點(diǎn)
Entry<K,V> p = root;
while (p != null) {
int cmp = k.compareTo(p.key);
// 若“p的key” < key竖慧，則p=“p的左孩子”
if (cmp < 0)
p = p.left;
// 若“p的key” > key，則p=“p的左孩子”
else if (cmp > 0)
p = p.right;
// 若“p的key” = key逆屡，則返回節(jié)點(diǎn)p
else
return p;
}
return null;
}
// 獲取TreeMap中“鍵”為key的節(jié)點(diǎn)(對應(yīng)TreeMap的比較器不是null的情況)
final Entry<K,V> getEntryUsingComparator(Object key) {
K k = (K) key;
Comparator<? super K> cpr = comparator;
if (cpr != null) {
// 將p設(shè)為根節(jié)點(diǎn)
Entry<K,V> p = root;
while (p != null) {
int cmp = cpr.compare(k, p.key);
// 若“p的key” < key圾旨，則p=“p的左孩子”
if (cmp < 0)
p = p.left;
// 若“p的key” > key，則p=“p的左孩子”
else if (cmp > 0)
p = p.right;
// 若“p的key” = key魏蔗，則返回節(jié)點(diǎn)p
else
return p;
}
}
return null;
}
// 獲取TreeMap中不小于key的最小的節(jié)點(diǎn)砍的；
// 若不存在(即TreeMap中所有節(jié)點(diǎn)的鍵都比key大)，就返回null
final Entry<K,V> getCeilingEntry(K key) {
Entry<K,V> p = root;
while (p != null) {
int cmp = compare(key, p.key);
// 情況一：若“p的key” > key莺治。
// 若 p 存在左孩子廓鞠，則設(shè) p=“p的左孩子”；
// 否則谣旁，返回p
if (cmp < 0) {
if (p.left != null)
p = p.left;
else
return p;
// 情況二：若“p的key” < key床佳。
} else if (cmp > 0) {
// 若 p 存在右孩子，則設(shè) p=“p的右孩子”
if (p.right != null) {
p = p.right;
} else {
// 若 p 不存在右孩子榄审，則找出 p 的后繼節(jié)點(diǎn)砌们，并返回
// 注意：這里返回的 “p的后繼節(jié)點(diǎn)”有2種可能性：第一，null搁进；第二浪感，TreeMap中大于key的最小的節(jié)點(diǎn)。
// 理解這一點(diǎn)的核心是饼问，getCeilingEntry是從root開始遍歷的影兽。
// 若getCeilingEntry能走到這一步，那么莱革，它之前“已經(jīng)遍歷過的節(jié)點(diǎn)的key”都 > key峻堰。
// 能理解上面所說的，那么就很容易明白驮吱，為什么“p的后繼節(jié)點(diǎn)”又2種可能性了茧妒。
Entry<K,V> parent = p.parent;
Entry<K,V> ch = p;
while (parent != null && ch == parent.right) {
ch = parent;
parent = parent.parent;
}
return parent;
}
// 情況三：若“p的key” = key。
} else
return p;
}
return null;
}
// 獲取TreeMap中不大于key的最大的節(jié)點(diǎn)左冬；
// 若不存在(即TreeMap中所有節(jié)點(diǎn)的鍵都比key小)桐筏，就返回null
// getFloorEntry的原理和getCeilingEntry類似，這里不再多說拇砰。
final Entry<K,V> getFloorEntry(K key) {
Entry<K,V> p = root;
while (p != null) {
int cmp = compare(key, p.key);
if (cmp > 0) {
if (p.right != null)
p = p.right;
else
return p;
} else if (cmp < 0) {
if (p.left != null) {
p = p.left;
} else {
Entry<K,V> parent = p.parent;
Entry<K,V> ch = p;
while (parent != null && ch == parent.left) {
ch = parent;
parent = parent.parent;
}
return parent;
}
} else
return p;
}
return null;
}
// 獲取TreeMap中大于key的最小的節(jié)點(diǎn)梅忌。
// 若不存在狰腌，就返回null。
// 請參照getCeilingEntry來對getHigherEntry進(jìn)行理解牧氮。
final Entry<K,V> getHigherEntry(K key) {
Entry<K,V> p = root;
while (p != null) {
int cmp = compare(key, p.key);
if (cmp < 0) {
if (p.left != null)
p = p.left;
else
return p;
} else {
if (p.right != null) {
p = p.right;
} else {
Entry<K,V> parent = p.parent;
Entry<K,V> ch = p;
while (parent != null && ch == parent.right) {
ch = parent;
parent = parent.parent;
}
return parent;
}
}
}
return null;
}
// 獲取TreeMap中小于key的最大的節(jié)點(diǎn)琼腔。
// 若不存在，就返回null踱葛。
// 請參照getCeilingEntry來對getLowerEntry進(jìn)行理解丹莲。
final Entry<K,V> getLowerEntry(K key) {
Entry<K,V> p = root;
while (p != null) {
int cmp = compare(key, p.key);
if (cmp > 0) {
if (p.right != null)
p = p.right;
else
return p;
} else {
if (p.left != null) {
p = p.left;
} else {
Entry<K,V> parent = p.parent;
Entry<K,V> ch = p;
while (parent != null && ch == parent.left) {
ch = parent;
parent = parent.parent;
}
return parent;
}
}
}
return null;
}
// 將“key, value”添加到TreeMap中
// 理解TreeMap的前提是掌握“紅黑樹”。
// 若理解“紅黑樹中添加節(jié)點(diǎn)”的算法尸诽，則很容易理解put甥材。
public V put(K key, V value) {
Entry<K,V> t = root;
// 若紅黑樹為空，則插入根節(jié)點(diǎn)
if (t == null) {
// TBD:
// 5045147: (coll) Adding null to an empty TreeSet should
// throw NullPointerException
//
// compare(key, key); // type check
root = new Entry<K,V>(key, value, null);
size = 1;
modCount++;
return null;
}
int cmp;
Entry<K,V> parent;
// split comparator and comparable paths
Comparator<? super K> cpr = comparator;
// 在二叉樹(紅黑樹是特殊的二叉樹)中性含，找到(key, value)的插入位置洲赵。
// 紅黑樹是以key來進(jìn)行排序的，所以這里以key來進(jìn)行查找商蕴。
if (cpr != null) {
do {
parent = t;
cmp = cpr.compare(key, t.key);
if (cmp < 0)
t = t.left;
else if (cmp > 0)
t = t.right;
else
return t.setValue(value);
} while (t != null);
}
else {
if (key == null)
throw new NullPointerException();
Comparable<? super K> k = (Comparable<? super K>) key;
do {
parent = t;
cmp = k.compareTo(t.key);
if (cmp < 0)
t = t.left;
else if (cmp > 0)
t = t.right;
else
return t.setValue(value);
} while (t != null);
}
// 新建紅黑樹的節(jié)點(diǎn)(e)
Entry<K,V> e = new Entry<K,V>(key, value, parent);
if (cmp < 0)
parent.left = e;
else
parent.right = e;
// 紅黑樹插入節(jié)點(diǎn)后叠萍，不再是一顆紅黑樹；
// 這里通過fixAfterInsertion的處理绪商，來恢復(fù)紅黑樹的特性苛谷。
fixAfterInsertion(e);
size++;
modCount++;
return null;
}
// 刪除TreeMap中的鍵為key的節(jié)點(diǎn)，并返回節(jié)點(diǎn)的值
public V remove(Object key) {
// 找到鍵為key的節(jié)點(diǎn)
Entry<K,V> p = getEntry(key);
if (p == null)
return null;
// 保存節(jié)點(diǎn)的值
V oldValue = p.value;
// 刪除節(jié)點(diǎn)
deleteEntry(p);
return oldValue;
}
// 清空紅黑樹
public void clear() {
modCount++;
size = 0;
root = null;
}
// 克隆一個TreeMap，并返回Object對象
public Object clone() {
TreeMap<K,V> clone = null;
try {
clone = (TreeMap<K,V>) super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError();
}
// Put clone into "virgin" state (except for comparator)
clone.root = null;
clone.size = 0;
clone.modCount = 0;
clone.entrySet = null;
clone.navigableKeySet = null;
clone.descendingMap = null;
// Initialize clone with our mappings
try {
clone.buildFromSorted(size, entrySet().iterator(), null, null);
} catch (java.io.IOException cannotHappen) {
} catch (ClassNotFoundException cannotHappen) {
}
return clone;
}
// 獲取第一個節(jié)點(diǎn)(對外接口)。
public Map.Entry<K,V> firstEntry() {
return exportEntry(getFirstEntry());
}
// 獲取最后一個節(jié)點(diǎn)(對外接口)售淡。
public Map.Entry<K,V> lastEntry() {
return exportEntry(getLastEntry());
}
// 獲取第一個節(jié)點(diǎn)，并將改節(jié)點(diǎn)從TreeMap中刪除赫蛇。
public Map.Entry<K,V> pollFirstEntry() {
// 獲取第一個節(jié)點(diǎn)
Entry<K,V> p = getFirstEntry();
Map.Entry<K,V> result = exportEntry(p);
// 刪除第一個節(jié)點(diǎn)
if (p != null)
deleteEntry(p);
return result;
}
// 獲取最后一個節(jié)點(diǎn)，并將改節(jié)點(diǎn)從TreeMap中刪除雾叭。
public Map.Entry<K,V> pollLastEntry() {
// 獲取最后一個節(jié)點(diǎn)
Entry<K,V> p = getLastEntry();
Map.Entry<K,V> result = exportEntry(p);
// 刪除最后一個節(jié)點(diǎn)
if (p != null)
deleteEntry(p);
return result;
}
// 返回小于key的最大的鍵值對悟耘，沒有的話返回null
public Map.Entry<K,V> lowerEntry(K key) {
return exportEntry(getLowerEntry(key));
}
// 返回小于key的最大的鍵值對所對應(yīng)的KEY，沒有的話返回null
public K lowerKey(K key) {
return keyOrNull(getLowerEntry(key));
}
// 返回不大于key的最大的鍵值對织狐，沒有的話返回null
public Map.Entry<K,V> floorEntry(K key) {
return exportEntry(getFloorEntry(key));
}
// 返回不大于key的最大的鍵值對所對應(yīng)的KEY暂幼，沒有的話返回null
public K floorKey(K key) {
return keyOrNull(getFloorEntry(key));
}
// 返回不小于key的最小的鍵值對，沒有的話返回null
public Map.Entry<K,V> ceilingEntry(K key) {
return exportEntry(getCeilingEntry(key));
}
// 返回不小于key的最小的鍵值對所對應(yīng)的KEY移迫，沒有的話返回null
public K ceilingKey(K key) {
return keyOrNull(getCeilingEntry(key));
}
// 返回大于key的最小的鍵值對旺嬉，沒有的話返回null
public Map.Entry<K,V> higherEntry(K key) {
return exportEntry(getHigherEntry(key));
}
// 返回大于key的最小的鍵值對所對應(yīng)的KEY，沒有的話返回null
public K higherKey(K key) {
return keyOrNull(getHigherEntry(key));
}
// TreeMap的紅黑樹節(jié)點(diǎn)對應(yīng)的集合
private transient EntrySet entrySet = null;
// KeySet為KeySet導(dǎo)航類
private transient KeySet<K> navigableKeySet = null;
// descendingMap為鍵值對的倒序“映射”
private transient NavigableMap<K,V> descendingMap = null;
// 返回TreeMap的“鍵的集合”
public Set<K> keySet() {
return navigableKeySet();
}
// 獲取“可導(dǎo)航”的Key的集合
// 實(shí)際上是返回KeySet類的對象厨埋。
public NavigableSet<K> navigableKeySet() {
KeySet<K> nks = navigableKeySet;
return (nks != null) ? nks : (navigableKeySet = new KeySet(this));
}
// 返回“TreeMap的值對應(yīng)的集合”
public Collection<V> values() {
Collection<V> vs = values;
return (vs != null) ? vs : (values = new Values());
}
// 獲取TreeMap的Entry的集合邪媳，實(shí)際上是返回EntrySet類的對象。
public Set<Map.Entry<K,V>> entrySet() {
EntrySet es = entrySet;
return (es != null) ? es : (entrySet = new EntrySet());
}
// 獲取TreeMap的降序Map
// 實(shí)際上是返回DescendingSubMap類的對象
public NavigableMap<K, V> descendingMap() {
NavigableMap<K, V> km = descendingMap;
return (km != null) ? km :
(descendingMap = new DescendingSubMap(this,
true, null, true,
true, null, true));
}
// 獲取TreeMap的子Map
// 范圍是從fromKey 到 toKey；fromInclusive是是否包含fromKey的標(biāo)記雨效，toInclusive是是否包含toKey的標(biāo)記
public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive,
K toKey, boolean toInclusive) {
return new AscendingSubMap(this,
false, fromKey, fromInclusive,
false, toKey, toInclusive);
}
// 獲取“Map的頭部”
// 范圍從第一個節(jié)點(diǎn) 到 toKey, inclusive是是否包含toKey的標(biāo)記
public NavigableMap<K,V> headMap(K toKey, boolean inclusive) {
return new AscendingSubMap(this,
true, null, true,
false, toKey, inclusive);
}
// 獲取“Map的尾部”迅涮。
// 范圍是從 fromKey 到 最后一個節(jié)點(diǎn)，inclusive是是否包含fromKey的標(biāo)記
public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive) {
return new AscendingSubMap(this,
false, fromKey, inclusive,
true, null, true);
}
// 獲取“子Map”徽龟。
// 范圍是從fromKey(包括) 到 toKey(不包括)
public SortedMap<K,V> subMap(K fromKey, K toKey) {
return subMap(fromKey, true, toKey, false);
}
// 獲取“Map的頭部”叮姑。
// 范圍從第一個節(jié)點(diǎn) 到 toKey(不包括)
public SortedMap<K,V> headMap(K toKey) {
return headMap(toKey, false);
}
// 獲取“Map的尾部”。
// 范圍是從 fromKey(包括) 到 最后一個節(jié)點(diǎn)
public SortedMap<K,V> tailMap(K fromKey) {
return tailMap(fromKey, true);
}
// ”TreeMap的值的集合“對應(yīng)的類据悔，它集成于AbstractCollection
class Values extends AbstractCollection<V> {
// 返回迭代器
public Iterator<V> iterator() {
return new ValueIterator(getFirstEntry());
}
// 返回個數(shù)
public int size() {
return TreeMap.this.size();
}
// "TreeMap的值的集合"中是否包含"對象o"
public boolean contains(Object o) {
return TreeMap.this.containsValue(o);
}
// 刪除"TreeMap的值的集合"中的"對象o"
public boolean remove(Object o) {
for (Entry<K,V> e = getFirstEntry(); e != null; e = successor(e)) {
if (valEquals(e.getValue(), o)) {
deleteEntry(e);
return true;
}
}
return false;
}
// 清空刪除"TreeMap的值的集合"
public void clear() {
TreeMap.this.clear();
}
}
// EntrySet是“TreeMap的所有鍵值對組成的集合”传透，
// EntrySet集合的單位是單個“鍵值對”。
class EntrySet extends AbstractSet<Map.Entry<K,V>> {
public Iterator<Map.Entry<K,V>> iterator() {
return new EntryIterator(getFirstEntry());
}
// EntrySet中是否包含“鍵值對Object”
public boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
V value = entry.getValue();
Entry<K,V> p = getEntry(entry.getKey());
return p != null && valEquals(p.getValue(), value);
}
// 刪除EntrySet中的“鍵值對Object”
public boolean remove(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
V value = entry.getValue();
Entry<K,V> p = getEntry(entry.getKey());
if (p != null && valEquals(p.getValue(), value)) {
deleteEntry(p);
return true;
}
return false;
}
// 返回EntrySet中元素個數(shù)
public int size() {
return TreeMap.this.size();
}
// 清空EntrySet
public void clear() {
TreeMap.this.clear();
}
}
// 返回“TreeMap的KEY組成的迭代器(順序)”
Iterator<K> keyIterator() {
return new KeyIterator(getFirstEntry());
}
// 返回“TreeMap的KEY組成的迭代器(逆序)”
Iterator<K> descendingKeyIterator() {
return new DescendingKeyIterator(getLastEntry());
}
// KeySet是“TreeMap中所有的KEY組成的集合”
// KeySet繼承于AbstractSet极颓，而且實(shí)現(xiàn)了NavigableSet接口旷祸。
static final class KeySet<E> extends AbstractSet<E> implements NavigableSet<E> {
// NavigableMap成員，KeySet是通過NavigableMap實(shí)現(xiàn)的
private final NavigableMap<E, Object> m;
KeySet(NavigableMap<E,Object> map) { m = map; }
// 升序迭代器
public Iterator<E> iterator() {
// 若是TreeMap對象讼昆，則調(diào)用TreeMap的迭代器keyIterator()
// 否則，調(diào)用TreeMap子類NavigableSubMap的迭代器keyIterator()
if (m instanceof TreeMap)
return ((TreeMap<E,Object>)m).keyIterator();
else
return (Iterator<E>)(((TreeMap.NavigableSubMap)m).keyIterator());
}
// 降序迭代器
public Iterator<E> descendingIterator() {
// 若是TreeMap對象骚烧，則調(diào)用TreeMap的迭代器descendingKeyIterator()
// 否則浸赫，調(diào)用TreeMap子類NavigableSubMap的迭代器descendingKeyIterator()
if (m instanceof TreeMap)
return ((TreeMap<E,Object>)m).descendingKeyIterator();
else
return (Iterator<E>)(((TreeMap.NavigableSubMap)m).descendingKeyIterator());
}
public int size() { return m.size(); }
public boolean isEmpty() { return m.isEmpty(); }
public boolean contains(Object o) { return m.containsKey(o); }
public void clear() { m.clear(); }
public E lower(E e) { return m.lowerKey(e); }
public E floor(E e) { return m.floorKey(e); }
public E ceiling(E e) { return m.ceilingKey(e); }
public E higher(E e) { return m.higherKey(e); }
public E first() { return m.firstKey(); }
public E last() { return m.lastKey(); }
public Comparator<? super E> comparator() { return m.comparator(); }
public E pollFirst() {
Map.Entry<E,Object> e = m.pollFirstEntry();
return e == null? null : e.getKey();
}
public E pollLast() {
Map.Entry<E,Object> e = m.pollLastEntry();
return e == null? null : e.getKey();
}
public boolean remove(Object o) {
int oldSize = size();
m.remove(o);
return size() != oldSize;
}
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive,
E toElement, boolean toInclusive) {
return new TreeSet<E>(m.subMap(fromElement, fromInclusive,
toElement, toInclusive));
}
public NavigableSet<E> headSet(E toElement, boolean inclusive) {
return new TreeSet<E>(m.headMap(toElement, inclusive));
}
public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
return new TreeSet<E>(m.tailMap(fromElement, inclusive));
}
public SortedSet<E> subSet(E fromElement, E toElement) {
return subSet(fromElement, true, toElement, false);
}
public SortedSet<E> headSet(E toElement) {
return headSet(toElement, false);
}
public SortedSet<E> tailSet(E fromElement) {
return tailSet(fromElement, true);
}
public NavigableSet<E> descendingSet() {
return new TreeSet(m.descendingMap());
}
}
// 它是TreeMap中的一個抽象迭代器，實(shí)現(xiàn)了一些通用的接口赃绊。
abstract class PrivateEntryIterator<T> implements Iterator<T> {
// 下一個元素
Entry<K,V> next;
// 上一次返回元素
Entry<K,V> lastReturned;
// 期望的修改次數(shù)既峡，用于實(shí)現(xiàn)fast-fail機(jī)制
int expectedModCount;
PrivateEntryIterator(Entry<K,V> first) {
expectedModCount = modCount;
lastReturned = null;
next = first;
}
public final boolean hasNext() {
return next != null;
}
// 獲取下一個節(jié)點(diǎn)
final Entry<K,V> nextEntry() {
Entry<K,V> e = next;
if (e == null)
throw new NoSuchElementException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
next = successor(e);
lastReturned = e;
return e;
}
// 獲取上一個節(jié)點(diǎn)
final Entry<K,V> prevEntry() {
Entry<K,V> e = next;
if (e == null)
throw new NoSuchElementException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
next = predecessor(e);
lastReturned = e;
return e;
}
// 刪除當(dāng)前節(jié)點(diǎn)
public void remove() {
if (lastReturned == null)
throw new IllegalStateException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
// 這里重點(diǎn)強(qiáng)調(diào)一下“為什么當(dāng)lastReturned的左右孩子都不為空時，要將其賦值給next”碧查。
// 目的是為了“刪除lastReturned節(jié)點(diǎn)之后运敢，next節(jié)點(diǎn)指向的仍然是下一個節(jié)點(diǎn)”。
// 根據(jù)“紅黑樹”的特性可知：
// 當(dāng)被刪除節(jié)點(diǎn)有兩個兒子時忠售。那么传惠，首先把“它的后繼節(jié)點(diǎn)的內(nèi)容”復(fù)制給“該節(jié)點(diǎn)的內(nèi)容”；之后稻扬，刪除“它的后繼節(jié)點(diǎn)”卦方。
// 這意味著“當(dāng)被刪除節(jié)點(diǎn)有兩個兒子時，刪除當(dāng)前節(jié)點(diǎn)之后泰佳，'新的當(dāng)前節(jié)點(diǎn)'實(shí)際上是‘原有的后繼節(jié)點(diǎn)(即下一個節(jié)點(diǎn))’”盼砍。
// 而此時next仍然指向"新的當(dāng)前節(jié)點(diǎn)"。也就是說next是仍然是指向下一個節(jié)點(diǎn)逝她；能繼續(xù)遍歷紅黑樹浇坐。
if (lastReturned.left != null && lastReturned.right != null)
next = lastReturned;
deleteEntry(lastReturned);
expectedModCount = modCount;
lastReturned = null;
}
}
// TreeMap的Entry對應(yīng)的迭代器
final class EntryIterator extends PrivateEntryIterator<Map.Entry<K,V>> {
EntryIterator(Entry<K,V> first) {
super(first);
}
public Map.Entry<K,V> next() {
return nextEntry();
}
}
// TreeMap的Value對應(yīng)的迭代器
final class ValueIterator extends PrivateEntryIterator<V> {
ValueIterator(Entry<K,V> first) {
super(first);
}
public V next() {
return nextEntry().value;
}
}
// reeMap的KEY組成的迭代器(順序)
final class KeyIterator extends PrivateEntryIterator<K> {
KeyIterator(Entry<K,V> first) {
super(first);
}
public K next() {
return nextEntry().key;
}
}
// TreeMap的KEY組成的迭代器(逆序)
final class DescendingKeyIterator extends PrivateEntryIterator<K> {
DescendingKeyIterator(Entry<K,V> first) {
super(first);
}
public K next() {
return prevEntry().key;
}
}
// 比較兩個對象的大小
final int compare(Object k1, Object k2) {
return comparator==null ? ((Comparable<? super K>)k1).compareTo((K)k2)
: comparator.compare((K)k1, (K)k2);
}
// 判斷兩個對象是否相等
final static boolean valEquals(Object o1, Object o2) {
return (o1==null ? o2==null : o1.equals(o2));
}
// 返回“Key-Value鍵值對”的一個簡單拷貝(AbstractMap.SimpleImmutableEntry<K,V>對象)
// 可用來讀取“鍵值對”的值
static <K,V> Map.Entry<K,V> exportEntry(TreeMap.Entry<K,V> e) {
return e == null? null :
new AbstractMap.SimpleImmutableEntry<K,V>(e);
}
// 若“鍵值對”不為null，則返回KEY黔宛；否則近刘，返回null
static <K,V> K keyOrNull(TreeMap.Entry<K,V> e) {
return e == null? null : e.key;
}
// 若“鍵值對”不為null，則返回KEY；否則跌宛，拋出異常
static <K> K key(Entry<K,?> e) {
if (e==null)
throw new NoSuchElementException();
return e.key;
}
// TreeMap的SubMap酗宋，它一個抽象類，實(shí)現(xiàn)了公共操作疆拘。
// 它包括了"(升序)AscendingSubMap"和"(降序)DescendingSubMap"兩個子類蜕猫。
static abstract class NavigableSubMap<K,V> extends AbstractMap<K,V>
implements NavigableMap<K,V>, java.io.Serializable {
// TreeMap的拷貝
final TreeMap<K,V> m;
// lo是“子Map范圍的最小值”，hi是“子Map范圍的最大值”哎迄；
// loInclusive是“是否包含lo的標(biāo)記”回右，hiInclusive是“是否包含hi的標(biāo)記”
// fromStart是“表示是否從第一個節(jié)點(diǎn)開始計算”，
// toEnd是“表示是否計算到最后一個節(jié)點(diǎn) ”
final K lo, hi;
final boolean fromStart, toEnd;
final boolean loInclusive, hiInclusive;
// 構(gòu)造函數(shù)
NavigableSubMap(TreeMap<K,V> m,
boolean fromStart, K lo, boolean loInclusive,
boolean toEnd, K hi, boolean hiInclusive) {
if (!fromStart && !toEnd) {
if (m.compare(lo, hi) > 0)
throw new IllegalArgumentException("fromKey > toKey");
} else {
if (!fromStart) // type check
m.compare(lo, lo);
if (!toEnd)
m.compare(hi, hi);
}
this.m = m;
this.fromStart = fromStart;
this.lo = lo;
this.loInclusive = loInclusive;
this.toEnd = toEnd;
this.hi = hi;
this.hiInclusive = hiInclusive;
}
// 判斷key是否太小
final boolean tooLow(Object key) {
// 若該SubMap不包括“起始節(jié)點(diǎn)”漱挚，
// 并且翔烁，“key小于最小鍵(lo)”或者“key等于最小鍵(lo)，但最小鍵卻沒包括在該SubMap內(nèi)”
// 則判斷key太小旨涝。其余情況都不是太械乓佟！
if (!fromStart) {
int c = m.compare(key, lo);
if (c < 0 || (c == 0 && !loInclusive))
return true;
}
return false;
}
// 判斷key是否太大
final boolean tooHigh(Object key) {
// 若該SubMap不包括“結(jié)束節(jié)點(diǎn)”白华，
// 并且慨默，“key大于最大鍵(hi)”或者“key等于最大鍵(hi)，但最大鍵卻沒包括在該SubMap內(nèi)”
// 則判斷key太大弧腥。其余情況都不是太大厦取！
if (!toEnd) {
int c = m.compare(key, hi);
if (c > 0 || (c == 0 && !hiInclusive))
return true;
}
return false;
}
// 判斷key是否在“l(fā)o和hi”開區(qū)間范圍內(nèi)
final boolean inRange(Object key) {
return !tooLow(key) && !tooHigh(key);
}
// 判斷key是否在封閉區(qū)間內(nèi)
final boolean inClosedRange(Object key) {
return (fromStart || m.compare(key, lo) >= 0)
&& (toEnd || m.compare(hi, key) >= 0);
}
// 判斷key是否在區(qū)間內(nèi), inclusive是區(qū)間開關(guān)標(biāo)志
final boolean inRange(Object key, boolean inclusive) {
return inclusive ? inRange(key) : inClosedRange(key);
}
// 返回最低的Entry
final TreeMap.Entry<K,V> absLowest() {
// 若“包含起始節(jié)點(diǎn)”，則調(diào)用getFirstEntry()返回第一個節(jié)點(diǎn)
// 否則的話管搪，若包括lo虾攻，則調(diào)用getCeilingEntry(lo)獲取大于/等于lo的最小的Entry;
// 否則，調(diào)用getHigherEntry(lo)獲取大于lo的最小Entry
TreeMap.Entry<K,V> e =
(fromStart ? m.getFirstEntry() :
(loInclusive ? m.getCeilingEntry(lo) :
m.getHigherEntry(lo)));
return (e == null || tooHigh(e.key)) ? null : e;
}
// 返回最高的Entry
final TreeMap.Entry<K,V> absHighest() {
// 若“包含結(jié)束節(jié)點(diǎn)”更鲁，則調(diào)用getLastEntry()返回最后一個節(jié)點(diǎn)
// 否則的話霎箍，若包括hi，則調(diào)用getFloorEntry(hi)獲取小于/等于hi的最大的Entry;
// 否則澡为，調(diào)用getLowerEntry(hi)獲取大于hi的最大Entry
TreeMap.Entry<K,V> e =
TreeMap.Entry<K,V> e =
(toEnd ? m.getLastEntry() :
(hiInclusive ? m.getFloorEntry(hi) :
m.getLowerEntry(hi)));
return (e == null || tooLow(e.key)) ? null : e;
}
// 返回"大于/等于key的最小的Entry"
final TreeMap.Entry<K,V> absCeiling(K key) {
// 只有在“key太小”的情況下朋沮，absLowest()返回的Entry才是“大于/等于key的最小Entry”
// 其它情況下不行。例如缀壤，當(dāng)包含“起始節(jié)點(diǎn)”時樊拓，absLowest()返回的是最小Entry了！
if (tooLow(key))
return absLowest();
// 獲取“大于/等于key的最小Entry”
TreeMap.Entry<K,V> e = m.getCeilingEntry(key);
return (e == null || tooHigh(e.key)) ? null : e;
}
// 返回"大于key的最小的Entry"
final TreeMap.Entry<K,V> absHigher(K key) {
// 只有在“key太小”的情況下塘慕，absLowest()返回的Entry才是“大于key的最小Entry”
// 其它情況下不行筋夏。例如，當(dāng)包含“起始節(jié)點(diǎn)”時图呢，absLowest()返回的是最小Entry了,而不一定是“大于key的最小Entry”条篷！
if (tooLow(key))
return absLowest();
// 獲取“大于key的最小Entry”
TreeMap.Entry<K,V> e = m.getHigherEntry(key);
return (e == null || tooHigh(e.key)) ? null : e;
}
// 返回"小于/等于key的最大的Entry"
final TreeMap.Entry<K,V> absFloor(K key) {
// 只有在“key太大”的情況下骗随，(absHighest)返回的Entry才是“小于/等于key的最大Entry”
// 其它情況下不行。例如赴叹，當(dāng)包含“結(jié)束節(jié)點(diǎn)”時鸿染，absHighest()返回的是最大Entry了！
if (tooHigh(key))
return absHighest();
// 獲取"小于/等于key的最大的Entry"
TreeMap.Entry<K,V> e = m.getFloorEntry(key);
return (e == null || tooLow(e.key)) ? null : e;
}
// 返回"小于key的最大的Entry"
final TreeMap.Entry<K,V> absLower(K key) {
// 只有在“key太大”的情況下乞巧，(absHighest)返回的Entry才是“小于key的最大Entry”
// 其它情況下不行涨椒。例如，當(dāng)包含“結(jié)束節(jié)點(diǎn)”時绽媒，absHighest()返回的是最大Entry了,而不一定是“小于key的最大Entry”蚕冬！
if (tooHigh(key))
return absHighest();
// 獲取"小于key的最大的Entry"
TreeMap.Entry<K,V> e = m.getLowerEntry(key);
return (e == null || tooLow(e.key)) ? null : e;
}
// 返回“大于最大節(jié)點(diǎn)中的最小節(jié)點(diǎn)”，不存在的話是辕，返回null
final TreeMap.Entry<K,V> absHighFence() {
return (toEnd ? null : (hiInclusive ?
m.getHigherEntry(hi) :
m.getCeilingEntry(hi)));
}
// 返回“小于最小節(jié)點(diǎn)中的最大節(jié)點(diǎn)”囤热，不存在的話，返回null
final TreeMap.Entry<K,V> absLowFence() {
return (fromStart ? null : (loInclusive ?
m.getLowerEntry(lo) :
m.getFloorEntry(lo)));
}
// 下面幾個abstract方法是需要NavigableSubMap的實(shí)現(xiàn)類實(shí)現(xiàn)的方法
abstract TreeMap.Entry<K,V> subLowest();
abstract TreeMap.Entry<K,V> subHighest();
abstract TreeMap.Entry<K,V> subCeiling(K key);
abstract TreeMap.Entry<K,V> subHigher(K key);
abstract TreeMap.Entry<K,V> subFloor(K key);
abstract TreeMap.Entry<K,V> subLower(K key);
// 返回“順序”的鍵迭代器
abstract Iterator<K> keyIterator();
// 返回“逆序”的鍵迭代器
abstract Iterator<K> descendingKeyIterator();
// 返回SubMap是否為空获三∨园空的話，返回true疙教，否則返回false
public boolean isEmpty() {
return (fromStart && toEnd) ? m.isEmpty() : entrySet().isEmpty();
}
// 返回SubMap的大小
public int size() {
return (fromStart && toEnd) ? m.size() : entrySet().size();
}
// 返回SubMap是否包含鍵key
public final boolean containsKey(Object key) {
return inRange(key) && m.containsKey(key);
}
// 將key-value 插入SubMap中
public final V put(K key, V value) {
if (!inRange(key))
throw new IllegalArgumentException("key out of range");
return m.put(key, value);
}
// 獲取key對應(yīng)值
public final V get(Object key) {
return !inRange(key)? null : m.get(key);
}
// 刪除key對應(yīng)的鍵值對
public final V remove(Object key) {
return !inRange(key)? null : m.remove(key);
}
// 獲取“大于/等于key的最小鍵值對”
public final Map.Entry<K,V> ceilingEntry(K key) {
return exportEntry(subCeiling(key));
}
// 獲取“大于/等于key的最小鍵”
public final K ceilingKey(K key) {
return keyOrNull(subCeiling(key));
}
// 獲取“大于key的最小鍵值對”
public final Map.Entry<K,V> higherEntry(K key) {
return exportEntry(subHigher(key));
}
// 獲取“大于key的最小鍵”
public final K higherKey(K key) {
return keyOrNull(subHigher(key));
}
// 獲取“小于/等于key的最大鍵值對”
public final Map.Entry<K,V> floorEntry(K key) {
return exportEntry(subFloor(key));
}
// 獲取“小于/等于key的最大鍵”
public final K floorKey(K key) {
return keyOrNull(subFloor(key));
}
// 獲取“小于key的最大鍵值對”
public final Map.Entry<K,V> lowerEntry(K key) {
return exportEntry(subLower(key));
}
// 獲取“小于key的最大鍵”
public final K lowerKey(K key) {
return keyOrNull(subLower(key));
}
// 獲取"SubMap的第一個鍵"
public final K firstKey() {
return key(subLowest());
}
// 獲取"SubMap的最后一個鍵"
public final K lastKey() {
return key(subHighest());
}
// 獲取"SubMap的第一個鍵值對"
public final Map.Entry<K,V> firstEntry() {
return exportEntry(subLowest());
}
// 獲取"SubMap的最后一個鍵值對"
public final Map.Entry<K,V> lastEntry() {
return exportEntry(subHighest());
}
// 返回"SubMap的第一個鍵值對"牌芋，并從SubMap中刪除改鍵值對
public final Map.Entry<K,V> pollFirstEntry() {
TreeMap.Entry<K,V> e = subLowest();
Map.Entry<K,V> result = exportEntry(e);
if (e != null)
m.deleteEntry(e);
return result;
}
// 返回"SubMap的最后一個鍵值對"，并從SubMap中刪除改鍵值對
public final Map.Entry<K,V> pollLastEntry() {
TreeMap.Entry<K,V> e = subHighest();
Map.Entry<K,V> result = exportEntry(e);
if (e != null)
m.deleteEntry(e);
return result;
}
// Views
transient NavigableMap<K,V> descendingMapView = null;
transient EntrySetView entrySetView = null;
transient KeySet<K> navigableKeySetView = null;
// 返回NavigableSet對象松逊，實(shí)際上返回的是當(dāng)前對象的"Key集合"。
public final NavigableSet<K> navigableKeySet() {
KeySet<K> nksv = navigableKeySetView;
return (nksv != null) ? nksv :
(navigableKeySetView = new TreeMap.KeySet(this));
}
// 返回"Key集合"對象
public final Set<K> keySet() {
return navigableKeySet();
}
// 返回“逆序”的Key集合
public NavigableSet<K> descendingKeySet() {
return descendingMap().navigableKeySet();
}
// 排列fromKey(包含) 到 toKey(不包含) 的子map
public final SortedMap<K,V> subMap(K fromKey, K toKey) {
return subMap(fromKey, true, toKey, false);
}
// 返回當(dāng)前Map的頭部(從第一個節(jié)點(diǎn) 到 toKey, 不包括toKey)
public final SortedMap<K,V> headMap(K toKey) {
return headMap(toKey, false);
}
// 返回當(dāng)前Map的尾部[從 fromKey(包括fromKeyKey) 到 最后一個節(jié)點(diǎn)]
public final SortedMap<K,V> tailMap(K fromKey) {
return tailMap(fromKey, true);
}
// Map的Entry的集合
abstract class EntrySetView extends AbstractSet<Map.Entry<K,V>> {
private transient int size = -1, sizeModCount;
// 獲取EntrySet的大小
public int size() {
// 若SubMap是從“開始節(jié)點(diǎn)”到“結(jié)尾節(jié)點(diǎn)”肯夏，則SubMap大小就是原TreeMap的大小
if (fromStart && toEnd)
return m.size();
// 若SubMap不是從“開始節(jié)點(diǎn)”到“結(jié)尾節(jié)點(diǎn)”经宏，則調(diào)用iterator()遍歷EntrySetView中的元素
if (size == -1 || sizeModCount != m.modCount) {
sizeModCount = m.modCount;
size = 0;
Iterator i = iterator();
while (i.hasNext()) {
size++;
i.next();
}
}
return size;
}
// 判斷EntrySetView是否為空
public boolean isEmpty() {
TreeMap.Entry<K,V> n = absLowest();
return n == null || tooHigh(n.key);
}
// 判斷EntrySetView是否包含Object
public boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
K key = entry.getKey();
if (!inRange(key))
return false;
TreeMap.Entry node = m.getEntry(key);
return node != null &&
valEquals(node.getValue(), entry.getValue());
}
// 從EntrySetView中刪除Object
public boolean remove(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
K key = entry.getKey();
if (!inRange(key))
return false;
TreeMap.Entry<K,V> node = m.getEntry(key);
if (node!=null && valEquals(node.getValue(),entry.getValue())){
m.deleteEntry(node);
return true;
}
return false;
}
}
// SubMap的迭代器
abstract class SubMapIterator<T> implements Iterator<T> {
// 上一次被返回的Entry
TreeMap.Entry<K,V> lastReturned;
// 指向下一個Entry
TreeMap.Entry<K,V> next;
// “柵欄key”。根據(jù)SubMap是“升序”還是“降序”具有不同的意義
final K fenceKey;
int expectedModCount;
// 構(gòu)造函數(shù)
SubMapIterator(TreeMap.Entry<K,V> first,
TreeMap.Entry<K,V> fence) {
// 每創(chuàng)建一個SubMapIterator時驯击，保存修改次數(shù)
// 若后面發(fā)現(xiàn)expectedModCount和modCount不相等烁兰，則拋出ConcurrentModificationException異常。
// 這就是所說的fast-fail機(jī)制的原理徊都！
expectedModCount = m.modCount;
lastReturned = null;
next = first;
fenceKey = fence == null ? null : fence.key;
}
// 是否存在下一個Entry
public final boolean hasNext() {
return next != null && next.key != fenceKey;
}
// 返回下一個Entry
final TreeMap.Entry<K,V> nextEntry() {
TreeMap.Entry<K,V> e = next;
if (e == null || e.key == fenceKey)
throw new NoSuchElementException();
if (m.modCount != expectedModCount)
throw new ConcurrentModificationException();
// next指向e的后繼節(jié)點(diǎn)
next = successor(e);
lastReturned = e;
return e;
}
// 返回上一個Entry
final TreeMap.Entry<K,V> prevEntry() {
TreeMap.Entry<K,V> e = next;
if (e == null || e.key == fenceKey)
throw new NoSuchElementException();
if (m.modCount != expectedModCount)
throw new ConcurrentModificationException();
// next指向e的前繼節(jié)點(diǎn)
next = predecessor(e);
lastReturned = e;
return e;
}
// 刪除當(dāng)前節(jié)點(diǎn)(用于“升序的SubMap”)沪斟。
// 刪除之后，可以繼續(xù)升序遍歷暇矫；紅黑樹特性沒變主之。
final void removeAscending() {
if (lastReturned == null)
throw new IllegalStateException();
if (m.modCount != expectedModCount)
throw new ConcurrentModificationException();
// 這里重點(diǎn)強(qiáng)調(diào)一下“為什么當(dāng)lastReturned的左右孩子都不為空時，要將其賦值給next”李根。
// 目的是為了“刪除lastReturned節(jié)點(diǎn)之后槽奕，next節(jié)點(diǎn)指向的仍然是下一個節(jié)點(diǎn)”。
// 根據(jù)“紅黑樹”的特性可知：
// 當(dāng)被刪除節(jié)點(diǎn)有兩個兒子時房轿。那么粤攒，首先把“它的后繼節(jié)點(diǎn)的內(nèi)容”復(fù)制給“該節(jié)點(diǎn)的內(nèi)容”所森；之后，刪除“它的后繼節(jié)點(diǎn)”夯接。
// 這意味著“當(dāng)被刪除節(jié)點(diǎn)有兩個兒子時焕济，刪除當(dāng)前節(jié)點(diǎn)之后，'新的當(dāng)前節(jié)點(diǎn)'實(shí)際上是‘原有的后繼節(jié)點(diǎn)(即下一個節(jié)點(diǎn))’”盔几。
// 而此時next仍然指向"新的當(dāng)前節(jié)點(diǎn)"晴弃。也就是說next是仍然是指向下一個節(jié)點(diǎn)；能繼續(xù)遍歷紅黑樹问欠。
if (lastReturned.left != null && lastReturned.right != null)
next = lastReturned;
m.deleteEntry(lastReturned);
lastReturned = null;
expectedModCount = m.modCount;
}
// 刪除當(dāng)前節(jié)點(diǎn)(用于“降序的SubMap”)肝匆。
// 刪除之后，可以繼續(xù)降序遍歷顺献；紅黑樹特性沒變旗国。
final void removeDescending() {
if (lastReturned == null)
throw new IllegalStateException();
if (m.modCount != expectedModCount)
throw new ConcurrentModificationException();
m.deleteEntry(lastReturned);
lastReturned = null;
expectedModCount = m.modCount;
}
}
// SubMap的Entry迭代器，它只支持升序操作注整，繼承于SubMapIterator
final class SubMapEntryIterator extends SubMapIterator<Map.Entry<K,V>> {
SubMapEntryIterator(TreeMap.Entry<K,V> first,
TreeMap.Entry<K,V> fence) {
super(first, fence);
}
// 獲取下一個節(jié)點(diǎn)(升序)
public Map.Entry<K,V> next() {
return nextEntry();
}
// 刪除當(dāng)前節(jié)點(diǎn)(升序)
public void remove() {
removeAscending();
}
}
// SubMap的Key迭代器能曾，它只支持升序操作，繼承于SubMapIterator
final class SubMapKeyIterator extends SubMapIterator<K> {
SubMapKeyIterator(TreeMap.Entry<K,V> first,
TreeMap.Entry<K,V> fence) {
super(first, fence);
}
// 獲取下一個節(jié)點(diǎn)(升序)
public K next() {
return nextEntry().key;
}
// 刪除當(dāng)前節(jié)點(diǎn)(升序)
public void remove() {
removeAscending();
}
}
// 降序SubMap的Entry迭代器肿轨，它只支持降序操作寿冕，繼承于SubMapIterator
final class DescendingSubMapEntryIterator extends SubMapIterator<Map.Entry<K,V>> {
DescendingSubMapEntryIterator(TreeMap.Entry<K,V> last,
TreeMap.Entry<K,V> fence) {
super(last, fence);
}
// 獲取下一個節(jié)點(diǎn)(降序)
public Map.Entry<K,V> next() {
return prevEntry();
}
// 刪除當(dāng)前節(jié)點(diǎn)(降序)
public void remove() {
removeDescending();
}
}
// 降序SubMap的Key迭代器，它只支持降序操作椒袍，繼承于SubMapIterator
final class DescendingSubMapKeyIterator extends SubMapIterator<K> {
DescendingSubMapKeyIterator(TreeMap.Entry<K,V> last,
TreeMap.Entry<K,V> fence) {
super(last, fence);
}
// 獲取下一個節(jié)點(diǎn)(降序)
public K next() {
return prevEntry().key;
}
// 刪除當(dāng)前節(jié)點(diǎn)(降序)
public void remove() {
removeDescending();
}
}
}
// 升序的SubMap驼唱，繼承于NavigableSubMap
static final class AscendingSubMap<K,V> extends NavigableSubMap<K,V> {
private static final long serialVersionUID = 912986545866124060L;
// 構(gòu)造函數(shù)
AscendingSubMap(TreeMap<K,V> m,
boolean fromStart, K lo, boolean loInclusive,
boolean toEnd, K hi, boolean hiInclusive) {
super(m, fromStart, lo, loInclusive, toEnd, hi, hiInclusive);
}
// 比較器
public Comparator<? super K> comparator() {
return m.comparator();
}
// 獲取“子Map”。
// 范圍是從fromKey 到 toKey驹暑；fromInclusive是是否包含fromKey的標(biāo)記玫恳，toInclusive是是否包含toKey的標(biāo)記
public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive,
K toKey, boolean toInclusive) {
if (!inRange(fromKey, fromInclusive))
throw new IllegalArgumentException("fromKey out of range");
if (!inRange(toKey, toInclusive))
throw new IllegalArgumentException("toKey out of range");
return new AscendingSubMap(m,
false, fromKey, fromInclusive,
false, toKey, toInclusive);
}
// 獲取“Map的頭部”。
// 范圍從第一個節(jié)點(diǎn) 到 toKey, inclusive是是否包含toKey的標(biāo)記
public NavigableMap<K,V> headMap(K toKey, boolean inclusive) {
if (!inRange(toKey, inclusive))
throw new IllegalArgumentException("toKey out of range");
return new AscendingSubMap(m,
fromStart, lo, loInclusive,
false, toKey, inclusive);
}
// 獲取“Map的尾部”优俘。
// 范圍是從 fromKey 到 最后一個節(jié)點(diǎn)京办，inclusive是是否包含fromKey的標(biāo)記
public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive){
if (!inRange(fromKey, inclusive))
throw new IllegalArgumentException("fromKey out of range");
return new AscendingSubMap(m,
false, fromKey, inclusive,
toEnd, hi, hiInclusive);
}
// 獲取對應(yīng)的降序Map
public NavigableMap<K,V> descendingMap() {
NavigableMap<K,V> mv = descendingMapView;
return (mv != null) ? mv :
(descendingMapView =
new DescendingSubMap(m,
fromStart, lo, loInclusive,
toEnd, hi, hiInclusive));
}
// 返回“升序Key迭代器”
Iterator<K> keyIterator() {
return new SubMapKeyIterator(absLowest(), absHighFence());
}
// 返回“降序Key迭代器”
Iterator<K> descendingKeyIterator() {
return new DescendingSubMapKeyIterator(absHighest(), absLowFence());
}
// “升序EntrySet集合”類
// 實(shí)現(xiàn)了iterator()
final class AscendingEntrySetView extends EntrySetView {
public Iterator<Map.Entry<K,V>> iterator() {
return new SubMapEntryIterator(absLowest(), absHighFence());
}
}
// 返回“升序EntrySet集合”
public Set<Map.Entry<K,V>> entrySet() {
EntrySetView es = entrySetView;
return (es != null) ? es : new AscendingEntrySetView();
}
TreeMap.Entry<K,V> subLowest() { return absLowest(); }
TreeMap.Entry<K,V> subHighest() { return absHighest(); }
TreeMap.Entry<K,V> subCeiling(K key) { return absCeiling(key); }
TreeMap.Entry<K,V> subHigher(K key) { return absHigher(key); }
TreeMap.Entry<K,V> subFloor(K key) { return absFloor(key); }
TreeMap.Entry<K,V> subLower(K key) { return absLower(key); }
}
// 降序的SubMap，繼承于NavigableSubMap
// 相比于升序SubMap帆焕，它的實(shí)現(xiàn)機(jī)制是將“SubMap的比較器反轉(zhuǎn)”！
static final class DescendingSubMap<K,V> extends NavigableSubMap<K,V> {
private static final long serialVersionUID = 912986545866120460L;
DescendingSubMap(TreeMap<K,V> m,
boolean fromStart, K lo, boolean loInclusive,
boolean toEnd, K hi, boolean hiInclusive) {
super(m, fromStart, lo, loInclusive, toEnd, hi, hiInclusive);
}
// 反轉(zhuǎn)的比較器：是將原始比較器反轉(zhuǎn)得到的财饥。
private final Comparator<? super K> reverseComparator =
Collections.reverseOrder(m.comparator);
// 獲取反轉(zhuǎn)比較器
public Comparator<? super K> comparator() {
return reverseComparator;
}
// 獲取“子Map”折晦。
// 范圍是從fromKey 到 toKey筋遭；fromInclusive是是否包含fromKey的標(biāo)記暴拄，toInclusive是是否包含toKey的標(biāo)記
public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive,
K toKey, boolean toInclusive) {
if (!inRange(fromKey, fromInclusive))
throw new IllegalArgumentException("fromKey out of range");
if (!inRange(toKey, toInclusive))
throw new IllegalArgumentException("toKey out of range");
return new DescendingSubMap(m,
false, toKey, toInclusive,
false, fromKey, fromInclusive);
}
// 獲取“Map的頭部”。
// 范圍從第一個節(jié)點(diǎn) 到 toKey, inclusive是是否包含toKey的標(biāo)記
public NavigableMap<K,V> headMap(K toKey, boolean inclusive) {
if (!inRange(toKey, inclusive))
throw new IllegalArgumentException("toKey out of range");
return new DescendingSubMap(m,
false, toKey, inclusive,
toEnd, hi, hiInclusive);
}
// 獲取“Map的尾部”撕蔼。
// 范圍是從 fromKey 到 最后一個節(jié)點(diǎn)，inclusive是是否包含fromKey的標(biāo)記
public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive){
if (!inRange(fromKey, inclusive))
throw new IllegalArgumentException("fromKey out of range");
return new DescendingSubMap(m,
fromStart, lo, loInclusive,
false, fromKey, inclusive);
}
// 獲取對應(yīng)的降序Map
public NavigableMap<K,V> descendingMap() {
NavigableMap<K,V> mv = descendingMapView;
return (mv != null) ? mv :
(descendingMapView =
new AscendingSubMap(m,
fromStart, lo, loInclusive,
toEnd, hi, hiInclusive));
}
// 返回“升序Key迭代器”
Iterator<K> keyIterator() {
return new DescendingSubMapKeyIterator(absHighest(), absLowFence());
}
// 返回“降序Key迭代器”
Iterator<K> descendingKeyIterator() {
return new SubMapKeyIterator(absLowest(), absHighFence());
}
// “降序EntrySet集合”類
// 實(shí)現(xiàn)了iterator()
final class DescendingEntrySetView extends EntrySetView {
public Iterator<Map.Entry<K,V>> iterator() {
return new DescendingSubMapEntryIterator(absHighest(), absLowFence());
}
}
// 返回“降序EntrySet集合”
public Set<Map.Entry<K,V>> entrySet() {
EntrySetView es = entrySetView;
return (es != null) ? es : new DescendingEntrySetView();
}
TreeMap.Entry<K,V> subLowest() { return absHighest(); }
TreeMap.Entry<K,V> subHighest() { return absLowest(); }
TreeMap.Entry<K,V> subCeiling(K key) { return absFloor(key); }
TreeMap.Entry<K,V> subHigher(K key) { return absLower(key); }
TreeMap.Entry<K,V> subFloor(K key) { return absCeiling(key); }
TreeMap.Entry<K,V> subLower(K key) { return absHigher(key); }
}
// SubMap是舊版本的類，新的Java中沒有用到怒坯。
private class SubMap extends AbstractMap<K,V>
implements SortedMap<K,V>, java.io.Serializable {
private static final long serialVersionUID = -6520786458950516097L;
private boolean fromStart = false, toEnd = false;
private K fromKey, toKey;
private Object readResolve() {
return new AscendingSubMap(TreeMap.this,
fromStart, fromKey, true,
toEnd, toKey, false);
}
public Set<Map.Entry<K,V>> entrySet() { throw new InternalError(); }
public K lastKey() { throw new InternalError(); }
public K firstKey() { throw new InternalError(); }
public SortedMap<K,V> subMap(K fromKey, K toKey) { throw new InternalError(); }
public SortedMap<K,V> headMap(K toKey) { throw new InternalError(); }
public SortedMap<K,V> tailMap(K fromKey) { throw new InternalError(); }
public Comparator<? super K> comparator() { throw new InternalError(); }
}
// 紅黑樹的節(jié)點(diǎn)顏色--紅色
private static final boolean RED = false;
// 紅黑樹的節(jié)點(diǎn)顏色--黑色
private static final boolean BLACK = true;
// “紅黑樹的節(jié)點(diǎn)”對應(yīng)的類嬉荆。
// 包含了 key(鍵)归敬、value(值)、left(左孩子)鄙早、right(右孩子)蝶锋、parent(父節(jié)點(diǎn))、color(顏色)
static final class Entry<K,V> implements Map.Entry<K,V> {
// 鍵
K key;
// 值
V value;
// 左孩子
Entry<K,V> left = null;
// 右孩子
Entry<K,V> right = null;
// 父節(jié)點(diǎn)
Entry<K,V> parent;
// 當(dāng)前節(jié)點(diǎn)顏色
boolean color = BLACK;
// 構(gòu)造函數(shù)
Entry(K key, V value, Entry<K,V> parent) {
this.key = key;
this.value = value;
this.parent = parent;
}
// 返回“鍵”
public K getKey() {
return key;
}
// 返回“值”
public V getValue() {
return value;
}
// 更新“值”，返回舊的值
public V setValue(V value) {
V oldValue = this.value;
this.value = value;
return oldValue;
}
// 判斷兩個節(jié)點(diǎn)是否相等的函數(shù)，覆蓋equals()函數(shù)布讹。
// 若兩個節(jié)點(diǎn)的“key相等”并且“value相等”，則兩個節(jié)點(diǎn)相等
public boolean equals(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<?,?> e = (Map.Entry<?,?>)o;
return valEquals(key,e.getKey()) && valEquals(value,e.getValue());
}
// 覆蓋hashCode函數(shù)。
public int hashCode() {
int keyHash = (key==null ? 0 : key.hashCode());
int valueHash = (value==null ? 0 : value.hashCode());
return keyHash ^ valueHash;
}
// 覆蓋toString()函數(shù)。
public String toString() {
return key + "=" + value;
}
}
// 返回“紅黑樹的第一個節(jié)點(diǎn)”
final Entry<K,V> getFirstEntry() {
Entry<K,V> p = root;
if (p != null)
while (p.left != null)
p = p.left;
return p;
}
// 返回“紅黑樹的最后一個節(jié)點(diǎn)”
final Entry<K,V> getLastEntry() {
Entry<K,V> p = root;
if (p != null)
while (p.right != null)
p = p.right;
return p;
}
// 返回“節(jié)點(diǎn)t的后繼節(jié)點(diǎn)”
static <K,V> TreeMap.Entry<K,V> successor(Entry<K,V> t) {
if (t == null)
return null;
else if (t.right != null) {
Entry<K,V> p = t.right;
while (p.left != null)
p = p.left;
return p;
} else {
Entry<K,V> p = t.parent;
Entry<K,V> ch = t;
while (p != null && ch == p.right) {
ch = p;
p = p.parent;
}
return p;
}
}
// 返回“節(jié)點(diǎn)t的前繼節(jié)點(diǎn)”
static <K,V> Entry<K,V> predecessor(Entry<K,V> t) {
if (t == null)
return null;
else if (t.left != null) {
Entry<K,V> p = t.left;
while (p.right != null)
p = p.right;
return p;
} else {
Entry<K,V> p = t.parent;
Entry<K,V> ch = t;
while (p != null && ch == p.left) {
ch = p;
p = p.parent;
}
return p;
}
}
// 返回“節(jié)點(diǎn)p的顏色”
// 根據(jù)“紅黑樹的特性”可知：空節(jié)點(diǎn)顏色是黑色。
private static <K,V> boolean colorOf(Entry<K,V> p) {
return (p == null ? BLACK : p.color);
}
// 返回“節(jié)點(diǎn)p的父節(jié)點(diǎn)”
private static <K,V> Entry<K,V> parentOf(Entry<K,V> p) {
return (p == null ? null: p.parent);
}
// 設(shè)置“節(jié)點(diǎn)p的顏色為c”
private static <K,V> void setColor(Entry<K,V> p, boolean c) {
if (p != null)
p.color = c;
}
// 設(shè)置“節(jié)點(diǎn)p的左孩子”
private static <K,V> Entry<K,V> leftOf(Entry<K,V> p) {
return (p == null) ? null: p.left;
}
// 設(shè)置“節(jié)點(diǎn)p的右孩子”
private static <K,V> Entry<K,V> rightOf(Entry<K,V> p) {
return (p == null) ? null: p.right;
}
// 對節(jié)點(diǎn)p執(zhí)行“左旋”操作
private void rotateLeft(Entry<K,V> p) {
if (p != null) {
Entry<K,V> r = p.right;
p.right = r.left;
if (r.left != null)
r.left.parent = p;
r.parent = p.parent;
if (p.parent == null)
root = r;
else if (p.parent.left == p)
p.parent.left = r;
else
p.parent.right = r;
r.left = p;
p.parent = r;
}
}
// 對節(jié)點(diǎn)p執(zhí)行“右旋”操作
private void rotateRight(Entry<K,V> p) {
if (p != null) {
Entry<K,V> l = p.left;
p.left = l.right;
if (l.right != null) l.right.parent = p;
l.parent = p.parent;
if (p.parent == null)
root = l;
else if (p.parent.right == p)
p.parent.right = l;
else p.parent.left = l;
l.right = p;
p.parent = l;
}
}
// 插入之后的修正操作蔼两。
// 目的是保證：紅黑樹插入節(jié)點(diǎn)之后妙啃，仍然是一顆紅黑樹
private void fixAfterInsertion(Entry<K,V> x) {
x.color = RED;
while (x != null && x != root && x.parent.color == RED) {
if (parentOf(x) == leftOf(parentOf(parentOf(x)))) {
Entry<K,V> y = rightOf(parentOf(parentOf(x)));
if (colorOf(y) == RED) {
setColor(parentOf(x), BLACK);
setColor(y, BLACK);
setColor(parentOf(parentOf(x)), RED);
x = parentOf(parentOf(x));
} else {
if (x == rightOf(parentOf(x))) {
x = parentOf(x);
rotateLeft(x);
}
setColor(parentOf(x), BLACK);
setColor(parentOf(parentOf(x)), RED);
rotateRight(parentOf(parentOf(x)));
}
} else {
Entry<K,V> y = leftOf(parentOf(parentOf(x)));
if (colorOf(y) == RED) {
setColor(parentOf(x), BLACK);
setColor(y, BLACK);
setColor(parentOf(parentOf(x)), RED);
x = parentOf(parentOf(x));
} else {
if (x == leftOf(parentOf(x))) {
x = parentOf(x);
rotateRight(x);
}
setColor(parentOf(x), BLACK);
setColor(parentOf(parentOf(x)), RED);
rotateLeft(parentOf(parentOf(x)));
}
}
}
root.color = BLACK;
}
// 刪除“紅黑樹的節(jié)點(diǎn)p”
private void deleteEntry(Entry<K,V> p) {
modCount++;
size--;
// If strictly internal, copy successor's element to p and then make p
// point to successor.
if (p.left != null && p.right != null) {
Entry<K,V> s = successor (p);
p.key = s.key;
p.value = s.value;
p = s;
} // p has 2 children
// Start fixup at replacement node, if it exists.
Entry<K,V> replacement = (p.left != null ? p.left : p.right);
if (replacement != null) {
// Link replacement to parent
replacement.parent = p.parent;
if (p.parent == null)
root = replacement;
else if (p == p.parent.left)
p.parent.left = replacement;
else
p.parent.right = replacement;
// Null out links so they are OK to use by fixAfterDeletion.
p.left = p.right = p.parent = null;
// Fix replacement
if (p.color == BLACK)
fixAfterDeletion(replacement);
} else if (p.parent == null) { // return if we are the only node.
root = null;
} else { // No children. Use self as phantom replacement and unlink.
if (p.color == BLACK)
fixAfterDeletion(p);
if (p.parent != null) {
if (p == p.parent.left)
p.parent.left = null;
else if (p == p.parent.right)
p.parent.right = null;
p.parent = null;
}
}
}
// 刪除之后的修正操作燥滑。
// 目的是保證：紅黑樹刪除節(jié)點(diǎn)之后，仍然是一顆紅黑樹
private void fixAfterDeletion(Entry<K,V> x) {
while (x != root && colorOf(x) == BLACK) {
if (x == leftOf(parentOf(x))) {
Entry<K,V> sib = rightOf(parentOf(x));
if (colorOf(sib) == RED) {
setColor(sib, BLACK);
setColor(parentOf(x), RED);
rotateLeft(parentOf(x));
sib = rightOf(parentOf(x));
}
if (colorOf(leftOf(sib)) == BLACK &&
colorOf(rightOf(sib)) == BLACK) {
setColor(sib, RED);
x = parentOf(x);
} else {
if (colorOf(rightOf(sib)) == BLACK) {
setColor(leftOf(sib), BLACK);
setColor(sib, RED);
rotateRight(sib);
sib = rightOf(parentOf(x));
}
setColor(sib, colorOf(parentOf(x)));
setColor(parentOf(x), BLACK);
setColor(rightOf(sib), BLACK);
rotateLeft(parentOf(x));
x = root;
}
} else { // symmetric
Entry<K,V> sib = leftOf(parentOf(x));
if (colorOf(sib) == RED) {
setColor(sib, BLACK);
setColor(parentOf(x), RED);
rotateRight(parentOf(x));
sib = leftOf(parentOf(x));
}
if (colorOf(rightOf(sib)) == BLACK &&
colorOf(leftOf(sib)) == BLACK) {
setColor(sib, RED);
x = parentOf(x);
} else {
if (colorOf(leftOf(sib)) == BLACK) {
setColor(rightOf(sib), BLACK);
setColor(sib, RED);
rotateLeft(sib);
sib = leftOf(parentOf(x));
}
setColor(sib, colorOf(parentOf(x)));
setColor(parentOf(x), BLACK);
setColor(leftOf(sib), BLACK);
rotateRight(parentOf(x));
x = root;
}
}
}
setColor(x, BLACK);
}
private static final long serialVersionUID = 919286545866124006L;
// java.io.Serializable的寫入函數(shù)
// 將TreeMap的“容量破托，所有的Entry”都寫入到輸出流中
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
// Write out the Comparator and any hidden stuff
s.defaultWriteObject();
// Write out size (number of Mappings)
s.writeInt(size);
// Write out keys and values (alternating)
for (Iterator<Map.Entry<K,V>> i = entrySet().iterator(); i.hasNext(); ) {
Map.Entry<K,V> e = i.next();
s.writeObject(e.getKey());
s.writeObject(e.getValue());
}
}
// java.io.Serializable的讀取函數(shù)：根據(jù)寫入方式讀出
// 先將TreeMap的“容量谜洽、所有的Entry”依次讀出
private void readObject(final java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in the Comparator and any hidden stuff
s.defaultReadObject();
// Read in size
int size = s.readInt();
buildFromSorted(size, null, s, null);
}
// 根據(jù)已經(jīng)一個排好序的map創(chuàng)建一個TreeMap
private void buildFromSorted(int size, Iterator it,
java.io.ObjectInputStream str,
V defaultVal)
throws java.io.IOException, ClassNotFoundException {
this.size = size;
root = buildFromSorted(0, 0, size-1, computeRedLevel(size),
it, str, defaultVal);
}
// 根據(jù)已經(jīng)一個排好序的map創(chuàng)建一個TreeMap
// 將map中的元素逐個添加到TreeMap中，并返回map的中間元素作為根節(jié)點(diǎn)。
private final Entry<K,V> buildFromSorted(int level, int lo, int hi,
int redLevel,
Iterator it,
java.io.ObjectInputStream str,
V defaultVal)
throws java.io.IOException, ClassNotFoundException {
if (hi < lo) return null;
// 獲取中間元素
int mid = (lo + hi) / 2;
Entry<K,V> left = null;
// 若lo小于mid，則遞歸調(diào)用獲取(middel的)左孩子。
if (lo < mid)
left = buildFromSorted(level+1, lo, mid - 1, redLevel,
it, str, defaultVal);
// 獲取middle節(jié)點(diǎn)對應(yīng)的key和value
K key;
V value;
if (it != null) {
if (defaultVal==null) {
Map.Entry<K,V> entry = (Map.Entry<K,V>)it.next();
key = entry.getKey();
value = entry.getValue();
} else {
key = (K)it.next();
value = defaultVal;
}
} else { // use stream
key = (K) str.readObject();
value = (defaultVal != null ? defaultVal : (V) str.readObject());
}
// 創(chuàng)建middle節(jié)點(diǎn)
Entry<K,V> middle = new Entry<K,V>(key, value, null);
// 若當(dāng)前節(jié)點(diǎn)的深度=紅色節(jié)點(diǎn)的深度，則將節(jié)點(diǎn)著色為紅色歹嘹。
if (level == redLevel)
middle.color = RED;
// 設(shè)置middle為left的父親圆到，left為middle的左孩子
if (left != null) {
middle.left = left;
left.parent = middle;
}
if (mid < hi) {
// 遞歸調(diào)用獲取(middel的)右孩子马绝。
Entry<K,V> right = buildFromSorted(level+1, mid+1, hi, redLevel,
it, str, defaultVal);
// 設(shè)置middle為left的父親权纤，left為middle的左孩子
middle.right = right;
right.parent = middle;
}
return middle;
}
// 計算節(jié)點(diǎn)樹為sz的最大深度踢故，也是紅色節(jié)點(diǎn)的深度值。
private static int computeRedLevel(int sz) {
int level = 0;
for (int m = sz - 1; m >= 0; m = m / 2 - 1)
level++;
return level;
}
}
說明:
在詳細(xì)介紹TreeMap的代碼之前元暴，我們先建立一個整體概念枢冤。
TreeMap是通過紅黑樹實(shí)現(xiàn)的讶迁，TreeMap存儲的是key-value鍵值對客扎，TreeMap的排序是基于對key的排序搀愧。
TreeMap提供了操作“key”、“key-value”、“value”等方法，也提供了對TreeMap這顆樹進(jìn)行整體操作的方法，如獲取子樹龄砰、反向樹。
后面的解說內(nèi)容分為幾部分,
首先，介紹TreeMap的核心，即紅黑樹相關(guān)部分鳖目；
然后碍沐，介紹TreeMap的主要函數(shù)尘喝；
再次无虚，介紹TreeMap實(shí)現(xiàn)的幾個接口嗤堰；
最后戈抄，補(bǔ)充介紹TreeMap的其它內(nèi)容输莺。
TreeMap本質(zhì)上是一顆紅黑樹崭捍。要徹底理解TreeMap实夹，建議讀者先理解紅黑樹匀们。關(guān)于紅黑樹的原理重抖，可以參考：紅黑樹(一) 原理和算法詳細(xì)介紹
第3.1部分 TreeMap的紅黑樹相關(guān)內(nèi)容
TreeMap中于紅黑樹相關(guān)的主要函數(shù)有:
1 數(shù)據(jù)結(jié)構(gòu)
1.1 紅黑樹的節(jié)點(diǎn)顏色--紅色
private static final boolean RED = false;
1.2 紅黑樹的節(jié)點(diǎn)顏色--黑色
private static final boolean BLACK = true;
1.3 “紅黑樹的節(jié)點(diǎn)”對應(yīng)的類局扶。
static final class Entry<K,V> implements Map.Entry<K,V> { ... }
Entry包含了6個部分內(nèi)容：key(鍵)、value(值)、left(左孩子)、right(右孩子)心肪、parent(父節(jié)點(diǎn))、color(顏色)
Entry節(jié)點(diǎn)根據(jù)key進(jìn)行排序锅减，Entry節(jié)點(diǎn)包含的內(nèi)容為value桦沉。
2 相關(guān)操作
2.1 左旋
private void rotateLeft(Entry<K,V> p) { ... }
2.2 右旋
private void rotateRight(Entry<K,V> p) { ... }
2.3 插入操作
public V put(K key, V value) { ... }
2.4 插入修正操作
紅黑樹執(zhí)行插入操作之后，要執(zhí)行“插入修正操作”。
目的是：保紅黑樹在進(jìn)行插入節(jié)點(diǎn)之后，仍然是一顆紅黑樹
private void fixAfterInsertion(Entry<K,V> x) { ... }
2.5 刪除操作
private void deleteEntry(Entry<K,V> p) { ... }
2.6 刪除修正操作
紅黑樹執(zhí)行刪除之后，要執(zhí)行“刪除修正操作”屠升。
目的是保證：紅黑樹刪除節(jié)點(diǎn)之后翰萨，仍然是一顆紅黑樹
private void fixAfterDeletion(Entry<K,V> x) { ... }
關(guān)于紅黑樹部分，這里主要是指出了TreeMap中那些是紅黑樹的主要相關(guān)內(nèi)容。具體的紅黑樹相關(guān)操作API筑煮，這里沒有詳細(xì)說明初澎，因?yàn)樗鼈儍H僅只是將算法翻譯成代碼卧檐。讀者可以參考“紅黑樹(一) 原理和算法詳細(xì)介紹”進(jìn)行了解捕仔。
第3.2部分 TreeMap的構(gòu)造函數(shù)
1 默認(rèn)構(gòu)造函數(shù)
使用默認(rèn)構(gòu)造函數(shù)構(gòu)造TreeMap時盅粪，使用java的默認(rèn)的比較器比較Key的大小，從而對TreeMap進(jìn)行排序。
public TreeMap() {
comparator = null;
}
2 帶比較器的構(gòu)造函數(shù)
public TreeMap(Comparator<? super K> comparator) {
this.comparator = comparator;
}
3 帶Map的構(gòu)造函數(shù)，Map會成為TreeMap的子集
public TreeMap(Map<? extends K, ? extends V> m) {
comparator = null;
putAll(m);
}
該構(gòu)造函數(shù)會調(diào)用putAll()將m中的所有元素添加到TreeMap中。putAll()源碼如下：
public void putAll(Map<? extends K, ? extends V> m) {
for (Map.Entry<? extends K, ? extends V> e : m.entrySet())
put(e.getKey(), e.getValue());
}
從中，我們可以看出putAll()就是將m中的key-value逐個的添加到TreeMap中宵晚。
4 帶SortedMap的構(gòu)造函數(shù)吱型，SortedMap會成為TreeMap的子集
public TreeMap(SortedMap<K, ? extends V> m) {
comparator = m.comparator();
try {
buildFromSorted(m.size(), m.entrySet().iterator(), null, null);
} catch (java.io.IOException cannotHappen) {
} catch (ClassNotFoundException cannotHappen) {
}
}
該構(gòu)造函數(shù)不同于上一個構(gòu)造函數(shù)，在上一個構(gòu)造函數(shù)中傳入的參數(shù)是Map咪鲜，Map不是有序的，所以要逐個添加撞鹉。
而該構(gòu)造函數(shù)的參數(shù)是SortedMap是一個有序的Map，我們通過buildFromSorted()來創(chuàng)建對應(yīng)的Map鸟雏。
buildFromSorted涉及到的代碼如下：
// 根據(jù)已經(jīng)一個排好序的map創(chuàng)建一個TreeMap
// 將map中的元素逐個添加到TreeMap中享郊，并返回map的中間元素作為根節(jié)點(diǎn)。
private final Entry<K,V> buildFromSorted(int level, int lo, int hi,
int redLevel,
Iterator it,
java.io.ObjectInputStream str,
V defaultVal)
throws java.io.IOException, ClassNotFoundException {
if (hi < lo) return null;
// 獲取中間元素
int mid = (lo + hi) / 2;
Entry<K,V> left = null;
// 若lo小于mid孝鹊，則遞歸調(diào)用獲取(middel的)左孩子炊琉。
if (lo < mid)
left = buildFromSorted(level+1, lo, mid - 1, redLevel,
it, str, defaultVal);
// 獲取middle節(jié)點(diǎn)對應(yīng)的key和value
K key;
V value;
if (it != null) {
if (defaultVal==null) {
Map.Entry<K,V> entry = (Map.Entry<K,V>)it.next();
key = entry.getKey();
value = entry.getValue();
} else {
key = (K)it.next();
value = defaultVal;
}
} else { // use stream
key = (K) str.readObject();
value = (defaultVal != null ? defaultVal : (V) str.readObject());
}
// 創(chuàng)建middle節(jié)點(diǎn)
Entry<K,V> middle = new Entry<K,V>(key, value, null);
// 若當(dāng)前節(jié)點(diǎn)的深度=紅色節(jié)點(diǎn)的深度，則將節(jié)點(diǎn)著色為紅色又活。
if (level == redLevel)
middle.color = RED;
// 設(shè)置middle為left的父親温自，left為middle的左孩子
if (left != null) {
middle.left = left;
left.parent = middle;
}
if (mid < hi) {
// 遞歸調(diào)用獲取(middel的)右孩子。
Entry<K,V> right = buildFromSorted(level+1, mid+1, hi, redLevel,
it, str, defaultVal);
// 設(shè)置middle為left的父親皇钞，left為middle的左孩子
middle.right = right;
right.parent = middle;
}
return middle;
}
要理解buildFromSorted悼泌，重點(diǎn)說明以下幾點(diǎn)：
第一，buildFromSorted是通過遞歸將SortedMap中的元素逐個關(guān)聯(lián)夹界。
第二馆里，buildFromSorted返回middle節(jié)點(diǎn)(中間節(jié)點(diǎn))作為root。
第三可柿，buildFromSorted添加到紅黑樹中時鸠踪，只將level == redLevel的節(jié)點(diǎn)設(shè)為紅色。第level級節(jié)點(diǎn)复斥，實(shí)際上是buildFromSorted轉(zhuǎn)換成紅黑樹后的最底端(假設(shè)根節(jié)點(diǎn)在最上方)的節(jié)點(diǎn)营密；只將紅黑樹最底端的階段著色為紅色，其余都是黑色目锭。
第3.3部分 TreeMap的Entry相關(guān)函數(shù)
TreeMap的 firstEntry()评汰、 lastEntry()纷捞、 lowerEntry()、 higherEntry()被去、 floorEntry()主儡、 ceilingEntry()、 pollFirstEntry() 惨缆、 pollLastEntry() 原理都是類似的糜值；下面以firstEntry()來進(jìn)行詳細(xì)說明
我們先看看firstEntry()和getFirstEntry()的代碼：
public Map.Entry<K,V> firstEntry() {
return exportEntry(getFirstEntry());
}
final Entry<K,V> getFirstEntry() {
Entry<K,V> p = root;
if (p != null)
while (p.left != null)
p = p.left;
return p;
}
從中，我們可以看出 firstEntry() 和 getFirstEntry() 都是用于獲取第一個節(jié)點(diǎn)坯墨。
但是寂汇，firstEntry() 是對外接口； getFirstEntry() 是內(nèi)部接口捣染。而且骄瓣，firstEntry() 是通過 getFirstEntry() 來實(shí)現(xiàn)的。那為什么外界不能直接調(diào)用 getFirstEntry()液斜，而需要多此一舉的調(diào)用 firstEntry() 呢?
先告訴大家原因累贤，再進(jìn)行詳細(xì)說明叠穆。這么做的目的是：防止用戶修改返回的Entry少漆。getFirstEntry()返回的Entry是可以被修改的，但是經(jīng)過firstEntry()返回的Entry不能被修改硼被，只可以讀取Entry的key值和value值示损。下面我們看看到底是如何實(shí)現(xiàn)的。
(01) getFirstEntry()返回的是Entry節(jié)點(diǎn)嚷硫，而Entry是紅黑樹的節(jié)點(diǎn)检访，它的源碼如下：
// 返回“紅黑樹的第一個節(jié)點(diǎn)”
final Entry<K,V> getFirstEntry() {
Entry<K,V> p = root;
if (p != null)
while (p.left != null)
p = p.left;
return p;
}
從中，我們可以調(diào)用Entry的getKey()仔掸、getValue()來獲取key和value值脆贵，以及調(diào)用setValue()來修改value的值。
(02) firstEntry()返回的是exportEntry(getFirstEntry())起暮。下面我們看看exportEntry()干了些什么卖氨？
static <K,V> Map.Entry<K,V> exportEntry(TreeMap.Entry<K,V> e) {
return e == null? null :
new AbstractMap.SimpleImmutableEntry<K,V>(e);
}
實(shí)際上，exportEntry() 是新建一個AbstractMap.SimpleImmutableEntry類型的對象负懦，并返回筒捺。
SimpleImmutableEntry的實(shí)現(xiàn)在AbstractMap.java中，下面我們看看AbstractMap.SimpleImmutableEntry是如何實(shí)現(xiàn)的纸厉，代碼如下：
public static class SimpleImmutableEntry<K,V>
implements Entry<K,V>, java.io.Serializable
{
private static final long serialVersionUID = 7138329143949025153L;
private final K key;
private final V value;
public SimpleImmutableEntry(K key, V value) {
this.key = key;
this.value = value;
}
public SimpleImmutableEntry(Entry<? extends K, ? extends V> entry) {
this.key = entry.getKey();
this.value = entry.getValue();
}
public K getKey() {
return key;
}
public V getValue() {
return value;
}
public V setValue(V value) {
throw new UnsupportedOperationException();
}
public boolean equals(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry e = (Map.Entry)o;
return eq(key, e.getKey()) && eq(value, e.getValue());
}
public int hashCode() {
return (key == null ? 0 : key.hashCode()) ^
(value == null ? 0 : value.hashCode());
}
public String toString() {
return key + "=" + value;
}
}
從中系吭，我們可以看出SimpleImmutableEntry實(shí)際上是簡化的key-value節(jié)點(diǎn)。
它只提供了getKey()颗品、getValue()方法類獲取節(jié)點(diǎn)的值肯尺；但不能修改value的值沃缘，因?yàn)檎{(diào)用 setValue() 會拋出異常UnsupportedOperationException();
再回到我們之前的問題：那為什么外界不能直接調(diào)用 getFirstEntry()，而需要多此一舉的調(diào)用 firstEntry() 呢?
現(xiàn)在我們清晰的了解到：
(01) firstEntry()是對外接口蟆盹，而getFirstEntry()是內(nèi)部接口孩灯。
(02) 對firstEntry()返回的Entry對象只能進(jìn)行g(shù)etKey()、getValue()等讀取操作逾滥；而對getFirstEntry()返回的對象除了可以進(jìn)行讀取操作之后峰档，還可以通過setValue()修改值。
第3.4部分 TreeMap的key相關(guān)函數(shù)
TreeMap的firstKey()寨昙、lastKey()讥巡、lowerKey()、higherKey()舔哪、floorKey()欢顷、ceilingKey()原理都是類似的；下面以ceilingKey()來進(jìn)行詳細(xì)說明
ceilingKey(K key)的作用是“返回大于/等于key的最小的鍵值對所對應(yīng)的KEY捉蚤，沒有的話返回null”抬驴，它的代碼如下：
public K ceilingKey(K key) {
return keyOrNull(getCeilingEntry(key));
}
ceilingKey()是通過getCeilingEntry()實(shí)現(xiàn)的。keyOrNull()的代碼很簡單缆巧，它是獲取節(jié)點(diǎn)的key布持，沒有的話，返回null陕悬。
static <K,V> K keyOrNull(TreeMap.Entry<K,V> e) {
return e == null? null : e.key;
}
getCeilingEntry(K key)的作用是“獲取TreeMap中大于/等于key的最小的節(jié)點(diǎn)题暖，若不存在(即TreeMap中所有節(jié)點(diǎn)的鍵都比key大)，就返回null”捉超。它的實(shí)現(xiàn)代碼如下：
final Entry<K,V> getCeilingEntry(K key) {
Entry<K,V> p = root;
while (p != null) {
int cmp = compare(key, p.key);
// 情況一：若“p的key” > key胧卤。
// 若 p 存在左孩子，則設(shè) p=“p的左孩子”拼岳；
// 否則枝誊，返回p
if (cmp < 0) {
if (p.left != null)
p = p.left;
else
return p;
// 情況二：若“p的key” < key。
} else if (cmp > 0) {
// 若 p 存在右孩子惜纸，則設(shè) p=“p的右孩子”
if (p.right != null) {
p = p.right;
} else {
// 若 p 不存在右孩子叶撒，則找出 p 的后繼節(jié)點(diǎn)，并返回
// 注意：這里返回的 “p的后繼節(jié)點(diǎn)”有2種可能性：第一堪簿，null痊乾；第二，TreeMap中大于key的最小的節(jié)點(diǎn)椭更。
// 理解這一點(diǎn)的核心是哪审，getCeilingEntry是從root開始遍歷的。
// 若getCeilingEntry能走到這一步虑瀑，那么湿滓，它之前“已經(jīng)遍歷過的節(jié)點(diǎn)的key”都 > key滴须。
// 能理解上面所說的，那么就很容易明白叽奥，為什么“p的后繼節(jié)點(diǎn)”有2種可能性了扔水。
Entry<K,V> parent = p.parent;
Entry<K,V> ch = p;
while (parent != null && ch == parent.right) {
ch = parent;
parent = parent.parent;
}
return parent;
}
// 情況三：若“p的key” = key。
} else
return p;
}
return null;
}
第3.5部分 TreeMap的values()函數(shù)
values() 返回“TreeMap中值的集合”
values()的實(shí)現(xiàn)代碼如下：
public Collection<V> values() {
Collection<V> vs = values;
return (vs != null) ? vs : (values = new Values());
}
說明：從中朝氓，我們可以發(fā)現(xiàn)values()是通過 new Values() 來實(shí)現(xiàn) “返回TreeMap中值的集合”魔市。
那么Values()是如何實(shí)現(xiàn)的呢？ 沒錯赵哲！由于返回的是值的集合待德，那么Values()肯定返回一個集合；而Values()正好是集合類Value的構(gòu)造函數(shù)枫夺。Values繼承于AbstractCollection将宪，它的代碼如下：
// ”TreeMap的值的集合“對應(yīng)的類，它集成于AbstractCollection
class Values extends AbstractCollection<V> {
// 返回迭代器
public Iterator<V> iterator() {
return new ValueIterator(getFirstEntry());
}
// 返回個數(shù)
public int size() {
return TreeMap.this.size();
}
// "TreeMap的值的集合"中是否包含"對象o"
public boolean contains(Object o) {
return TreeMap.this.containsValue(o);
}
// 刪除"TreeMap的值的集合"中的"對象o"
public boolean remove(Object o) {
for (Entry<K,V> e = getFirstEntry(); e != null; e = successor(e)) {
if (valEquals(e.getValue(), o)) {
deleteEntry(e);
return true;
}
}
return false;
}
// 清空刪除"TreeMap的值的集合"
public void clear() {
TreeMap.this.clear();
}
}
說明：從中橡庞，我們可以知道Values類就是一個集合较坛。而 AbstractCollection 實(shí)現(xiàn)了除 size() 和 iterator() 之外的其它函數(shù)，因此只需要在Values類中實(shí)現(xiàn)這兩個函數(shù)即可扒最。
size() 的實(shí)現(xiàn)非常簡單丑勤，Values集合中元素的個數(shù)=該TreeMap的元素個數(shù)。(TreeMap每一個元素都有一個值嘛扼倘！)
iterator() 則返回一個迭代器确封，用于遍歷Values除呵。下面再菊，我們一起可以看看iterator()的實(shí)現(xiàn)：
public Iterator<V> iterator() {
return new ValueIterator(getFirstEntry());
}
說明： iterator() 是通過ValueIterator() 返回迭代器的，ValueIterator是一個類颜曾。代碼如下：
final class ValueIterator extends PrivateEntryIterator<V> {
ValueIterator(Entry<K,V> first) {
super(first);
}
public V next() {
return nextEntry().value;
}
}
說明：ValueIterator的代碼很簡單纠拔，它的主要實(shí)現(xiàn)應(yīng)該在它的父類PrivateEntryIterator中。下面我們一起看看PrivateEntryIterator的代碼：
abstract class PrivateEntryIterator<T> implements Iterator<T> {
// 下一節(jié)點(diǎn)
Entry<K,V> next;
// 上一次返回的節(jié)點(diǎn)
Entry<K,V> lastReturned;
// 修改次數(shù)統(tǒng)計數(shù)
int expectedModCount;
PrivateEntryIterator(Entry<K,V> first) {
expectedModCount = modCount;
lastReturned = null;
next = first;
}
// 是否存在下一個節(jié)點(diǎn)
public final boolean hasNext() {
return next != null;
}
// 返回下一個節(jié)點(diǎn)
final Entry<K,V> nextEntry() {
Entry<K,V> e = next;
if (e == null)
throw new NoSuchElementException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
next = successor(e);
lastReturned = e;
return e;
}
// 返回上一節(jié)點(diǎn)
final Entry<K,V> prevEntry() {
Entry<K,V> e = next;
if (e == null)
throw new NoSuchElementException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
next = predecessor(e);
lastReturned = e;
return e;
}
// 刪除當(dāng)前節(jié)點(diǎn)
public void remove() {
if (lastReturned == null)
throw new IllegalStateException();
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
// deleted entries are replaced by their successors
if (lastReturned.left != null && lastReturned.right != null)
next = lastReturned;
deleteEntry(lastReturned);
expectedModCount = modCount;
lastReturned = null;
}
}
說明：PrivateEntryIterator是一個抽象類泛豪，它的實(shí)現(xiàn)很簡單稠诲，只只實(shí)現(xiàn)了Iterator的remove()和hasNext()接口，沒有實(shí)現(xiàn)next()接口诡曙。
而我們在ValueIterator中已經(jīng)實(shí)現(xiàn)的next()接口臀叙。
至此，我們就了解了iterator()的完整實(shí)現(xiàn)了价卤。
第3.6部分 TreeMap的entrySet()函數(shù)
entrySet() 返回“鍵值對集合”劝萤。顧名思義，它返回的是一個集合慎璧，集合的元素是“鍵值對”床嫌。
下面跨释，我們看看它是如何實(shí)現(xiàn)的？entrySet() 的實(shí)現(xiàn)代碼如下：
public Set<Map.Entry<K,V>> entrySet() {
EntrySet es = entrySet;
return (es != null) ? es : (entrySet = new EntrySet());
}
說明：entrySet()返回的是一個EntrySet對象厌处。
下面我們看看EntrySet的代碼：
// EntrySet是“TreeMap的所有鍵值對組成的集合”鳖谈，
// EntrySet集合的單位是單個“鍵值對”。
class EntrySet extends AbstractSet<Map.Entry<K,V>> {
public Iterator<Map.Entry<K,V>> iterator() {
return new EntryIterator(getFirstEntry());
}
// EntrySet中是否包含“鍵值對Object”
public boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
V value = entry.getValue();
Entry<K,V> p = getEntry(entry.getKey());
return p != null && valEquals(p.getValue(), value);
}
// 刪除EntrySet中的“鍵值對Object”
public boolean remove(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
V value = entry.getValue();
Entry<K,V> p = getEntry(entry.getKey());
if (p != null && valEquals(p.getValue(), value)) {
deleteEntry(p);
return true;
}
return false;
}
// 返回EntrySet中元素個數(shù)
public int size() {
return TreeMap.this.size();
}
// 清空EntrySet
public void clear() {
TreeMap.this.clear();
}
}
說明：
EntrySet是“TreeMap的所有鍵值對組成的集合”阔涉，而且它單位是單個“鍵值對”缆娃。
EntrySet是一個集合，它繼承于AbstractSet瑰排。而AbstractSet實(shí)現(xiàn)了除size() 和 iterator() 之外的其它函數(shù)龄恋，因此，我們重點(diǎn)了解一下EntrySet的size() 和 iterator() 函數(shù)
size() 的實(shí)現(xiàn)非常簡單凶伙，AbstractSet集合中元素的個數(shù)=該TreeMap的元素個數(shù)郭毕。
iterator() 則返回一個迭代器，用于遍歷AbstractSet函荣。從上面的源碼中显押，我們可以發(fā)現(xiàn)iterator() 是通過EntryIterator實(shí)現(xiàn)的；下面我們看看EntryIterator的源碼：
final class EntryIterator extends PrivateEntryIterator<Map.Entry<K,V>> {
EntryIterator(Entry<K,V> first) {
super(first);
}
public Map.Entry<K,V> next() {
return nextEntry();
}
}
說明：和Values類一樣傻挂，EntryIterator也繼承于PrivateEntryIterator類乘碑。
第3.7部分 TreeMap實(shí)現(xiàn)的Cloneable接口
TreeMap實(shí)現(xiàn)了Cloneable接口，即實(shí)現(xiàn)了clone()方法金拒。
clone()方法的作用很簡單兽肤，就是克隆一個TreeMap對象并返回。
// 克隆一個TreeMap绪抛，并返回Object對象
public Object clone() {
TreeMap<K,V> clone = null;
try {
clone = (TreeMap<K,V>) super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError();
}
// Put clone into "virgin" state (except for comparator)
clone.root = null;
clone.size = 0;
clone.modCount = 0;
clone.entrySet = null;
clone.navigableKeySet = null;
clone.descendingMap = null;
// Initialize clone with our mappings
try {
clone.buildFromSorted(size, entrySet().iterator(), null, null);
} catch (java.io.IOException cannotHappen) {
} catch (ClassNotFoundException cannotHappen) {
}
return clone;
}
第3.8部分 TreeMap實(shí)現(xiàn)的Serializable接口
TreeMap實(shí)現(xiàn)java.io.Serializable资铡，分別實(shí)現(xiàn)了串行讀取、寫入功能幢码。
串行寫入函數(shù)是writeObject()笤休，它的作用是將TreeMap的“容量，所有的Entry”都寫入到輸出流中症副。
而串行讀取函數(shù)是readObject()店雅，它的作用是將TreeMap的“容量、所有的Entry”依次讀出贞铣。
readObject() 和 writeObject() 正好是一對闹啦，通過它們，我能實(shí)現(xiàn)TreeMap的串行傳輸辕坝。
// java.io.Serializable的寫入函數(shù)
// 將TreeMap的“容量窍奋，所有的Entry”都寫入到輸出流中
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
// Write out the Comparator and any hidden stuff
s.defaultWriteObject();
// Write out size (number of Mappings)
s.writeInt(size);
// Write out keys and values (alternating)
for (Iterator<Map.Entry<K,V>> i = entrySet().iterator(); i.hasNext(); ) {
Map.Entry<K,V> e = i.next();
s.writeObject(e.getKey());
s.writeObject(e.getValue());
}
}
// java.io.Serializable的讀取函數(shù)：根據(jù)寫入方式讀出
// 先將TreeMap的“容量、所有的Entry”依次讀出
private void readObject(final java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in the Comparator and any hidden stuff
s.defaultReadObject();
// Read in size
int size = s.readInt();
buildFromSorted(size, null, s, null);
}
說到這里，就順便說一下“關(guān)鍵字transient”的作用
transient是Java語言的關(guān)鍵字费变，它被用來表示一個域不是該對象串行化的一部分摧扇。
Java的serialization提供了一種持久化對象實(shí)例的機(jī)制。當(dāng)持久化對象時挚歧，可能有一個特殊的對象數(shù)據(jù)成員扛稽，我們不想用serialization機(jī)制來保存它。為了在一個特定對象的一個域上關(guān)閉serialization，可以在這個域前加上關(guān)鍵字transient。
當(dāng)一個對象被串行化的時候叛薯，transient型變量的值不包括在串行化的表示中，然而非transient型的變量是被包括進(jìn)去的帮匾。
第3.9部分 TreeMap實(shí)現(xiàn)的NavigableMap接口
firstKey()、lastKey()痴鳄、lowerKey()瘟斜、higherKey()、ceilingKey()痪寻、floorKey();
firstEntry()螺句、 lastEntry()、 lowerEntry()橡类、 higherEntry()蛇尚、 floorEntry()、 ceilingEntry()顾画、 pollFirstEntry() 取劫、 pollLastEntry();
上面已經(jīng)講解過這些API了，下面對其它的API進(jìn)行說明研侣。
1 反向TreeMap
descendingMap() 的作用是返回當(dāng)前TreeMap的反向的TreeMap谱邪。所謂反向，就是排序順序和原始的順序相反义辕。
我們已經(jīng)知道TreeMap是一顆紅黑樹虾标，而紅黑樹是有序的寓盗。
TreeMap的排序方式是通過比較器灌砖，在創(chuàng)建TreeMap的時候，若指定了比較器傀蚌，則使用該比較器基显；否則，就使用Java的默認(rèn)比較器善炫。
而獲取TreeMap的反向TreeMap的原理就是將比較器反向即可撩幽！
理解了descendingMap()的反向原理之后，再講解一下descendingMap()的代碼。
// 獲取TreeMap的降序Map
public NavigableMap<K, V> descendingMap() {
NavigableMap<K, V> km = descendingMap;
return (km != null) ? km :
(descendingMap = new DescendingSubMap(this,
true, null, true,
true, null, true));
}
從中窜醉，我們看出descendingMap()實(shí)際上是返回DescendingSubMap類的對象宪萄。下面，看看DescendingSubMap的源碼：
static final class DescendingSubMap<K,V> extends NavigableSubMap<K,V> {
private static final long serialVersionUID = 912986545866120460L;
DescendingSubMap(TreeMap<K,V> m,
boolean fromStart, K lo, boolean loInclusive,
boolean toEnd, K hi, boolean hiInclusive) {
super(m, fromStart, lo, loInclusive, toEnd, hi, hiInclusive);
}
// 反轉(zhuǎn)的比較器：是將原始比較器反轉(zhuǎn)得到的榨惰。
private final Comparator<? super K> reverseComparator =
Collections.reverseOrder(m.comparator);
// 獲取反轉(zhuǎn)比較器
public Comparator<? super K> comparator() {
return reverseComparator;
}
// 獲取“子Map”拜英。
// 范圍是從fromKey 到 toKey；fromInclusive是是否包含fromKey的標(biāo)記琅催，toInclusive是是否包含toKey的標(biāo)記
public NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive,
K toKey, boolean toInclusive) {
if (!inRange(fromKey, fromInclusive))
throw new IllegalArgumentException("fromKey out of range");
if (!inRange(toKey, toInclusive))
throw new IllegalArgumentException("toKey out of range");
return new DescendingSubMap(m,
false, toKey, toInclusive,
false, fromKey, fromInclusive);
}
// 獲取“Map的頭部”居凶。
// 范圍從第一個節(jié)點(diǎn) 到 toKey, inclusive是是否包含toKey的標(biāo)記
public NavigableMap<K,V> headMap(K toKey, boolean inclusive) {
if (!inRange(toKey, inclusive))
throw new IllegalArgumentException("toKey out of range");
return new DescendingSubMap(m,
false, toKey, inclusive,
toEnd, hi, hiInclusive);
}
// 獲取“Map的尾部”。
// 范圍是從 fromKey 到 最后一個節(jié)點(diǎn)藤抡，inclusive是是否包含fromKey的標(biāo)記
public NavigableMap<K,V> tailMap(K fromKey, boolean inclusive){
if (!inRange(fromKey, inclusive))
throw new IllegalArgumentException("fromKey out of range");
return new DescendingSubMap(m,
fromStart, lo, loInclusive,
false, fromKey, inclusive);
}
// 獲取對應(yīng)的降序Map
public NavigableMap<K,V> descendingMap() {
NavigableMap<K,V> mv = descendingMapView;
return (mv != null) ? mv :
(descendingMapView =
new AscendingSubMap(m,
fromStart, lo, loInclusive,
toEnd, hi, hiInclusive));
}
// 返回“升序Key迭代器”
Iterator<K> keyIterator() {
return new DescendingSubMapKeyIterator(absHighest(), absLowFence());
}
// 返回“降序Key迭代器”
Iterator<K> descendingKeyIterator() {
return new SubMapKeyIterator(absLowest(), absHighFence());
}
// “降序EntrySet集合”類
// 實(shí)現(xiàn)了iterator()
final class DescendingEntrySetView extends EntrySetView {
public Iterator<Map.Entry<K,V>> iterator() {
return new DescendingSubMapEntryIterator(absHighest(), absLowFence());
}
}
// 返回“降序EntrySet集合”
public Set<Map.Entry<K,V>> entrySet() {
EntrySetView es = entrySetView;
return (es != null) ? es : new DescendingEntrySetView();
}
TreeMap.Entry<K,V> subLowest() { return absHighest(); }
TreeMap.Entry<K,V> subHighest() { return absLowest(); }
TreeMap.Entry<K,V> subCeiling(K key) { return absFloor(key); }
TreeMap.Entry<K,V> subHigher(K key) { return absLower(key); }
TreeMap.Entry<K,V> subFloor(K key) { return absCeiling(key); }
TreeMap.Entry<K,V> subLower(K key) { return absHigher(key); }
}
從中侠碧，我們看出DescendingSubMap是降序的SubMap，它的實(shí)現(xiàn)機(jī)制是將“SubMap的比較器反轉(zhuǎn)”缠黍。
它繼承于NavigableSubMap弄兜。而NavigableSubMap是一個繼承于AbstractMap的抽象類；它包括2個子類——"(升序)AscendingSubMap"和"(降序)DescendingSubMap"瓷式。NavigableSubMap為它的兩個子類實(shí)現(xiàn)了許多公共API挨队。
下面看看NavigableSubMap的源碼。
static abstract class NavigableSubMap<K,V> extends AbstractMap<K,V>
implements NavigableMap<K,V>, java.io.Serializable {
// TreeMap的拷貝
final TreeMap<K,V> m;
// lo是“子Map范圍的最小值”蒿往，hi是“子Map范圍的最大值”盛垦；
// loInclusive是“是否包含lo的標(biāo)記”，hiInclusive是“是否包含hi的標(biāo)記”
// fromStart是“表示是否從第一個節(jié)點(diǎn)開始計算”瓤漏，
// toEnd是“表示是否計算到最后一個節(jié)點(diǎn) ”
final K lo, hi;
final boolean fromStart, toEnd;
final boolean loInclusive, hiInclusive;
// 構(gòu)造函數(shù)
NavigableSubMap(TreeMap<K,V> m,
boolean fromStart, K lo, boolean loInclusive,
boolean toEnd, K hi, boolean hiInclusive) {
if (!fromStart && !toEnd) {
if (m.compare(lo, hi) > 0)
throw new IllegalArgumentException("fromKey > toKey");
} else {
if (!fromStart) // type check
m.compare(lo, lo);
if (!toEnd)
m.compare(hi, hi);
}
this.m = m;
this.fromStart = fromStart;
this.lo = lo;
this.loInclusive = loInclusive;
this.toEnd = toEnd;
this.hi = hi;
this.hiInclusive = hiInclusive;
}
// 判斷key是否太小
final boolean tooLow(Object key) {
// 若該SubMap不包括“起始節(jié)點(diǎn)”腾夯，
// 并且，“key小于最小鍵(lo)”或者“key等于最小鍵(lo)蔬充，但最小鍵卻沒包括在該SubMap內(nèi)”
// 則判斷key太小蝶俱。其余情況都不是太小饥漫！
if (!fromStart) {
int c = m.compare(key, lo);
if (c < 0 || (c == 0 && !loInclusive))
return true;
}
return false;
}
// 判斷key是否太大
final boolean tooHigh(Object key) {
// 若該SubMap不包括“結(jié)束節(jié)點(diǎn)”榨呆，
// 并且，“key大于最大鍵(hi)”或者“key等于最大鍵(hi)庸队，但最大鍵卻沒包括在該SubMap內(nèi)”
// 則判斷key太大积蜻。其余情況都不是太大！
if (!toEnd) {
int c = m.compare(key, hi);
if (c > 0 || (c == 0 && !hiInclusive))
return true;
}
return false;
}
// 判斷key是否在“l(fā)o和hi”開區(qū)間范圍內(nèi)
final boolean inRange(Object key) {
return !tooLow(key) && !tooHigh(key);
}
// 判斷key是否在封閉區(qū)間內(nèi)
final boolean inClosedRange(Object key) {
return (fromStart || m.compare(key, lo) >= 0)
&& (toEnd || m.compare(hi, key) >= 0);
}
// 判斷key是否在區(qū)間內(nèi), inclusive是區(qū)間開關(guān)標(biāo)志
final boolean inRange(Object key, boolean inclusive) {
return inclusive ? inRange(key) : inClosedRange(key);
}
// 返回最低的Entry
final TreeMap.Entry<K,V> absLowest() {
// 若“包含起始節(jié)點(diǎn)”彻消，則調(diào)用getFirstEntry()返回第一個節(jié)點(diǎn)
// 否則的話竿拆，若包括lo，則調(diào)用getCeilingEntry(lo)獲取大于/等于lo的最小的Entry;
// 否則宾尚，調(diào)用getHigherEntry(lo)獲取大于lo的最小Entry
TreeMap.Entry<K,V> e =
(fromStart ? m.getFirstEntry() :
(loInclusive ? m.getCeilingEntry(lo) :
m.getHigherEntry(lo)));
return (e == null || tooHigh(e.key)) ? null : e;
}
// 返回最高的Entry
final TreeMap.Entry<K,V> absHighest() {
// 若“包含結(jié)束節(jié)點(diǎn)”丙笋，則調(diào)用getLastEntry()返回最后一個節(jié)點(diǎn)
// 否則的話谢澈，若包括hi，則調(diào)用getFloorEntry(hi)獲取小于/等于hi的最大的Entry;
// 否則御板，調(diào)用getLowerEntry(hi)獲取大于hi的最大Entry
TreeMap.Entry<K,V> e =
TreeMap.Entry<K,V> e =
(toEnd ? m.getLastEntry() :
(hiInclusive ? m.getFloorEntry(hi) :
m.getLowerEntry(hi)));
return (e == null || tooLow(e.key)) ? null : e;
}
// 返回"大于/等于key的最小的Entry"
final TreeMap.Entry<K,V> absCeiling(K key) {
// 只有在“key太小”的情況下锥忿，absLowest()返回的Entry才是“大于/等于key的最小Entry”
// 其它情況下不行。例如怠肋，當(dāng)包含“起始節(jié)點(diǎn)”時缎谷，absLowest()返回的是最小Entry了！
if (tooLow(key))
return absLowest();
// 獲取“大于/等于key的最小Entry”
TreeMap.Entry<K,V> e = m.getCeilingEntry(key);
return (e == null || tooHigh(e.key)) ? null : e;
}
// 返回"大于key的最小的Entry"
final TreeMap.Entry<K,V> absHigher(K key) {
// 只有在“key太小”的情況下灶似，absLowest()返回的Entry才是“大于key的最小Entry”
// 其它情況下不行列林。例如，當(dāng)包含“起始節(jié)點(diǎn)”時酪惭，absLowest()返回的是最小Entry了,而不一定是“大于key的最小Entry”希痴！
if (tooLow(key))
return absLowest();
// 獲取“大于key的最小Entry”
TreeMap.Entry<K,V> e = m.getHigherEntry(key);
return (e == null || tooHigh(e.key)) ? null : e;
}
// 返回"小于/等于key的最大的Entry"
final TreeMap.Entry<K,V> absFloor(K key) {
// 只有在“key太大”的情況下，(absHighest)返回的Entry才是“小于/等于key的最大Entry”
// 其它情況下不行春感。例如，當(dāng)包含“結(jié)束節(jié)點(diǎn)”時鲫懒，absHighest()返回的是最大Entry了嫩实！
if (tooHigh(key))
return absHighest();
// 獲取"小于/等于key的最大的Entry"
TreeMap.Entry<K,V> e = m.getFloorEntry(key);
return (e == null || tooLow(e.key)) ? null : e;
}
// 返回"小于key的最大的Entry"
final TreeMap.Entry<K,V> absLower(K key) {
// 只有在“key太大”的情況下，(absHighest)返回的Entry才是“小于key的最大Entry”
// 其它情況下不行窥岩。例如甲献，當(dāng)包含“結(jié)束節(jié)點(diǎn)”時，absHighest()返回的是最大Entry了,而不一定是“小于key的最大Entry”颂翼！
if (tooHigh(key))
return absHighest();
// 獲取"小于key的最大的Entry"
TreeMap.Entry<K,V> e = m.getLowerEntry(key);
return (e == null || tooLow(e.key)) ? null : e;
}
// 返回“大于最大節(jié)點(diǎn)中的最小節(jié)點(diǎn)”晃洒，不存在的話，返回null
final TreeMap.Entry<K,V> absHighFence() {
return (toEnd ? null : (hiInclusive ?
m.getHigherEntry(hi) :
m.getCeilingEntry(hi)));
}
// 返回“小于最小節(jié)點(diǎn)中的最大節(jié)點(diǎn)”朦乏，不存在的話球及，返回null
final TreeMap.Entry<K,V> absLowFence() {
return (fromStart ? null : (loInclusive ?
m.getLowerEntry(lo) :
m.getFloorEntry(lo)));
}
// 下面幾個abstract方法是需要NavigableSubMap的實(shí)現(xiàn)類實(shí)現(xiàn)的方法
abstract TreeMap.Entry<K,V> subLowest();
abstract TreeMap.Entry<K,V> subHighest();
abstract TreeMap.Entry<K,V> subCeiling(K key);
abstract TreeMap.Entry<K,V> subHigher(K key);
abstract TreeMap.Entry<K,V> subFloor(K key);
abstract TreeMap.Entry<K,V> subLower(K key);
// 返回“順序”的鍵迭代器
abstract Iterator<K> keyIterator();
// 返回“逆序”的鍵迭代器
abstract Iterator<K> descendingKeyIterator();
// 返回SubMap是否為空∩胝睿空的話吃引，返回true，否則返回false
public boolean isEmpty() {
return (fromStart && toEnd) ? m.isEmpty() : entrySet().isEmpty();
}
// 返回SubMap的大小
public int size() {
return (fromStart && toEnd) ? m.size() : entrySet().size();
}
// 返回SubMap是否包含鍵key
public final boolean containsKey(Object key) {
return inRange(key) && m.containsKey(key);
}
// 將key-value 插入SubMap中
public final V put(K key, V value) {
if (!inRange(key))
throw new IllegalArgumentException("key out of range");
return m.put(key, value);
}
// 獲取key對應(yīng)值
public final V get(Object key) {
return !inRange(key)? null : m.get(key);
}
// 刪除key對應(yīng)的鍵值對
public final V remove(Object key) {
return !inRange(key)? null : m.remove(key);
}
// 獲取“大于/等于key的最小鍵值對”
public final Map.Entry<K,V> ceilingEntry(K key) {
return exportEntry(subCeiling(key));
}
// 獲取“大于/等于key的最小鍵”
public final K ceilingKey(K key) {
return keyOrNull(subCeiling(key));
}
// 獲取“大于key的最小鍵值對”
public final Map.Entry<K,V> higherEntry(K key) {
return exportEntry(subHigher(key));
}
// 獲取“大于key的最小鍵”
public final K higherKey(K key) {
return keyOrNull(subHigher(key));
}
// 獲取“小于/等于key的最大鍵值對”
public final Map.Entry<K,V> floorEntry(K key) {
return exportEntry(subFloor(key));
}
// 獲取“小于/等于key的最大鍵”
public final K floorKey(K key) {
return keyOrNull(subFloor(key));
}
// 獲取“小于key的最大鍵值對”
public final Map.Entry<K,V> lowerEntry(K key) {
return exportEntry(subLower(key));
}
// 獲取“小于key的最大鍵”
public final K lowerKey(K key) {
return keyOrNull(subLower(key));
}
// 獲取"SubMap的第一個鍵"
public final K firstKey() {
return key(subLowest());
}
// 獲取"SubMap的最后一個鍵"
public final K lastKey() {
return key(subHighest());
}
// 獲取"SubMap的第一個鍵值對"
public final Map.Entry<K,V> firstEntry() {
return exportEntry(subLowest());
}
// 獲取"SubMap的最后一個鍵值對"
public final Map.Entry<K,V> lastEntry() {
return exportEntry(subHighest());
}
// 返回"SubMap的第一個鍵值對"刽锤，并從SubMap中刪除改鍵值對
public final Map.Entry<K,V> pollFirstEntry() {
TreeMap.Entry<K,V> e = subLowest();
Map.Entry<K,V> result = exportEntry(e);
if (e != null)
m.deleteEntry(e);
return result;
}
// 返回"SubMap的最后一個鍵值對"镊尺，并從SubMap中刪除改鍵值對
public final Map.Entry<K,V> pollLastEntry() {
TreeMap.Entry<K,V> e = subHighest();
Map.Entry<K,V> result = exportEntry(e);
if (e != null)
m.deleteEntry(e);
return result;
}
// Views
transient NavigableMap<K,V> descendingMapView = null;
transient EntrySetView entrySetView = null;
transient KeySet<K> navigableKeySetView = null;
// 返回NavigableSet對象，實(shí)際上返回的是當(dāng)前對象的"Key集合"姑蓝。
public final NavigableSet<K> navigableKeySet() {
KeySet<K> nksv = navigableKeySetView;
return (nksv != null) ? nksv :
(navigableKeySetView = new TreeMap.KeySet(this));
}
// 返回"Key集合"對象
public final Set<K> keySet() {
return navigableKeySet();
}
// 返回“逆序”的Key集合
public NavigableSet<K> descendingKeySet() {
return descendingMap().navigableKeySet();
}
// 排列fromKey(包含) 到 toKey(不包含) 的子map
public final SortedMap<K,V> subMap(K fromKey, K toKey) {
return subMap(fromKey, true, toKey, false);
}
// 返回當(dāng)前Map的頭部(從第一個節(jié)點(diǎn) 到 toKey, 不包括toKey)
public final SortedMap<K,V> headMap(K toKey) {
return headMap(toKey, false);
}
// 返回當(dāng)前Map的尾部[從 fromKey(包括fromKeyKey) 到 最后一個節(jié)點(diǎn)]
public final SortedMap<K,V> tailMap(K fromKey) {
return tailMap(fromKey, true);
}
// Map的Entry的集合
abstract class EntrySetView extends AbstractSet<Map.Entry<K,V>> {
private transient int size = -1, sizeModCount;
// 獲取EntrySet的大小
public int size() {
// 若SubMap是從“開始節(jié)點(diǎn)”到“結(jié)尾節(jié)點(diǎn)”鹅心，則SubMap大小就是原TreeMap的大小
if (fromStart && toEnd)
return m.size();
// 若SubMap不是從“開始節(jié)點(diǎn)”到“結(jié)尾節(jié)點(diǎn)”，則調(diào)用iterator()遍歷EntrySetView中的元素
if (size == -1 || sizeModCount != m.modCount) {
sizeModCount = m.modCount;
size = 0;
Iterator i = iterator();
while (i.hasNext()) {
size++;
i.next();
}
}
return size;
}
// 判斷EntrySetView是否為空
public boolean isEmpty() {
TreeMap.Entry<K,V> n = absLowest();
return n == null || tooHigh(n.key);
}
// 判斷EntrySetView是否包含Object
public boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
K key = entry.getKey();
if (!inRange(key))
return false;
TreeMap.Entry node = m.getEntry(key);
return node != null &&
valEquals(node.getValue(), entry.getValue());
}
// 從EntrySetView中刪除Object
public boolean remove(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
K key = entry.getKey();
if (!inRange(key))
return false;
TreeMap.Entry<K,V> node = m.getEntry(key);
if (node!=null && valEquals(node.getValue(),entry.getValue())){
m.deleteEntry(node);
return true;
}
return false;
}
}
// SubMap的迭代器
abstract class SubMapIterator<T> implements Iterator<T> {
// 上一次被返回的Entry
TreeMap.Entry<K,V> lastReturned;
// 指向下一個Entry
TreeMap.Entry<K,V> next;
// “柵欄key”纺荧。根據(jù)SubMap是“升序”還是“降序”具有不同的意義
final K fenceKey;
int expectedModCount;
// 構(gòu)造函數(shù)
SubMapIterator(TreeMap.Entry<K,V> first,
TreeMap.Entry<K,V> fence) {
// 每創(chuàng)建一個SubMapIterator時，保存修改次數(shù)
// 若后面發(fā)現(xiàn)expectedModCount和modCount不相等，則拋出ConcurrentModificationException異常宙暇。
// 這就是所說的fast-fail機(jī)制的原理输枯！
expectedModCount = m.modCount;
lastReturned = null;
next = first;
fenceKey = fence == null ? null : fence.key;
}
// 是否存在下一個Entry
public final boolean hasNext() {
return next != null && next.key != fenceKey;
}
// 返回下一個Entry
final TreeMap.Entry<K,V> nextEntry() {
TreeMap.Entry<K,V> e = next;
if (e == null || e.key == fenceKey)
throw new NoSuchElementException();
if (m.modCount != expectedModCount)
throw new ConcurrentModificationException();
// next指向e的后繼節(jié)點(diǎn)
next = successor(e);
lastReturned = e;
return e;
}
// 返回上一個Entry
final TreeMap.Entry<K,V> prevEntry() {
TreeMap.Entry<K,V> e = next;
if (e == null || e.key == fenceKey)
throw new NoSuchElementException();
if (m.modCount != expectedModCount)
throw new ConcurrentModificationException();
// next指向e的前繼節(jié)點(diǎn)
next = predecessor(e);
lastReturned = e;
return e;
}
// 刪除當(dāng)前節(jié)點(diǎn)(用于“升序的SubMap”)。
// 刪除之后占贫，可以繼續(xù)升序遍歷桃熄；紅黑樹特性沒變。
final void removeAscending() {
if (lastReturned == null)
throw new IllegalStateException();
if (m.modCount != expectedModCount)
throw new ConcurrentModificationException();
// 這里重點(diǎn)強(qiáng)調(diào)一下“為什么當(dāng)lastReturned的左右孩子都不為空時型奥，要將其賦值給next”瞳收。
// 目的是為了“刪除lastReturned節(jié)點(diǎn)之后，next節(jié)點(diǎn)指向的仍然是下一個節(jié)點(diǎn)”厢汹。
// 根據(jù)“紅黑樹”的特性可知：
// 當(dāng)被刪除節(jié)點(diǎn)有兩個兒子時螟深。那么，首先把“它的后繼節(jié)點(diǎn)的內(nèi)容”復(fù)制給“該節(jié)點(diǎn)的內(nèi)容”烫葬；之后界弧，刪除“它的后繼節(jié)點(diǎn)”。
// 這意味著“當(dāng)被刪除節(jié)點(diǎn)有兩個兒子時搭综，刪除當(dāng)前節(jié)點(diǎn)之后垢箕，'新的當(dāng)前節(jié)點(diǎn)'實(shí)際上是‘原有的后繼節(jié)點(diǎn)(即下一個節(jié)點(diǎn))’”。
// 而此時next仍然指向"新的當(dāng)前節(jié)點(diǎn)"兑巾。也就是說next是仍然是指向下一個節(jié)點(diǎn)条获；能繼續(xù)遍歷紅黑樹。
if (lastReturned.left != null && lastReturned.right != null)
next = lastReturned;
m.deleteEntry(lastReturned);
lastReturned = null;
expectedModCount = m.modCount;
}
// 刪除當(dāng)前節(jié)點(diǎn)(用于“降序的SubMap”)蒋歌。
// 刪除之后月匣，可以繼續(xù)降序遍歷；紅黑樹特性沒變奋姿。
final void removeDescending() {
if (lastReturned == null)
throw new IllegalStateException();
if (m.modCount != expectedModCount)
throw new ConcurrentModificationException();
m.deleteEntry(lastReturned);
lastReturned = null;
expectedModCount = m.modCount;
}
}
// SubMap的Entry迭代器锄开，它只支持升序操作，繼承于SubMapIterator
final class SubMapEntryIterator extends SubMapIterator<Map.Entry<K,V>> {
SubMapEntryIterator(TreeMap.Entry<K,V> first,
TreeMap.Entry<K,V> fence) {
super(first, fence);
}
// 獲取下一個節(jié)點(diǎn)(升序)
public Map.Entry<K,V> next() {
return nextEntry();
}
// 刪除當(dāng)前節(jié)點(diǎn)(升序)
public void remove() {
removeAscending();
}
}
// SubMap的Key迭代器称诗，它只支持升序操作萍悴，繼承于SubMapIterator
final class SubMapKeyIterator extends SubMapIterator<K> {
SubMapKeyIterator(TreeMap.Entry<K,V> first,
TreeMap.Entry<K,V> fence) {
super(first, fence);
}
// 獲取下一個節(jié)點(diǎn)(升序)
public K next() {
return nextEntry().key;
}
// 刪除當(dāng)前節(jié)點(diǎn)(升序)
public void remove() {
removeAscending();
}
}
// 降序SubMap的Entry迭代器，它只支持降序操作寓免，繼承于SubMapIterator
final class DescendingSubMapEntryIterator extends SubMapIterator<Map.Entry<K,V>> {
DescendingSubMapEntryIterator(TreeMap.Entry<K,V> last,
TreeMap.Entry<K,V> fence) {
super(last, fence);
}
// 獲取下一個節(jié)點(diǎn)(降序)
public Map.Entry<K,V> next() {
return prevEntry();
}
// 刪除當(dāng)前節(jié)點(diǎn)(降序)
public void remove() {
removeDescending();
}
}
// 降序SubMap的Key迭代器癣诱，它只支持降序操作，繼承于SubMapIterator
final class DescendingSubMapKeyIterator extends SubMapIterator<K> {
DescendingSubMapKeyIterator(TreeMap.Entry<K,V> last,
TreeMap.Entry<K,V> fence) {
super(last, fence);
}
// 獲取下一個節(jié)點(diǎn)(降序)
public K next() {
return prevEntry().key;
}
// 刪除當(dāng)前節(jié)點(diǎn)(降序)
public void remove() {
removeDescending();
}
}
}
NavigableSubMap源碼很多袜香，但不難理解撕予；讀者可以通過源碼和注釋進(jìn)行理解。
其實(shí)蜈首，讀完NavigableSubMap的源碼后实抡，我們可以得出它的核心思想是：它是一個抽象集合類欠母，為2個子類——"(升序)AscendingSubMap"和"(降序)DescendingSubMap"而服務(wù)；因?yàn)镹avigableSubMap實(shí)現(xiàn)了許多公共API吆寨。它的最終目的是實(shí)現(xiàn)下面的一系列函數(shù)：
headMap(K toKey, boolean inclusive)
headMap(K toKey)
subMap(K fromKey, K toKey)
subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
tailMap(K fromKey)
tailMap(K fromKey, boolean inclusive)
navigableKeySet()
descendingKeySet()
第3.10部分 TreeMap其它函數(shù)
1 順序遍歷和逆序遍歷
TreeMap的順序遍歷和逆序遍歷原理非常簡單赏淌。
由于TreeMap中的元素是從小到大的順序排列的。因此啄清，順序遍歷六水，就是從第一個元素開始，逐個向后遍歷辣卒；而倒序遍歷則恰恰相反掷贾，它是從最后一個元素開始，逐個往前遍歷荣茫。
我們可以通過 keyIterator() 和 descendingKeyIterator()來說明想帅！
keyIterator()的作用是返回順序的KEY的集合，
descendingKeyIterator()的作用是返回逆序的KEY的集合计露。
keyIterator() 的代碼如下：
Iterator<K> keyIterator() {
return new KeyIterator(getFirstEntry());
}
說明：從中我們可以看出keyIterator() 是返回以“第一個節(jié)點(diǎn)(getFirstEntry)” 為其實(shí)元素的迭代器博脑。
KeyIterator的代碼如下：
final class KeyIterator extends PrivateEntryIterator<K> {
KeyIterator(Entry<K,V> first) {
super(first);
}
public K next() {
return nextEntry().key;
}
}
說明：KeyIterator繼承于PrivateEntryIterator。當(dāng)我們通過next()不斷獲取下一個元素的時候票罐，就是執(zhí)行的順序遍歷了叉趣。
descendingKeyIterator()的代碼如下：
Iterator<K> descendingKeyIterator() {
return new DescendingKeyIterator(getLastEntry());
}
說明：從中我們可以看出descendingKeyIterator() 是返回以“最后一個節(jié)點(diǎn)(getLastEntry)” 為其實(shí)元素的迭代器。
再看看DescendingKeyIterator的代碼：
final class DescendingKeyIterator extends PrivateEntryIterator<K> {
DescendingKeyIterator(Entry<K,V> first) {
super(first);
}
public K next() {
return prevEntry().key;
}
}
說明：DescendingKeyIterator繼承于PrivateEntryIterator该押。當(dāng)我們通過next()不斷獲取下一個元素的時候疗杉，實(shí)際上調(diào)用的是prevEntry()獲取的上一個節(jié)點(diǎn)，這樣它實(shí)際上執(zhí)行的是逆序遍歷了蚕礼。
至此烟具，TreeMap的相關(guān)內(nèi)容就全部介紹完畢了。若有錯誤或紕漏的地方奠蹬，歡迎指正朝聋！
第4部分 TreeMap遍歷方式
4.1 遍歷TreeMap的鍵值對
第一步：根據(jù)entrySet()獲取TreeMap的“鍵值對”的Set集合。
第二步：通過Iterator迭代器遍歷“第一步”得到的集合囤躁。
// 假設(shè)map是TreeMap對象
// map中的key是String類型冀痕，value是Integer類型
Integer integ = null;
Iterator iter = map.entrySet().iterator();
while(iter.hasNext()) {
Map.Entry entry = (Map.Entry)iter.next();
// 獲取key
key = (String)entry.getKey();
// 獲取value
integ = (Integer)entry.getValue();
}
4.2 遍歷TreeMap的鍵
第一步：根據(jù)keySet()獲取TreeMap的“鍵”的Set集合。
第二步：通過Iterator迭代器遍歷“第一步”得到的集合狸演。
// 假設(shè)map是TreeMap對象
// map中的key是String類型言蛇，value是Integer類型
String key = null;
Integer integ = null;
Iterator iter = map.keySet().iterator();
while (iter.hasNext()) {
// 獲取key
key = (String)iter.next();
// 根據(jù)key，獲取value
integ = (Integer)map.get(key);
}
4.3 遍歷TreeMap的值
第一步：根據(jù)value()獲取TreeMap的“值”的集合宵距。
第二步：通過Iterator迭代器遍歷“第一步”得到的集合腊尚。
// 假設(shè)map是TreeMap對象
// map中的key是String類型，value是Integer類型
Integer value = null;
Collection c = map.values();
Iterator iter= c.iterator();
while (iter.hasNext()) {
value = (Integer)iter.next();
}
TreeMap遍歷測試程序如下：
import java.util.Map;
import java.util.Random;
import java.util.Iterator;
import java.util.TreeMap;
import java.util.HashSet;
import java.util.Map.Entry;
import java.util.Collection;
/*
* @desc 遍歷TreeMap的測試程序满哪。
* (01) 通過entrySet()去遍歷key婿斥、value劝篷，參考實(shí)現(xiàn)函數(shù)：
* iteratorTreeMapByEntryset()
* (02) 通過keySet()去遍歷key、value受扳，參考實(shí)現(xiàn)函數(shù)：
* iteratorTreeMapByKeyset()
* (03) 通過values()去遍歷value携龟，參考實(shí)現(xiàn)函數(shù)：
* iteratorTreeMapJustValues()
*
* @author skywang
*/
public class TreeMapIteratorTest {
public static void main(String[] args) {
int val = 0;
String key = null;
Integer value = null;
Random r = new Random();
TreeMap map = new TreeMap();
for (int i=0; i<12; i++) {
// 隨機(jī)獲取一個[0,100)之間的數(shù)字
val = r.nextInt(100);
key = String.valueOf(val);
value = r.nextInt(5);
// 添加到TreeMap中
map.put(key, value);
System.out.println(" key:"+key+" value:"+value);
}
// 通過entrySet()遍歷TreeMap的key-value
iteratorTreeMapByEntryset(map) ;
// 通過keySet()遍歷TreeMap的key-value
iteratorTreeMapByKeyset(map) ;
// 單單遍歷TreeMap的value
iteratorTreeMapJustValues(map);
}
/*
* 通過entry set遍歷TreeMap
* 效率高!
*/
private static void iteratorTreeMapByEntryset(TreeMap map) {
if (map == null)
return ;
System.out.println("\niterator TreeMap By entryset");
String key = null;
Integer integ = null;
Iterator iter = map.entrySet().iterator();
while(iter.hasNext()) {
Map.Entry entry = (Map.Entry)iter.next();
key = (String)entry.getKey();
integ = (Integer)entry.getValue();
System.out.println(key+" -- "+integ.intValue());
}
}
/*
* 通過keyset來遍歷TreeMap
* 效率低!
*/
private static void iteratorTreeMapByKeyset(TreeMap map) {
if (map == null)
return ;
System.out.println("\niterator TreeMap By keyset");
String key = null;
Integer integ = null;
Iterator iter = map.keySet().iterator();
while (iter.hasNext()) {
key = (String)iter.next();
integ = (Integer)map.get(key);
System.out.println(key+" -- "+integ.intValue());
}
}
/*
* 遍歷TreeMap的values
*/
private static void iteratorTreeMapJustValues(TreeMap map) {
if (map == null)
return ;
Collection c = map.values();
Iterator iter= c.iterator();
while (iter.hasNext()) {
System.out.println(iter.next());
}
}
}
第5部分 TreeMap示例
下面通過實(shí)例來學(xué)習(xí)如何使用TreeMap
import java.util.*;
/**
* @desc TreeMap測試程序
*
* @author skywang
*/
public class TreeMapTest {
public static void main(String[] args) {
// 測試常用的API
testTreeMapOridinaryAPIs();
// 測試TreeMap的導(dǎo)航函數(shù)
//testNavigableMapAPIs();
// 測試TreeMap的子Map函數(shù)
//testSubMapAPIs();
}
/**
* 測試常用的API
*/
private static void testTreeMapOridinaryAPIs() {
// 初始化隨機(jī)種子
Random r = new Random();
// 新建TreeMap
TreeMap tmap = new TreeMap();
// 添加操作
tmap.put("one", r.nextInt(10));
tmap.put("two", r.nextInt(10));
tmap.put("three", r.nextInt(10));
System.out.printf("\n ---- testTreeMapOridinaryAPIs ----\n");
// 打印出TreeMap
System.out.printf("%s\n",tmap );
// 通過Iterator遍歷key-value
Iterator iter = tmap.entrySet().iterator();
while(iter.hasNext()) {
Map.Entry entry = (Map.Entry)iter.next();
System.out.printf("next : %s - %s\n", entry.getKey(), entry.getValue());
}
// TreeMap的鍵值對個數(shù)
System.out.printf("size: %s\n", tmap.size());
// containsKey(Object key) :是否包含鍵key
System.out.printf("contains key two : %s\n",tmap.containsKey("two"));
System.out.printf("contains key five : %s\n",tmap.containsKey("five"));
// containsValue(Object value) :是否包含值value
System.out.printf("contains value 0 : %s\n",tmap.containsValue(new Integer(0)));
// remove(Object key) ： 刪除鍵key對應(yīng)的鍵值對
tmap.remove("three");
System.out.printf("tmap:%s\n",tmap );
// clear() ： 清空TreeMap
tmap.clear();
// isEmpty() : TreeMap是否為空
System.out.printf("%s\n", (tmap.isEmpty()?"tmap is empty":"tmap is not empty") );
}
/**
* 測試TreeMap的子Map函數(shù)
*/
public static void testSubMapAPIs() {
// 新建TreeMap
TreeMap tmap = new TreeMap();
// 添加“鍵值對”
tmap.put("a", 101);
tmap.put("b", 102);
tmap.put("c", 103);
tmap.put("d", 104);
tmap.put("e", 105);
System.out.printf("\n ---- testSubMapAPIs ----\n");
// 打印出TreeMap
System.out.printf("tmap:\n\t%s\n", tmap);
// 測試 headMap(K toKey)
System.out.printf("tmap.headMap(\"c\"):\n\t%s\n", tmap.headMap("c"));
// 測試 headMap(K toKey, boolean inclusive)
System.out.printf("tmap.headMap(\"c\", true):\n\t%s\n", tmap.headMap("c", true));
System.out.printf("tmap.headMap(\"c\", false):\n\t%s\n", tmap.headMap("c", false));
// 測試 tailMap(K fromKey)
System.out.printf("tmap.tailMap(\"c\"):\n\t%s\n", tmap.tailMap("c"));
// 測試 tailMap(K fromKey, boolean inclusive)
System.out.printf("tmap.tailMap(\"c\", true):\n\t%s\n", tmap.tailMap("c", true));
System.out.printf("tmap.tailMap(\"c\", false):\n\t%s\n", tmap.tailMap("c", false));
// 測試 subMap(K fromKey, K toKey)
System.out.printf("tmap.subMap(\"a\", \"c\"):\n\t%s\n", tmap.subMap("a", "c"));
// 測試
System.out.printf("tmap.subMap(\"a\", true, \"c\", true):\n\t%s\n",
tmap.subMap("a", true, "c", true));
System.out.printf("tmap.subMap(\"a\", true, \"c\", false):\n\t%s\n",
tmap.subMap("a", true, "c", false));
System.out.printf("tmap.subMap(\"a\", false, \"c\", true):\n\t%s\n",
tmap.subMap("a", false, "c", true));
System.out.printf("tmap.subMap(\"a\", false, \"c\", false):\n\t%s\n",
tmap.subMap("a", false, "c", false));
// 測試 navigableKeySet()
System.out.printf("tmap.navigableKeySet():\n\t%s\n", tmap.navigableKeySet());
// 測試 descendingKeySet()
System.out.printf("tmap.descendingKeySet():\n\t%s\n", tmap.descendingKeySet());
}
/**
* 測試TreeMap的導(dǎo)航函數(shù)
*/
public static void testNavigableMapAPIs() {
// 新建TreeMap
NavigableMap nav = new TreeMap();
// 添加“鍵值對”
nav.put("aaa", 111);
nav.put("bbb", 222);
nav.put("eee", 333);
nav.put("ccc", 555);
nav.put("ddd", 444);
System.out.printf("\n ---- testNavigableMapAPIs ----\n");
// 打印出TreeMap
System.out.printf("Whole list:%s%n", nav);
// 獲取第一個key兔跌、第一個Entry
System.out.printf("First key: %s\tFirst entry: %s%n",nav.firstKey(), nav.firstEntry());
// 獲取最后一個key勘高、最后一個Entry
System.out.printf("Last key: %s\tLast entry: %s%n",nav.lastKey(), nav.lastEntry());
// 獲取“小于/等于bbb”的最大鍵值對
System.out.printf("Key floor before bbb: %s%n",nav.floorKey("bbb"));
// 獲取“小于bbb”的最大鍵值對
System.out.printf("Key lower before bbb: %s%n", nav.lowerKey("bbb"));
// 獲取“大于/等于bbb”的最小鍵值對
System.out.printf("Key ceiling after ccc: %s%n",nav.ceilingKey("ccc"));
// 獲取“大于bbb”的最小鍵值對
System.out.printf("Key higher after ccc: %s%n\n",nav.higherKey("ccc"));
}
}
{one=8, three=4, two=2}
next : one - 8
next : three - 4
next : two - 2
size: 3
contains key two : true
contains key five : false
contains value 0 : false
tmap:{one=8, two=2}
tmap is empty
