To implement an unmodifiable map, the programmer needs only to extend this - * class and provide an implementation for the entrySet method, which + * class and provide an implementation for the {@code entrySet} method, which * returns a set-view of the map's mappings. Typically, the returned set - * will, in turn, be implemented atop AbstractSet. This set should - * not support the add or remove methods, and its iterator - * should not support the remove method. + * will, in turn, be implemented atop {@code AbstractSet}. This set should + * not support the {@code add} or {@code remove} methods, and its iterator + * should not support the {@code remove} method. * *
To implement a modifiable map, the programmer must additionally override - * this class's put method (which otherwise throws an - * UnsupportedOperationException), and the iterator returned by - * entrySet().iterator() must additionally implement its - * remove method. + * this class's {@code put} method (which otherwise throws an + * {@code UnsupportedOperationException}), and the iterator returned by + * {@code entrySet().iterator()} must additionally implement its + * {@code remove} method. * *
The programmer should generally provide a void (no argument) and map - * constructor, as per the recommendation in the Map interface + * constructor, as per the recommendation in the {@code Map} interface * specification. * *
The documentation for each non-abstract method in this class describes its @@ -79,7 +79,7 @@ * {@inheritDoc} * * @implSpec - * This implementation returns entrySet().size(). + * This implementation returns {@code entrySet().size()}. */ public int size() { return entrySet().size(); @@ -89,7 +89,7 @@ * {@inheritDoc} * * @implSpec - * This implementation returns size() == 0. + * This implementation returns {@code size() == 0}. */ public boolean isEmpty() { return size() == 0; @@ -99,10 +99,10 @@ * {@inheritDoc} * * @implSpec - * This implementation iterates over entrySet() searching + * This implementation iterates over {@code entrySet()} searching * for an entry with the specified value. If such an entry is found, - * true is returned. If the iteration terminates without - * finding such an entry, false is returned. Note that this + * {@code true} is returned. If the iteration terminates without + * finding such an entry, {@code false} is returned. Note that this * implementation requires linear time in the size of the map. * * @throws ClassCastException {@inheritDoc} @@ -130,10 +130,10 @@ * {@inheritDoc} * * @implSpec - * This implementation iterates over entrySet() searching + * This implementation iterates over {@code entrySet()} searching * for an entry with the specified key. If such an entry is found, - * true is returned. If the iteration terminates without - * finding such an entry, false is returned. Note that this + * {@code true} is returned. If the iteration terminates without + * finding such an entry, {@code false} is returned. Note that this * implementation requires linear time in the size of the map; many * implementations will override this method. * @@ -162,10 +162,10 @@ * {@inheritDoc} * * @implSpec - * This implementation iterates over entrySet() searching + * This implementation iterates over {@code entrySet()} searching * for an entry with the specified key. If such an entry is found, * the entry's value is returned. If the iteration terminates without - * finding such an entry, null is returned. Note that this + * finding such an entry, {@code null} is returned. Note that this * implementation requires linear time in the size of the map; many * implementations will override this method. * @@ -198,7 +198,7 @@ * * @implSpec * This implementation always throws an - * UnsupportedOperationException. + * {@code UnsupportedOperationException}. * * @throws UnsupportedOperationException {@inheritDoc} * @throws ClassCastException {@inheritDoc} @@ -213,18 +213,18 @@ * {@inheritDoc} * * @implSpec - * This implementation iterates over entrySet() searching for an + * This implementation iterates over {@code entrySet()} searching for an * entry with the specified key. If such an entry is found, its value is - * obtained with its getValue operation, the entry is removed + * obtained with its {@code getValue} operation, the entry is removed * from the collection (and the backing map) with the iterator's - * remove operation, and the saved value is returned. If the - * iteration terminates without finding such an entry, null is + * {@code remove} operation, and the saved value is returned. If the + * iteration terminates without finding such an entry, {@code null} is * returned. Note that this implementation requires linear time in the * size of the map; many implementations will override this method. * *
Note that this implementation throws an - * UnsupportedOperationException if the entrySet - * iterator does not support the remove method and this map + * {@code UnsupportedOperationException} if the {@code entrySet} + * iterator does not support the {@code remove} method and this map * contains a mapping for the specified key. * * @throws UnsupportedOperationException {@inheritDoc} @@ -264,12 +264,12 @@ * * @implSpec * This implementation iterates over the specified map's - * entrySet() collection, and calls this map's put + * {@code entrySet()} collection, and calls this map's {@code put} * operation once for each entry returned by the iteration. * *
Note that this implementation throws an - * UnsupportedOperationException if this map does not support - * the put operation and the specified map is nonempty. + * {@code UnsupportedOperationException} if this map does not support + * the {@code put} operation and the specified map is nonempty. * * @throws UnsupportedOperationException {@inheritDoc} * @throws ClassCastException {@inheritDoc} @@ -285,11 +285,11 @@ * {@inheritDoc} * * @implSpec - * This implementation calls entrySet().clear(). + * This implementation calls {@code entrySet().clear()}. * *
Note that this implementation throws an - * UnsupportedOperationException if the entrySet - * does not support the clear operation. + * {@code UnsupportedOperationException} if the {@code entrySet} + * does not support the {@code clear} operation. * * @throws UnsupportedOperationException {@inheritDoc} */ @@ -314,10 +314,10 @@ * @implSpec * This implementation returns a set that subclasses {@link AbstractSet}. * The subclass's iterator method returns a "wrapper object" over this - * map's entrySet() iterator. The size method - * delegates to this map's size method and the - * contains method delegates to this map's - * containsKey method. + * map's {@code entrySet()} iterator. The {@code size} method + * delegates to this map's {@code size} method and the + * {@code contains} method delegates to this map's + * {@code containsKey} method. * *
The set is created the first time this method is called, * and returned in response to all subsequent calls. No synchronization @@ -371,10 +371,10 @@ * @implSpec * This implementation returns a collection that subclasses {@link * AbstractCollection}. The subclass's iterator method returns a - * "wrapper object" over this map's entrySet() iterator. - * The size method delegates to this map's size - * method and the contains method delegates to this map's - * containsValue method. + * "wrapper object" over this map's {@code entrySet()} iterator. + * The {@code size} method delegates to this map's {@code size} + * method and the {@code contains} method delegates to this map's + * {@code containsValue} method. * *
The collection is created the first time this method is called, and * returned in response to all subsequent calls. No synchronization is @@ -429,25 +429,25 @@ /** * Compares the specified object with this map for equality. Returns - * true if the given object is also a map and the two maps - * represent the same mappings. More formally, two maps m1 and - * m2 represent the same mappings if - * m1.entrySet().equals(m2.entrySet()). This ensures that the - * equals method works properly across different implementations - * of the Map interface. + * {@code true} if the given object is also a map and the two maps + * represent the same mappings. More formally, two maps {@code m1} and + * {@code m2} represent the same mappings if + * {@code m1.entrySet().equals(m2.entrySet())}. This ensures that the + * {@code equals} method works properly across different implementations + * of the {@code Map} interface. * * @implSpec * This implementation first checks if the specified object is this map; - * if so it returns true. Then, it checks if the specified + * if so it returns {@code true}. Then, it checks if the specified * object is a map whose size is identical to the size of this map; if - * not, it returns false. If so, it iterates over this map's - * entrySet collection, and checks that the specified map + * not, it returns {@code false}. If so, it iterates over this map's + * {@code entrySet} collection, and checks that the specified map * contains each mapping that this map contains. If the specified map - * fails to contain such a mapping, false is returned. If the - * iteration completes, true is returned. + * fails to contain such a mapping, {@code false} is returned. If the + * iteration completes, {@code true} is returned. * * @param o object to be compared for equality with this map - * @return true if the specified object is equal to this map + * @return {@code true} if the specified object is equal to this map */ public boolean equals(Object o) { if (o == this) @@ -483,13 +483,13 @@ /** * Returns the hash code value for this map. The hash code of a map is * defined to be the sum of the hash codes of each entry in the map's - * entrySet() view. This ensures that m1.equals(m2) - * implies that m1.hashCode()==m2.hashCode() for any two maps - * m1 and m2, as required by the general contract of + * {@code entrySet()} view. This ensures that {@code m1.equals(m2)} + * implies that {@code m1.hashCode()==m2.hashCode()} for any two maps + * {@code m1} and {@code m2}, as required by the general contract of * {@link Object#hashCode}. * * @implSpec - * This implementation iterates over entrySet(), calling + * This implementation iterates over {@code entrySet()}, calling * {@link Map.Entry#hashCode hashCode()} on each element (entry) in the * set, and adding up the results. * @@ -508,10 +508,10 @@ /** * Returns a string representation of this map. The string representation * consists of a list of key-value mappings in the order returned by the - * map's entrySet view's iterator, enclosed in braces - * ("{}"). Adjacent mappings are separated by the characters - * ", " (comma and space). Each key-value mapping is rendered as - * the key followed by an equals sign ("=") followed by the + * map's {@code entrySet} view's iterator, enclosed in braces + * ({@code "{}"}). Adjacent mappings are separated by the characters + * {@code ", "} (comma and space). Each key-value mapping is rendered as + * the key followed by an equals sign ({@code "="}) followed by the * associated value. Keys and values are converted to strings as by * {@link String#valueOf(Object)}. * @@ -538,7 +538,7 @@ } /** - * Returns a shallow copy of this AbstractMap instance: the keys + * Returns a shallow copy of this {@code AbstractMap} instance: the keys * and values themselves are not cloned. * * @return a shallow copy of this map @@ -570,11 +570,11 @@ /** * An Entry maintaining a key and a value. The value may be - * changed using the setValue method. This class + * changed using the {@code setValue} method. This class * facilitates the process of building custom map * implementations. For example, it may be convenient to return - * arrays of SimpleEntry instances in method - * Map.entrySet().toArray. + * arrays of {@code SimpleEntry} instances in method + * {@code Map.entrySet().toArray}. * * @since 1.6 */ @@ -689,7 +689,7 @@ /** * Returns a String representation of this map entry. This * implementation returns the string representation of this - * entry's key followed by the equals character ("=") + * entry's key followed by the equals character ("{@code =}") * followed by the string representation of this entry's value. * * @return a String representation of this map entry @@ -702,7 +702,7 @@ /** * An Entry maintaining an immutable key and value. This class - * does not support method setValue. This class may be + * does not support method {@code setValue}. This class may be * convenient in methods that return thread-safe snapshots of * key-value mappings. * @@ -760,7 +760,7 @@ /** * Replaces the value corresponding to this entry with the specified * value (optional operation). This implementation simply throws - * UnsupportedOperationException, as this class implements + * {@code UnsupportedOperationException}, as this class implements * an immutable map entry. * * @param value new value to be stored in this entry @@ -820,7 +820,7 @@ /** * Returns a String representation of this map entry. This * implementation returns the string representation of this - * entry's key followed by the equals character ("=") + * entry's key followed by the equals character ("{@code =}") * followed by the string representation of this entry's value. * * @return a String representation of this map entry