Java 集合系列17之 TreeSet詳細介紹(原始碼解析)和使用示例
阿新 • • 發佈：2018-12-30
1 package java.util; 2 3 public class TreeSet<E> extends AbstractSet<E> 4 implements NavigableSet<E>, Cloneable, java.io.Serializable 5 { 6 // NavigableMap物件 7 private transient NavigableMap<E,Object> m; 8 9 // TreeSet是通過TreeMap實現的， 10// PRESENT是鍵-值對中的值。 11 private static final Object PRESENT = new Object(); 12 13 // 不帶引數的建構函式。建立一個空的TreeMap 14 public TreeSet() { 15 this(new TreeMap<E,Object>()); 16 } 17 18 // 將TreeMap賦值給 "NavigableMap物件m" 19 TreeSet(NavigableMap<E,Object> m) {20 this.m = m; 21 } 22 23 // 帶比較器的建構函式。 24 public TreeSet(Comparator<? super E> comparator) { 25 this(new TreeMap<E,Object>(comparator)); 26 } 27 28 // 建立TreeSet，並將集合c中的全部元素都新增到TreeSet中 29 public TreeSet(Collection<? extends E> c) {30 this(); 31 // 將集合c中的元素全部新增到TreeSet中 32 addAll(c); 33 } 34 35 // 建立TreeSet，並將s中的全部元素都新增到TreeSet中 36 public TreeSet(SortedSet<E> s) { 37 this(s.comparator()); 38 addAll(s); 39 } 40 41 // 返回TreeSet的順序排列的迭代器。 42 // 因為TreeSet時TreeMap實現的，所以這裡實際上時返回TreeMap的“鍵集”對應的迭代器 43 public Iterator<E> iterator() { 44 return m.navigableKeySet().iterator(); 45 } 46 47 // 返回TreeSet的逆序排列的迭代器。 48 // 因為TreeSet時TreeMap實現的，所以這裡實際上時返回TreeMap的“鍵集”對應的迭代器 49 public Iterator<E> descendingIterator() { 50 return m.descendingKeySet().iterator(); 51 } 52 53 // 返回TreeSet的大小 54 public int size() { 55 return m.size(); 56 } 57 58 // 返回TreeSet是否為空 59 public boolean isEmpty() { 60 return m.isEmpty(); 61 } 62 63 // 返回TreeSet是否包含物件(o) 64 public boolean contains(Object o) { 65 return m.containsKey(o); 66 } 67 68 // 新增e到TreeSet中 69 public boolean add(E e) { 70 return m.put(e, PRESENT)==null; 71 } 72 73 // 刪除TreeSet中的物件o 74 public boolean remove(Object o) { 75 return m.remove(o)==PRESENT; 76 } 77 78 // 清空TreeSet 79 public void clear() { 80 m.clear(); 81 } 82 83 // 將集合c中的全部元素新增到TreeSet中 84 public boolean addAll(Collection<? extends E> c) { 85 // Use linear-time version if applicable 86 if (m.size()==0 && c.size() > 0 && 87 c instanceof SortedSet && 88 m instanceof TreeMap) { 89 SortedSet<? extends E> set = (SortedSet<? extends E>) c; 90 TreeMap<E,Object> map = (TreeMap<E, Object>) m; 91 Comparator<? super E> cc = (Comparator<? super E>) set.comparator(); 92 Comparator<? super E> mc = map.comparator(); 93 if (cc==mc || (cc != null && cc.equals(mc))) { 94 map.addAllForTreeSet(set, PRESENT); 95 return true; 96 } 97 } 98 return super.addAll(c); 99 } 100 101 // 返回子Set，實際上是通過TreeMap的subMap()實現的。 102 public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, 103 E toElement, boolean toInclusive) { 104 return new TreeSet<E>(m.subMap(fromElement, fromInclusive, 105 toElement, toInclusive)); 106 } 107 108 // 返回Set的頭部，範圍是：從頭部到toElement。 109 // inclusive是是否包含toElement的標誌 110 public NavigableSet<E> headSet(E toElement, boolean inclusive) { 111 return new TreeSet<E>(m.headMap(toElement, inclusive)); 112 } 113 114 // 返回Set的尾部，範圍是：從fromElement到結尾。 115 // inclusive是是否包含fromElement的標誌 116 public NavigableSet<E> tailSet(E fromElement, boolean inclusive) { 117 return new TreeSet<E>(m.tailMap(fromElement, inclusive)); 118 } 119 120 // 返回子Set。範圍是：從fromElement(包括)到toElement(不包括)。 121 public SortedSet<E> subSet(E fromElement, E toElement) { 122 return subSet(fromElement, true, toElement, false); 123 } 124 125 // 返回Set的頭部，範圍是：從頭部到toElement(不包括)。 126 public SortedSet<E> headSet(E toElement) { 127 return headSet(toElement, false); 128 } 129 130 // 返回Set的尾部，範圍是：從fromElement到結尾(不包括)。 131 public SortedSet<E> tailSet(E fromElement) { 132 return tailSet(fromElement, true); 133 } 134 135 // 返回Set的比較器 136 public Comparator<? super E> comparator() { 137 return m.comparator(); 138 } 139 140 // 返回Set的第一個元素 141 public E first() { 142 return m.firstKey(); 143 } 144 145 // 返回Set的最後一個元素 146 public E first() { 147 public E last() { 148 return m.lastKey(); 149 } 150 151 // 返回Set中小於e的最大元素 152 public E lower(E e) { 153 return m.lowerKey(e); 154 } 155 156 // 返回Set中小於/等於e的最大元素 157 public E floor(E e) { 158 return m.floorKey(e); 159 } 160 161 // 返回Set中大於/等於e的最小元素 162 public E ceiling(E e) { 163 return m.ceilingKey(e); 164 } 165 166 // 返回Set中大於e的最小元素 167 public E higher(E e) { 168 return m.higherKey(e); 169 } 170 171 // 獲取第一個元素，並將該元素從TreeMap中刪除。 172 public E pollFirst() { 173 Map.Entry<E,?> e = m.pollFirstEntry(); 174 return (e == null)? null : e.getKey(); 175 } 176 177 // 獲取最後一個元素，並將該元素從TreeMap中刪除。 178 public E pollLast() { 179 Map.Entry<E,?> e = m.pollLastEntry(); 180 return (e == null)? null : e.getKey(); 181 } 182 183 // 克隆一個TreeSet，並返回Object物件 184 public Object clone() { 185 TreeSet<E> clone = null; 186 try { 187 clone = (TreeSet<E>) super.clone(); 188 } catch (CloneNotSupportedException e) { 189 throw new InternalError(); 190 } 191 192 clone.m = new TreeMap<E,Object>(m); 193 return clone; 194 } 195 196 // java.io.Serializable的寫入函式 197 // 將TreeSet的“比較器、容量，所有的元素值”都寫入到輸出流中 198 private void writeObject(java.io.ObjectOutputStream s) 199 throws java.io.IOException { 200 s.defaultWriteObject(); 201 202 // 寫入比較器 203 s.writeObject(m.comparator()); 204 205 // 寫入容量 206 s.writeInt(m.size()); 207 208 // 寫入“TreeSet中的每一個元素” 209 for (Iterator i=m.keySet().iterator(); i.hasNext(); ) 210 s.writeObject(i.next()); 211 } 212 213 // java.io.Serializable的讀取函式：根據寫入方式讀出 214 // 先將TreeSet的“比較器、容量、所有的元素值”依次讀出 215 private void readObject(java.io.ObjectInputStream s) 216 throws java.io.IOException, ClassNotFoundException { 217 // Read in any hidden stuff 218 s.defaultReadObject(); 219 220 // 從輸入流中讀取TreeSet的“比較器” 221 Comparator<? super E> c = (Comparator<? super E>) s.readObject(); 222 223 TreeMap<E,Object> tm; 224 if (c==null) 225 tm = new TreeMap<E,Object>(); 226 else 227 tm = new TreeMap<E,Object>(c); 228 m = tm; 229 230 // 從輸入流中讀取TreeSet的“容量” 231 int size = s.readInt(); 232 233 // 從輸入流中讀取TreeSet的“全部元素” 234 tm.readTreeSet(size, s, PRESENT); 235 } 236 237 // TreeSet的序列版本號 238 private static final long serialVersionUID = -2479143000061671589L; 239 }