All keys inserted into a sorted map must implement the Comparable + *
All keys inserted into a sorted map must implement the {@code Comparable} * interface (or be accepted by the specified comparator). Furthermore, all - * such keys must be mutually comparable: k1.compareTo(k2) (or - * comparator.compare(k1, k2)) must not throw a - * ClassCastException for any keys k1 and k2 in + * such keys must be mutually comparable: {@code k1.compareTo(k2)} (or + * {@code comparator.compare(k1, k2)}) must not throw a + * {@code ClassCastException} for any keys {@code k1} and {@code k2} in * the sorted map. Attempts to violate this restriction will cause the * offending method or constructor invocation to throw a - * ClassCastException. + * {@code ClassCastException}. * *
Note that the ordering maintained by a sorted map (whether or not an - * explicit comparator is provided) must be consistent with equals if - * the sorted map is to correctly implement the Map interface. (See - * the Comparable interface or Comparator interface for a - * precise definition of consistent with equals.) This is so because - * the Map interface is defined in terms of the equals + * explicit comparator is provided) must be consistent with equals if + * the sorted map is to correctly implement the {@code Map} interface. (See + * the {@code Comparable} interface or {@code Comparator} interface for a + * precise definition of consistent with equals.) This is so because + * the {@code Map} interface is defined in terms of the {@code equals} * operation, but a sorted map performs all key comparisons using its - * compareTo (or compare) method, so two keys that are + * {@code compareTo} (or {@code compare}) method, so two keys that are * deemed equal by this method are, from the standpoint of the sorted map, - * equal. The behavior of a tree map is well-defined even if its + * equal. The behavior of a tree map is well-defined even if its * ordering is inconsistent with equals; it just fails to obey the general - * contract of the Map interface. + * contract of the {@code Map} interface. * - *
All general-purpose sorted map implementation classes should - * provide four "standard" constructors: 1) A void (no arguments) - * constructor, which creates an empty sorted map sorted according to - * the natural ordering of its keys. 2) A constructor with a - * single argument of type Comparator, which creates an empty - * sorted map sorted according to the specified comparator. 3) A - * constructor with a single argument of type Map, which - * creates a new map with the same key-value mappings as its argument, - * sorted according to the keys' natural ordering. 4) A constructor - * with a single argument of type SortedMap, - * which creates a new sorted map with the same key-value mappings and - * the same ordering as the input sorted map. There is no way to - * enforce this recommendation, as interfaces cannot contain + *
All general-purpose sorted map implementation classes should provide four + * "standard" constructors: + *
Note: several methods return submaps with restricted key ranges. - * Such ranges are half-open, that is, they include their low + *
Note: several methods return submaps with restricted key + * ranges.Such ranges are half-open, that is, they include their low * endpoint but not their high endpoint (where applicable). If you need a - * closed range (which includes both endpoints), and the key type + * closed range (which includes both endpoints), and the key type * allows for calculation of the successor of a given key, merely request - * the subrange from lowEndpoint to - * successor(highEndpoint). For example, suppose that m + * the subrange from {@code lowEndpoint} to + * {@code successor(highEndpoint)}. For example, suppose that {@code m} * is a map whose keys are strings. The following idiom obtains a view - * containing all of the key-value mappings in m whose keys are - * between low and high, inclusive:
+ * containing all of the key-value mappings in {@code m} whose keys are
+ * between {@code low} and {@code high}, inclusive:
* SortedMap<String, V> sub = m.subMap(low, high+"\0");
*
- * A similar technique can be used to generate an open range
+ * A similar technique can be used to generate an open range
* (which contains neither endpoint). The following idiom obtains a
- * view containing all of the key-value mappings in m whose keys
- * are between low and high, exclusive:
+ * view containing all of the key-value mappings in {@code m} whose keys
+ * are between {@code low} and {@code high}, exclusive:
* SortedMap<String, V> sub = m.subMap(low+"\0", high);
*
* This interface is a member of the
@@ -112,96 +113,96 @@
public interface SortedMap extends Map {
/**
* Returns the comparator used to order the keys in this map, or
- * null if this map uses the {@linkplain Comparable
+ * {@code null} if this map uses the {@linkplain Comparable
* natural ordering} of its keys.
*
* @return the comparator used to order the keys in this map,
- * or null if this map uses the natural ordering
+ * or {@code null} if this map uses the natural ordering
* of its keys
*/
Comparator comparator();
/**
* Returns a view of the portion of this map whose keys range from
- * fromKey, inclusive, to toKey, exclusive. (If
- * fromKey and toKey are equal, the returned map
+ * {@code fromKey}, inclusive, to {@code toKey}, exclusive. (If
+ * {@code fromKey} and {@code toKey} are equal, the returned map
* is empty.) The returned map is backed by this map, so changes
* in the returned map are reflected in this map, and vice-versa.
* The returned map supports all optional map operations that this
* map supports.
*
- * The returned map will throw an IllegalArgumentException
+ *
The returned map will throw an {@code IllegalArgumentException}
* on an attempt to insert a key outside its range.
*
* @param fromKey low endpoint (inclusive) of the keys in the returned map
* @param toKey high endpoint (exclusive) of the keys in the returned map
* @return a view of the portion of this map whose keys range from
- * fromKey, inclusive, to toKey, exclusive
- * @throws ClassCastException if fromKey and toKey
+ * {@code fromKey}, inclusive, to {@code toKey}, exclusive
+ * @throws ClassCastException if {@code fromKey} and {@code toKey}
* cannot be compared to one another using this map's comparator
* (or, if the map has no comparator, using natural ordering).
* Implementations may, but are not required to, throw this
- * exception if fromKey or toKey
+ * exception if {@code fromKey} or {@code toKey}
* cannot be compared to keys currently in the map.
- * @throws NullPointerException if fromKey or toKey
+ * @throws NullPointerException if {@code fromKey} or {@code toKey}
* is null and this map does not permit null keys
- * @throws IllegalArgumentException if fromKey is greater than
- * toKey; or if this map itself has a restricted
- * range, and fromKey or toKey lies
+ * @throws IllegalArgumentException if {@code fromKey} is greater than
+ * {@code toKey}; or if this map itself has a restricted
+ * range, and {@code fromKey} or {@code toKey} lies
* outside the bounds of the range
*/
SortedMap subMap(K fromKey, K toKey);
/**
* Returns a view of the portion of this map whose keys are
- * strictly less than toKey. The returned map is backed
+ * strictly less than {@code toKey}. The returned map is backed
* by this map, so changes in the returned map are reflected in
* this map, and vice-versa. The returned map supports all
* optional map operations that this map supports.
*
- * The returned map will throw an IllegalArgumentException
+ *
The returned map will throw an {@code IllegalArgumentException}
* on an attempt to insert a key outside its range.
*
* @param toKey high endpoint (exclusive) of the keys in the returned map
* @return a view of the portion of this map whose keys are strictly
- * less than toKey
- * @throws ClassCastException if toKey is not compatible
+ * less than {@code toKey}
+ * @throws ClassCastException if {@code toKey} is not compatible
* with this map's comparator (or, if the map has no comparator,
- * if toKey does not implement {@link Comparable}).
+ * if {@code toKey} does not implement {@link Comparable}).
* Implementations may, but are not required to, throw this
- * exception if toKey cannot be compared to keys
+ * exception if {@code toKey} cannot be compared to keys
* currently in the map.
- * @throws NullPointerException if toKey is null and
+ * @throws NullPointerException if {@code toKey} is null and
* this map does not permit null keys
* @throws IllegalArgumentException if this map itself has a
- * restricted range, and toKey lies outside the
+ * restricted range, and {@code toKey} lies outside the
* bounds of the range
*/
SortedMap headMap(K toKey);
/**
* Returns a view of the portion of this map whose keys are
- * greater than or equal to fromKey. The returned map is
+ * greater than or equal to {@code fromKey}. The returned map is
* backed by this map, so changes in the returned map are
* reflected in this map, and vice-versa. The returned map
* supports all optional map operations that this map supports.
*
- * The returned map will throw an IllegalArgumentException
+ *
The returned map will throw an {@code IllegalArgumentException}
* on an attempt to insert a key outside its range.
*
* @param fromKey low endpoint (inclusive) of the keys in the returned map
* @return a view of the portion of this map whose keys are greater
- * than or equal to fromKey
- * @throws ClassCastException if fromKey is not compatible
+ * than or equal to {@code fromKey}
+ * @throws ClassCastException if {@code fromKey} is not compatible
* with this map's comparator (or, if the map has no comparator,
- * if fromKey does not implement {@link Comparable}).
+ * if {@code fromKey} does not implement {@link Comparable}).
* Implementations may, but are not required to, throw this
- * exception if fromKey cannot be compared to keys
+ * exception if {@code fromKey} cannot be compared to keys
* currently in the map.
- * @throws NullPointerException if fromKey is null and
+ * @throws NullPointerException if {@code fromKey} is null and
* this map does not permit null keys
* @throws IllegalArgumentException if this map itself has a
- * restricted range, and fromKey lies outside the
+ * restricted range, and {@code fromKey} lies outside the
* bounds of the range
*/
SortedMap tailMap(K fromKey);
@@ -228,12 +229,12 @@
* The set is backed by the map, so changes to the map are
* reflected in the set, and vice-versa. If the map is modified
* while an iteration over the set is in progress (except through
- * the iterator's own remove operation), the results of
+ * the iterator's own {@code remove} operation), the results of
* the iteration are undefined. The set supports element removal,
* which removes the corresponding mapping from the map, via the
- * Iterator.remove, Set.remove,
- * removeAll, retainAll, and clear
- * operations. It does not support the add or addAll
+ * {@code Iterator.remove}, {@code Set.remove},
+ * {@code removeAll}, {@code retainAll}, and {@code clear}
+ * operations. It does not support the {@code add} or {@code addAll}
* operations.
*
* @return a set view of the keys contained in this map, sorted in
@@ -248,13 +249,13 @@
* The collection is backed by the map, so changes to the map are
* reflected in the collection, and vice-versa. If the map is
* modified while an iteration over the collection is in progress
- * (except through the iterator's own remove operation),
+ * (except through the iterator's own {@code remove} operation),
* the results of the iteration are undefined. The collection
* supports element removal, which removes the corresponding
- * mapping from the map, via the Iterator.remove,
- * Collection.remove, removeAll,
- * retainAll and clear operations. It does not
- * support the add or addAll operations.
+ * mapping from the map, via the {@code Iterator.remove},
+ * {@code Collection.remove}, {@code removeAll},
+ * {@code retainAll} and {@code clear} operations. It does not
+ * support the {@code add} or {@code addAll} operations.
*
* @return a collection view of the values contained in this map,
* sorted in ascending key order
@@ -267,14 +268,14 @@
* The set is backed by the map, so changes to the map are
* reflected in the set, and vice-versa. If the map is modified
* while an iteration over the set is in progress (except through
- * the iterator's own remove operation, or through the
- * setValue operation on a map entry returned by the
+ * the iterator's own {@code remove} operation, or through the
+ * {@code setValue} operation on a map entry returned by the
* iterator) the results of the iteration are undefined. The set
* supports element removal, which removes the corresponding
- * mapping from the map, via the Iterator.remove,
- * Set.remove, removeAll, retainAll and
- * clear operations. It does not support the
- * add or addAll operations.
+ * mapping from the map, via the {@code Iterator.remove},
+ * {@code Set.remove}, {@code removeAll}, {@code retainAll} and
+ * {@code clear} operations. It does not support the
+ * {@code add} or {@code addAll} operations.
*
* @return a set view of the mappings contained in this map,
* sorted in ascending key order