package java.util; 
import java.io.*; 
public class LinkedHashMap<K,V> 
  extends HashMap<K,V> 
  implements Map<K,V> 
{ 
  private static final long serialVersionUID = 3801124242820219131L; 
  //雙向循環(huán)鏈表的頭結(jié)點(diǎn)，整個(gè)LinkedHashMap中只有一個(gè)header， 
  //它將哈希表中所有的Entry貫穿起來，header中不保存key-value對，只保存前后節(jié)點(diǎn)的引用 
  private transient Entry<K,V> header; 
  //雙向鏈表中元素排序規(guī)則的標(biāo)志位。 
  //accessOrder為false，表示按插入順序排序 
  //accessOrder為true，表示按訪問順序排序 
  private final boolean accessOrder; 
  //調(diào)用HashMap的構(gòu)造方法來構(gòu)造底層的數(shù)組 
  public LinkedHashMap(int initialCapacity, float loadFactor) { 
    super(initialCapacity, loadFactor); 
    accessOrder = false;  //鏈表中的元素默認(rèn)按照插入順序排序 
  } 
  //加載因子取默認(rèn)的0.75f 
  public LinkedHashMap(int initialCapacity) { 
    super(initialCapacity); 
    accessOrder = false; 
  } 
  //加載因子取默認(rèn)的0.75f，容量取默認(rèn)的16 
  public LinkedHashMap() { 
    super(); 
    accessOrder = false; 
  } 
  //含有子Map的構(gòu)造方法，同樣調(diào)用HashMap的對應(yīng)的構(gòu)造方法 
  public LinkedHashMap(Map<? extends K, ? extends V> m) { 
    super(m); 
    accessOrder = false; 
  } 
  //該構(gòu)造方法可以指定鏈表中的元素排序的規(guī)則 
  public LinkedHashMap(int initialCapacity,float loadFactor,boolean accessOrder) { 
    super(initialCapacity, loadFactor); 
    this.accessOrder = accessOrder; 
  } 
  //覆寫父類的init()方法（HashMap中的init方法為空）， 
  //該方法在父類的構(gòu)造方法和Clone、readObject中在插入元素前被調(diào)用， 
  //初始化一個(gè)空的雙向循環(huán)鏈表，頭結(jié)點(diǎn)中不保存數(shù)據(jù)，頭結(jié)點(diǎn)的下一個(gè)節(jié)點(diǎn)才開始保存數(shù)據(jù)。 
  void init() { 
    header = new Entry<K,V>(-1, null, null, null); 
    header.before = header.after = header; 
  } 
  //覆寫HashMap中的transfer方法，它在父類的resize方法中被調(diào)用， 
  //擴(kuò)容后，將key-value對重新映射到新的newTable中 
  //覆寫該方法的目的是為了提高復(fù)制的效率， 
  //這里充分利用雙向循環(huán)鏈表的特點(diǎn)進(jìn)行迭代，不用對底層的數(shù)組進(jìn)行for循環(huán)。 
  void transfer(HashMap.Entry[] newTable) { 
    int newCapacity = newTable.length; 
    for (Entry<K,V> e = header.after; e != header; e = e.after) { 
      int index = indexFor(e.hash, newCapacity); 
      e.next = newTable[index]; 
      newTable[index] = e; 
    } 
  } 
  //覆寫HashMap中的containsValue方法， 
  //覆寫該方法的目的同樣是為了提高查詢的效率， 
  //利用雙向循環(huán)鏈表的特點(diǎn)進(jìn)行查詢，少了對數(shù)組的外層for循環(huán) 
  public boolean containsValue(Object value) { 
    // Overridden to take advantage of faster iterator 
    if (value==null) { 
      for (Entry e = header.after; e != header; e = e.after) 
        if (e.value==null) 
          return true; 
    } else { 
      for (Entry e = header.after; e != header; e = e.after) 
        if (value.equals(e.value)) 
          return true; 
    } 
    return false; 
  } 
  //覆寫HashMap中的get方法，通過getEntry方法獲取Entry對象。 
  //注意這里的recordAccess方法， 
  //如果鏈表中元素的排序規(guī)則是按照插入的先后順序排序的話，該方法什么也不做， 
  //如果鏈表中元素的排序規(guī)則是按照訪問的先后順序排序的話，則將e移到鏈表的末尾處。 
  public V get(Object key) { 
    Entry<K,V> e = (Entry<K,V>)getEntry(key); 
    if (e == null) 
      return null; 
    e.recordAccess(this); 
    return e.value; 
  } 
  //清空HashMap，并將雙向鏈表還原為只有頭結(jié)點(diǎn)的空鏈表 
  public void clear() { 
    super.clear(); 
    header.before = header.after = header; 
  } 
  //Enty的數(shù)據(jù)結(jié)構(gòu)，多了兩個(gè)指向前后節(jié)點(diǎn)的引用 
  private static class Entry<K,V> extends HashMap.Entry<K,V> { 
    // These fields comprise the doubly linked list used for iteration. 
    Entry<K,V> before, after; 
    //調(diào)用父類的構(gòu)造方法 
    Entry(int hash, K key, V value, HashMap.Entry<K,V> next) { 
      super(hash, key, value, next); 
    } 
    //雙向循環(huán)鏈表中，刪除當(dāng)前的Entry 
    private void remove() { 
      before.after = after; 
      after.before = before; 
    } 
    //雙向循環(huán)立鏈表中，將當(dāng)前的Entry插入到existingEntry的前面 
    private void addBefore(Entry<K,V> existingEntry) { 
      after = existingEntry; 
      before = existingEntry.before; 
      before.after = this; 
      after.before = this; 
    } 
    //覆寫HashMap中的recordAccess方法（HashMap中該方法為空）， 
    //當(dāng)調(diào)用父類的put方法，在發(fā)現(xiàn)插入的key已經(jīng)存在時(shí)，會調(diào)用該方法， 
    //調(diào)用LinkedHashmap覆寫的get方法時(shí)，也會調(diào)用到該方法， 
    //該方法提供了LRU算法的實(shí)現(xiàn)，它將最近使用的Entry放到雙向循環(huán)鏈表的尾部， 
    //accessOrder為true時(shí)，get方法會調(diào)用recordAccess方法 
    //put方法在覆蓋key-value對時(shí)也會調(diào)用recordAccess方法 
    //它們導(dǎo)致Entry最近使用，因此將其移到雙向鏈表的末尾 
    void recordAccess(HashMap<K,V> m) { 
      LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m; 
      //如果鏈表中元素按照訪問順序排序，則將當(dāng)前訪問的Entry移到雙向循環(huán)鏈表的尾部， 
      //如果是按照插入的先后順序排序，則不做任何事情。 
      if (lm.accessOrder) { 
        lm.modCount++; 
        //移除當(dāng)前訪問的Entry 
        remove(); 
        //將當(dāng)前訪問的Entry插入到鏈表的尾部 
        addBefore(lm.header); 
      } 
    } 
    void recordRemoval(HashMap<K,V> m) { 
      remove(); 
    } 
  } 
  //迭代器 
  private abstract class LinkedHashIterator<T> implements Iterator<T> { 
  Entry<K,V> nextEntry  = header.after; 
  Entry<K,V> lastReturned = null; 
  /** 
   * The modCount value that the iterator believes that the backing 
   * List should have. If this expectation is violated, the iterator 
   * has detected concurrent modification. 
   */ 
  int expectedModCount = modCount; 
  public boolean hasNext() { 
      return nextEntry != header; 
  } 
  public void remove() { 
    if (lastReturned == null) 
    throw new IllegalStateException(); 
    if (modCount != expectedModCount) 
    throw new ConcurrentModificationException(); 
      LinkedHashMap.this.remove(lastReturned.key); 
      lastReturned = null; 
      expectedModCount = modCount; 
  } 
  //從head的下一個(gè)節(jié)點(diǎn)開始迭代 
  Entry<K,V> nextEntry() { 
    if (modCount != expectedModCount) 
    throw new ConcurrentModificationException(); 
      if (nextEntry == header) 
        throw new NoSuchElementException(); 
      Entry<K,V> e = lastReturned = nextEntry; 
      nextEntry = e.after; 
      return e; 
  } 
  } 
  //key迭代器 
  private class KeyIterator extends LinkedHashIterator<K> { 
  public K next() { return nextEntry().getKey(); } 
  } 
  //value迭代器 
  private class ValueIterator extends LinkedHashIterator<V> { 
  public V next() { return nextEntry().value; } 
  } 
  //Entry迭代器 
  private class EntryIterator extends LinkedHashIterator<Map.Entry<K,V>> { 
  public Map.Entry<K,V> next() { return nextEntry(); } 
  } 
  // These Overrides alter the behavior of superclass view iterator() methods 
  Iterator<K> newKeyIterator()  { return new KeyIterator();  } 
  Iterator<V> newValueIterator() { return new ValueIterator(); } 
  Iterator<Map.Entry<K,V>> newEntryIterator() { return new EntryIterator(); } 
  //覆寫HashMap中的addEntry方法，LinkedHashmap并沒有覆寫HashMap中的put方法， 
  //而是覆寫了put方法所調(diào)用的addEntry方法和recordAccess方法， 
  //put方法在插入的key已存在的情況下，會調(diào)用recordAccess方法， 
  //在插入的key不存在的情況下，要調(diào)用addEntry插入新的Entry 
  void addEntry(int hash, K key, V value, int bucketIndex) { 
    //創(chuàng)建新的Entry，并插入到LinkedHashMap中 
    createEntry(hash, key, value, bucketIndex); 
    //雙向鏈表的第一個(gè)有效節(jié)點(diǎn)（header后的那個(gè)節(jié)點(diǎn)）為近期最少使用的節(jié)點(diǎn) 
    Entry<K,V> eldest = header.after; 
    //如果有必要，則刪除掉該近期最少使用的節(jié)點(diǎn)， 
    //這要看對removeEldestEntry的覆寫,由于默認(rèn)為false，因此默認(rèn)是不做任何處理的。 
    if (removeEldestEntry(eldest)) { 
      removeEntryForKey(eldest.key); 
    } else { 
      //擴(kuò)容到原來的2倍 
      if (size >= threshold) 
        resize(2 * table.length); 
    } 
  } 
  void createEntry(int hash, K key, V value, int bucketIndex) { 
    //創(chuàng)建新的Entry，并將其插入到數(shù)組對應(yīng)槽的單鏈表的頭結(jié)點(diǎn)處，這點(diǎn)與HashMap中相同 
    HashMap.Entry<K,V> old = table[bucketIndex]; 
    Entry<K,V> e = new Entry<K,V>(hash, key, value, old); 
    table[bucketIndex] = e; 
    //每次插入Entry時(shí)，都將其移到雙向鏈表的尾部， 
    //這便會按照Entry插入LinkedHashMap的先后順序來迭代元素， 
    //同時(shí)，新put進(jìn)來的Entry是最近訪問的Entry，把其放在鏈表末尾 ，符合LRU算法的實(shí)現(xiàn) 
    e.addBefore(header); 
    size++; 
  } 
  //該方法是用來被覆寫的，一般如果用LinkedHashmap實(shí)現(xiàn)LRU算法，就要覆寫該方法， 
  //比如可以將該方法覆寫為如果設(shè)定的內(nèi)存已滿，則返回true，這樣當(dāng)再次向LinkedHashMap中put 
  //Entry時(shí)，在調(diào)用的addEntry方法中便會將近期最少使用的節(jié)點(diǎn)刪除掉（header后的那個(gè)節(jié)點(diǎn)）。 
  protected boolean removeEldestEntry(Map.Entry<K,V> eldest) { 
    return false; 
  } 
} 

