11 |
|
/** |
12 |
|
* Red-Black tree based implementation of the <tt>NavigableMap</tt> interface. |
13 |
|
* This class guarantees that the map will be in ascending key order, sorted |
14 |
< |
* according to the <i>natural order</i> for the key's class (see |
14 |
> |
* according to the <i>natural order</i> for the keys' class (see |
15 |
|
* <tt>Comparable</tt>), or by the comparator provided at creation time, |
16 |
|
* depending on which constructor is used.<p> |
17 |
|
* |
61 |
|
* throw <tt>ConcurrentModificationException</tt> on a best-effort basis. |
62 |
|
* Therefore, it would be wrong to write a program that depended on this |
63 |
|
* exception for its correctness: <i>the fail-fast behavior of iterators |
64 |
< |
* should be used only to detect bugs.</i><p> |
64 |
> |
* should be used only to detect bugs.</i> |
65 |
|
* |
66 |
|
* <p>All <tt>Map.Entry</tt> pairs returned by methods in this class |
67 |
|
* and its views represent snapshots of mappings at the time they were |
542 |
|
* @param key key with which the specified value is to be associated. |
543 |
|
* @param value value to be associated with the specified key. |
544 |
|
* |
545 |
< |
* @return previous value associated with specified key, or <tt>null</tt> |
545 |
> |
* @return the previous value associated with specified key, or <tt>null</tt> |
546 |
|
* if there was no mapping for key. A <tt>null</tt> return can |
547 |
|
* also indicate that the map previously associated <tt>null</tt> |
548 |
|
* with the specified key. |
591 |
|
* Removes the mapping for this key from this TreeMap if present. |
592 |
|
* |
593 |
|
* @param key key for which mapping should be removed |
594 |
< |
* @return previous value associated with specified key, or <tt>null</tt> |
594 |
> |
* @return the previous value associated with specified key, or <tt>null</tt> |
595 |
|
* if there was no mapping for key. A <tt>null</tt> return can |
596 |
|
* also indicate that the map previously associated |
597 |
|
* <tt>null</tt> with the specified key. |
670 |
|
/** |
671 |
|
* Returns a key-value mapping associated with the greatest |
672 |
|
* key in this map, or <tt>null</tt> if the map is empty. |
673 |
– |
* The returned entry does <em>not</em> support |
674 |
– |
* the <tt>Entry.setValue</tt> method. |
673 |
|
* |
674 |
|
* @return an Entry with greatest key, or <tt>null</tt> |
675 |
|
* if the map is empty. |
1076 |
|
/** |
1077 |
|
* Returns a view of the portion of this map whose keys range from |
1078 |
|
* <tt>fromKey</tt>, inclusive, to <tt>toKey</tt>, exclusive. (If |
1079 |
< |
* <tt>fromKey</tt> and <tt>toKey</tt> are equal, the returned sorted map |
1080 |
< |
* is empty.) The returned sorted map is backed by this map, so changes |
1081 |
< |
* in the returned sorted map are reflected in this map, and vice-versa. |
1082 |
< |
* The returned sorted map supports all optional map operations.<p> |
1079 |
> |
* <tt>fromKey</tt> and <tt>toKey</tt> are equal, the returned |
1080 |
> |
* navigable map is empty.) The returned navigable map is backed |
1081 |
> |
* by this map, so changes in the returned navigable map are |
1082 |
> |
* reflected in this map, and vice-versa. The returned navigable |
1083 |
> |
* map supports all optional map operations.<p> |
1084 |
|
* |
1085 |
< |
* The sorted map returned by this method will throw an |
1085 |
> |
* The navigable map returned by this method will throw an |
1086 |
|
* <tt>IllegalArgumentException</tt> if the user attempts to insert a key |
1087 |
|
* less than <tt>fromKey</tt> or greater than or equal to |
1088 |
|
* <tt>toKey</tt>.<p> |
1090 |
|
* Note: this method always returns a <i>half-open range</i> (which |
1091 |
|
* includes its low endpoint but not its high endpoint). If you need a |
1092 |
|
* <i>closed range</i> (which includes both endpoints), and the key type |
1093 |
< |
* allows for calculation of the successor a given key, merely request the |
1093 |
> |
* allows for calculation of the successor of a given key, merely request the |
1094 |
|
* subrange from <tt>lowEndpoint</tt> to <tt>successor(highEndpoint)</tt>. |
1095 |
< |
* For example, suppose that <tt>m</tt> is a sorted map whose keys are |
1095 |
> |
* For example, suppose that <tt>m</tt> is a navigable map whose keys are |
1096 |
|
* strings. The following idiom obtains a view containing all of the |
1097 |
|
* key-value mappings in <tt>m</tt> whose keys are between <tt>low</tt> |
1098 |
|
* and <tt>high</tt>, inclusive: |
1099 |
< |
* <pre> NavigableMap sub = m.submap(low, high+"\0");</pre> |
1099 |
> |
* <pre> NavigableMap sub = m.navigableSubMap(low, high+"\0");</pre> |
1100 |
|
* A similar technique can be used to generate an <i>open range</i> (which |
1101 |
|
* contains neither endpoint). The following idiom obtains a view |
1102 |
|
* containing all of the key-value mappings in <tt>m</tt> whose keys are |
1103 |
|
* between <tt>low</tt> and <tt>high</tt>, exclusive: |
1104 |
< |
* <pre> NavigableMap sub = m.subMap(low+"\0", high);</pre> |
1104 |
> |
* <pre> NavigableMap sub = m.navigableSubMap(low+"\0", high);</pre> |
1105 |
|
* |
1106 |
|
* @param fromKey low endpoint (inclusive) of the subMap. |
1107 |
|
* @param toKey high endpoint (exclusive) of the subMap. |
1118 |
|
* <tt>null</tt> and this map uses natural order, or its |
1119 |
|
* comparator does not tolerate <tt>null</tt> keys. |
1120 |
|
*/ |
1121 |
< |
public NavigableMap<K,V> subMap(K fromKey, K toKey) { |
1121 |
> |
public NavigableMap<K,V> navigableSubMap(K fromKey, K toKey) { |
1122 |
|
return new SubMap(fromKey, toKey); |
1123 |
|
} |
1124 |
|
|
1125 |
+ |
|
1126 |
|
/** |
1127 |
|
* Returns a view of the portion of this map whose keys are strictly less |
1128 |
< |
* than <tt>toKey</tt>. The returned sorted map is backed by this map, so |
1129 |
< |
* changes in the returned sorted map are reflected in this map, and |
1130 |
< |
* vice-versa. The returned sorted map supports all optional map |
1128 |
> |
* than <tt>toKey</tt>. The returned navigable map is backed by this map, so |
1129 |
> |
* changes in the returned navigable map are reflected in this map, and |
1130 |
> |
* vice-versa. The returned navigable map supports all optional map |
1131 |
|
* operations.<p> |
1132 |
|
* |
1133 |
< |
* The sorted map returned by this method will throw an |
1133 |
> |
* The navigable map returned by this method will throw an |
1134 |
|
* <tt>IllegalArgumentException</tt> if the user attempts to insert a key |
1135 |
|
* greater than or equal to <tt>toKey</tt>.<p> |
1136 |
|
* |
1137 |
|
* Note: this method always returns a view that does not contain its |
1138 |
|
* (high) endpoint. If you need a view that does contain this endpoint, |
1139 |
< |
* and the key type allows for calculation of the successor a given key, |
1139 |
> |
* and the key type allows for calculation of the successor of a given key, |
1140 |
|
* merely request a headMap bounded by <tt>successor(highEndpoint)</tt>. |
1141 |
< |
* For example, suppose that suppose that <tt>m</tt> is a sorted map whose |
1141 |
> |
* For example, suppose that suppose that <tt>m</tt> is a navigable map whose |
1142 |
|
* keys are strings. The following idiom obtains a view containing all of |
1143 |
|
* the key-value mappings in <tt>m</tt> whose keys are less than or equal |
1144 |
|
* to <tt>high</tt>: |
1145 |
|
* <pre> |
1146 |
< |
* NavigableMap head = m.headMap(high+"\0"); |
1146 |
> |
* NavigableMap head = m.navigableHeadMap(high+"\0"); |
1147 |
|
* </pre> |
1148 |
|
* |
1149 |
|
* @param toKey high endpoint (exclusive) of the headMap. |
1160 |
|
* this map uses natural order, or its comparator does not |
1161 |
|
* tolerate <tt>null</tt> keys. |
1162 |
|
*/ |
1163 |
< |
public NavigableMap<K,V> headMap(K toKey) { |
1163 |
> |
public NavigableMap<K,V> navigableHeadMap(K toKey) { |
1164 |
|
return new SubMap(toKey, true); |
1165 |
|
} |
1166 |
|
|
1167 |
|
/** |
1168 |
|
* Returns a view of the portion of this map whose keys are greater than |
1169 |
< |
* or equal to <tt>fromKey</tt>. The returned sorted map is backed by |
1170 |
< |
* this map, so changes in the returned sorted map are reflected in this |
1171 |
< |
* map, and vice-versa. The returned sorted map supports all optional map |
1169 |
> |
* or equal to <tt>fromKey</tt>. The returned navigable map is backed by |
1170 |
> |
* this map, so changes in the returned navigable map are reflected in this |
1171 |
> |
* map, and vice-versa. The returned navigable map supports all optional map |
1172 |
|
* operations.<p> |
1173 |
|
* |
1174 |
< |
* The sorted map returned by this method will throw an |
1174 |
> |
* The navigable map returned by this method will throw an |
1175 |
|
* <tt>IllegalArgumentException</tt> if the user attempts to insert a key |
1176 |
|
* less than <tt>fromKey</tt>.<p> |
1177 |
|
* |
1178 |
|
* Note: this method always returns a view that contains its (low) |
1179 |
|
* endpoint. If you need a view that does not contain this endpoint, and |
1180 |
< |
* the element type allows for calculation of the successor a given value, |
1180 |
> |
* the element type allows for calculation of the successor of a given value, |
1181 |
|
* merely request a tailMap bounded by <tt>successor(lowEndpoint)</tt>. |
1182 |
< |
* For example, suppose that <tt>m</tt> is a sorted map whose keys |
1182 |
> |
* For example, suppose that <tt>m</tt> is a navigable map whose keys |
1183 |
|
* are strings. The following idiom obtains a view containing |
1184 |
|
* all of the key-value mappings in <tt>m</tt> whose keys are strictly |
1185 |
|
* greater than <tt>low</tt>: <pre> |
1186 |
< |
* NavigableMap tail = m.tailMap(low+"\0"); |
1186 |
> |
* NavigableMap tail = m.navigableTailMap(low+"\0"); |
1187 |
|
* </pre> |
1188 |
|
* |
1189 |
|
* @param fromKey low endpoint (inclusive) of the tailMap. |
1199 |
|
* this map uses natural order, or its comparator does not |
1200 |
|
* tolerate <tt>null</tt> keys. |
1201 |
|
*/ |
1202 |
< |
public NavigableMap<K,V> tailMap(K fromKey) { |
1202 |
> |
public NavigableMap<K,V> navigableTailMap(K fromKey) { |
1203 |
> |
return new SubMap(fromKey, false); |
1204 |
> |
} |
1205 |
> |
|
1206 |
> |
/** |
1207 |
> |
* Equivalent to <tt>navigableSubMap</tt> but with a return |
1208 |
> |
* type conforming to the <tt>SortedMap</tt> interface. |
1209 |
> |
* @param fromKey low endpoint (inclusive) of the subMap. |
1210 |
> |
* @param toKey high endpoint (exclusive) of the subMap. |
1211 |
> |
* |
1212 |
> |
* @return a view of the portion of this map whose keys range from |
1213 |
> |
* <tt>fromKey</tt>, inclusive, to <tt>toKey</tt>, exclusive. |
1214 |
> |
* |
1215 |
> |
* @throws ClassCastException if <tt>fromKey</tt> and <tt>toKey</tt> |
1216 |
> |
* cannot be compared to one another using this map's comparator |
1217 |
> |
* (or, if the map has no comparator, using natural ordering). |
1218 |
> |
* @throws IllegalArgumentException if <tt>fromKey</tt> is greater than |
1219 |
> |
* <tt>toKey</tt>. |
1220 |
> |
* @throws NullPointerException if <tt>fromKey</tt> or <tt>toKey</tt> is |
1221 |
> |
* <tt>null</tt> and this map uses natural order, or its |
1222 |
> |
* comparator does not tolerate <tt>null</tt> keys. |
1223 |
> |
*/ |
1224 |
> |
public SortedMap<K,V> subMap(K fromKey, K toKey) { |
1225 |
> |
return new SubMap(fromKey, toKey); |
1226 |
> |
} |
1227 |
> |
|
1228 |
> |
|
1229 |
> |
/** |
1230 |
> |
* Equivalent to <tt>navigableHeadMap</tt> but with a return |
1231 |
> |
* type conforming to the <tt>SortedMap</tt> interface. |
1232 |
> |
* |
1233 |
> |
* @param toKey high endpoint (exclusive) of the headMap. |
1234 |
> |
* @return a view of the portion of this map whose keys are strictly |
1235 |
> |
* less than <tt>toKey</tt>. |
1236 |
> |
* |
1237 |
> |
* @throws ClassCastException if <tt>toKey</tt> is not compatible |
1238 |
> |
* with this map's comparator (or, if the map has no comparator, |
1239 |
> |
* if <tt>toKey</tt> does not implement <tt>Comparable</tt>). |
1240 |
> |
* @throws IllegalArgumentException if this map is itself a subMap, |
1241 |
> |
* headMap, or tailMap, and <tt>toKey</tt> is not within the |
1242 |
> |
* specified range of the subMap, headMap, or tailMap. |
1243 |
> |
* @throws NullPointerException if <tt>toKey</tt> is <tt>null</tt> and |
1244 |
> |
* this map uses natural order, or its comparator does not |
1245 |
> |
* tolerate <tt>null</tt> keys. |
1246 |
> |
*/ |
1247 |
> |
public SortedMap<K,V> headMap(K toKey) { |
1248 |
> |
return new SubMap(toKey, true); |
1249 |
> |
} |
1250 |
> |
|
1251 |
> |
/** |
1252 |
> |
* Equivalent to <tt>navigableTailMap</tt> but with a return |
1253 |
> |
* type conforming to the <tt>SortedMap</tt> interface. |
1254 |
> |
* |
1255 |
> |
* @param fromKey low endpoint (inclusive) of the tailMap. |
1256 |
> |
* @return a view of the portion of this map whose keys are greater |
1257 |
> |
* than or equal to <tt>fromKey</tt>. |
1258 |
> |
* @throws ClassCastException if <tt>fromKey</tt> is not compatible |
1259 |
> |
* with this map's comparator (or, if the map has no comparator, |
1260 |
> |
* if <tt>fromKey</tt> does not implement <tt>Comparable</tt>). |
1261 |
> |
* @throws IllegalArgumentException if this map is itself a subMap, |
1262 |
> |
* headMap, or tailMap, and <tt>fromKey</tt> is not within the |
1263 |
> |
* specified range of the subMap, headMap, or tailMap. |
1264 |
> |
* @throws NullPointerException if <tt>fromKey</tt> is <tt>null</tt> and |
1265 |
> |
* this map uses natural order, or its comparator does not |
1266 |
> |
* tolerate <tt>null</tt> keys. |
1267 |
> |
*/ |
1268 |
> |
public SortedMap<K,V> tailMap(K fromKey) { |
1269 |
|
return new SubMap(fromKey, false); |
1270 |
|
} |
1271 |
|
|
1308 |
|
} |
1309 |
|
|
1310 |
|
public boolean isEmpty() { |
1311 |
< |
return entrySet.isEmpty(); |
1311 |
> |
return entrySet().isEmpty(); |
1312 |
|
} |
1313 |
|
|
1314 |
|
public boolean containsKey(Object key) { |
1372 |
|
public Map.Entry<K,V> pollFirstEntry() { |
1373 |
|
TreeMap.Entry<K,V> e = fromStart ? |
1374 |
|
getFirstEntry() : getCeilingEntry(fromKey); |
1375 |
< |
if (e == null || (!fromStart && compare(e.key, fromKey) < 0)) |
1375 |
> |
if (e == null || (!toEnd && compare(e.key, toKey) >= 0)) |
1376 |
|
return null; |
1377 |
|
Map.Entry result = new AbstractMap.SimpleImmutableEntry(e); |
1378 |
|
deleteEntry(e); |
1382 |
|
public Map.Entry<K,V> pollLastEntry() { |
1383 |
|
TreeMap.Entry<K,V> e = toEnd ? |
1384 |
|
getLastEntry() : getLowerEntry(toKey); |
1385 |
< |
if (e == null || (!toEnd && compare(e.key, toKey) >= 0)) |
1385 |
> |
if (e == null || (!fromStart && compare(e.key, fromKey) < 0)) |
1386 |
|
return null; |
1387 |
|
Map.Entry result = new AbstractMap.SimpleImmutableEntry(e); |
1388 |
|
deleteEntry(e); |
1462 |
|
return e == null? null : e.key; |
1463 |
|
} |
1464 |
|
|
1465 |
< |
private transient Set<Map.Entry<K,V>> entrySet = new EntrySetView(); |
1465 |
> |
private transient Set<Map.Entry<K,V>> entrySet = null; |
1466 |
|
|
1467 |
|
public Set<Map.Entry<K,V>> entrySet() { |
1468 |
< |
return entrySet; |
1468 |
> |
Set<Map.Entry<K,V>> es = entrySet; |
1469 |
> |
return (es != null)? es : (entrySet = new EntrySetView()); |
1470 |
|
} |
1471 |
|
|
1472 |
|
private class EntrySetView extends AbstractSet<Map.Entry<K,V>> { |
1564 |
|
} |
1565 |
|
|
1566 |
|
|
1567 |
< |
public NavigableMap<K,V> subMap(K fromKey, K toKey) { |
1567 |
> |
public NavigableMap<K,V> navigableSubMap(K fromKey, K toKey) { |
1568 |
|
if (!inRange2(fromKey)) |
1569 |
|
throw new IllegalArgumentException("fromKey out of range"); |
1570 |
|
if (!inRange2(toKey)) |
1572 |
|
return new SubMap(fromKey, toKey); |
1573 |
|
} |
1574 |
|
|
1575 |
< |
public NavigableMap<K,V> headMap(K toKey) { |
1575 |
> |
public NavigableMap<K,V> navigableHeadMap(K toKey) { |
1576 |
|
if (!inRange2(toKey)) |
1577 |
|
throw new IllegalArgumentException("toKey out of range"); |
1578 |
|
return new SubMap(fromStart, fromKey, false, toKey); |
1579 |
|
} |
1580 |
|
|
1581 |
< |
public NavigableMap<K,V> tailMap(K fromKey) { |
1581 |
> |
public NavigableMap<K,V> navigableTailMap(K fromKey) { |
1582 |
|
if (!inRange2(fromKey)) |
1583 |
|
throw new IllegalArgumentException("fromKey out of range"); |
1584 |
|
return new SubMap(false, fromKey, toEnd, toKey); |
1585 |
|
} |
1586 |
|
|
1587 |
+ |
|
1588 |
+ |
public SortedMap<K,V> subMap(K fromKey, K toKey) { |
1589 |
+ |
return navigableSubMap(fromKey, toKey); |
1590 |
+ |
} |
1591 |
+ |
|
1592 |
+ |
public SortedMap<K,V> headMap(K toKey) { |
1593 |
+ |
return navigableHeadMap(toKey); |
1594 |
+ |
} |
1595 |
+ |
|
1596 |
+ |
public SortedMap<K,V> tailMap(K fromKey) { |
1597 |
+ |
return navigableTailMap(fromKey); |
1598 |
+ |
} |
1599 |
+ |
|
1600 |
|
private boolean inRange(K key) { |
1601 |
|
return (fromStart || compare(key, fromKey) >= 0) && |
1602 |
|
(toEnd || compare(key, toKey) < 0); |
2163 |
|
// Write out size (number of Mappings) |
2164 |
|
s.writeInt(size); |
2165 |
|
|
2166 |
+ |
Set<Map.Entry<K,V>> es = entrySet(); |
2167 |
|
// Write out keys and values (alternating) |
2168 |
< |
for (Iterator<Map.Entry<K,V>> i = entrySet().iterator(); i.hasNext(); ) { |
2168 |
> |
for (Iterator<Map.Entry<K,V>> i = es.iterator(); i.hasNext(); ) { |
2169 |
|
Map.Entry<K,V> e = i.next(); |
2170 |
|
s.writeObject(e.getKey()); |
2171 |
|
s.writeObject(e.getValue()); |