// 將“key-value”添加到HashMap中   
public V put(K key, V value) {   
  // 若“key為null”，則將該鍵值對添加到table[0]中。   
  if (key == null)   
    return putForNullKey(value);   
  // 若“key不為null”，則計(jì)算該key的哈希值，然后將其添加到該哈希值對應(yīng)的鏈表中。   
  int hash = hash(key.hashCode());   
  int i = indexFor(hash, table.length);   
  for (Entry<K,V> e = table[i]; e != null; e = e.next) {   
    Object k;   
    // 若“該key”對應(yīng)的鍵值對已經(jīng)存在，則用新的value取代舊的value。然后退出！   
    if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {   
      V oldValue = e.value;   
      e.value = value;   
      e.recordAccess(this);   
      return oldValue;   
    }   
  }   
  // 若“該key”對應(yīng)的鍵值對不存在，則將“key-value”添加到table中   
  modCount++;  
  //將key-value添加到table[i]處  
  addEntry(hash, key, value, i);   
  return null;   
} 

//覆寫HashMap中的recordAccess方法（HashMap中該方法為空）， 
//當(dāng)調(diào)用父類的put方法，在發(fā)現(xiàn)插入的key已經(jīng)存在時(shí)，會調(diào)用該方法， 
//調(diào)用LinkedHashmap覆寫的get方法時(shí)，也會調(diào)用到該方法， 
//該方法提供了LRU算法的實(shí)現(xiàn)，它將最近使用的Entry放到雙向循環(huán)鏈表的尾部， 
//accessOrder為true時(shí)，get方法會調(diào)用recordAccess方法 
//put方法在覆蓋key-value對時(shí)也會調(diào)用recordAccess方法 
//它們導(dǎo)致Entry最近使用，因此將其移到雙向鏈表的末尾 
   void recordAccess(HashMap<K,V> m) { 
     LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m; 
  //如果鏈表中元素按照訪問順序排序，則將當(dāng)前訪問的Entry移到雙向循環(huán)鏈表的尾部， 
  //如果是按照插入的先后順序排序，則不做任何事情。 
     if (lm.accessOrder) { 
       lm.modCount++; 
    //移除當(dāng)前訪問的Entry 
       remove(); 
    //將當(dāng)前訪問的Entry插入到鏈表的尾部 
       addBefore(lm.header); 
     } 
   } 

//覆寫HashMap中的addEntry方法，LinkedHashmap并沒有覆寫HashMap中的put方法， 
//而是覆寫了put方法所調(diào)用的addEntry方法和recordAccess方法， 
//put方法在插入的key已存在的情況下，會調(diào)用recordAccess方法， 
//在插入的key不存在的情況下，要調(diào)用addEntry插入新的Entry 
  void addEntry(int hash, K key, V value, int bucketIndex) { 
  //創(chuàng)建新的Entry，并插入到LinkedHashMap中 
    createEntry(hash, key, value, bucketIndex); 
    //雙向鏈表的第一個(gè)有效節(jié)點(diǎn)（header后的那個(gè)節(jié)點(diǎn)）為近期最少使用的節(jié)點(diǎn) 
    Entry<K,V> eldest = header.after; 
  //如果有必要，則刪除掉該近期最少使用的節(jié)點(diǎn)， 
  //這要看對removeEldestEntry的覆寫,由于默認(rèn)為false，因此默認(rèn)是不做任何處理的。 
    if (removeEldestEntry(eldest)) { 
      removeEntryForKey(eldest.key); 
    } else { 
    //擴(kuò)容到原來的2倍 
      if (size >= threshold) 
        resize(2 * table.length); 
    } 
  } 
  void createEntry(int hash, K key, V value, int bucketIndex) { 
  //創(chuàng)建新的Entry，并將其插入到數(shù)組對應(yīng)槽的單鏈表的頭結(jié)點(diǎn)處，這點(diǎn)與HashMap中相同 
    HashMap.Entry<K,V> old = table[bucketIndex]; 
  Entry<K,V> e = new Entry<K,V>(hash, key, value, old); 
    table[bucketIndex] = e; 
  //每次插入Entry時(shí)，都將其移到雙向鏈表的尾部， 
  //這便會按照Entry插入LinkedHashMap的先后順序來迭代元素， 
  //同時(shí)，新put進(jìn)來的Entry是最近訪問的Entry，把其放在鏈表末尾 ，符合LRU算法的實(shí)現(xiàn) 
    e.addBefore(header); 
    size++; 
  } 

 //該方法是用來被覆寫的，一般如果用LinkedHashmap實(shí)現(xiàn)LRU算法，就要覆寫該方法， 
  //比如可以將該方法覆寫為如果設(shè)定的內(nèi)存已滿，則返回true，這樣當(dāng)再次向LinkedHashMap中put 
  //Entry時(shí)，在調(diào)用的addEntry方法中便會將近期最少使用的節(jié)點(diǎn)刪除掉（header后的那個(gè)節(jié)點(diǎn)）。 
  protected boolean removeEldestEntry(Map.Entry<K,V> eldest) { 
    return false; 
  } 
} 

//覆寫HashMap中的get方法，通過getEntry方法獲取Entry對象。 
//注意這里的recordAccess方法， 
//如果鏈表中元素的排序規(guī)則是按照插入的先后順序排序的話，該方法什么也不做， 
//如果鏈表中元素的排序規(guī)則是按照訪問的先后順序排序的話，則將e移到鏈表的末尾處。 
  public V get(Object key) { 
    Entry<K,V> e = (Entry<K,V>)getEntry(key); 
    if (e == null) 
      return null; 
    e.recordAccess(this); 
    return e.value; 
  }