# EnumMap

public class **EnumMap** extends [AbstractMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html)\<K extends [Enum](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Enum.html)\<K\>, V\>  
implements [Serializable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Serializable.html) [Cloneable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Cloneable.html) A specialized `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html` implementation for use with enum type keys. All
of the keys in an enum map must come from a single enum type that is
specified, explicitly or implicitly, when the map is created. Enum maps
are represented internally as arrays. This representation is extremely
compact and efficient.

Enum maps are maintained in the *natural order* of their keys
(the order in which the enum constants are declared). This is reflected
in the iterators returned by the collections views (`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#keySet()`,
`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#entrySet()`, and `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#values()`).

Iterators returned by the collection views are *weakly consistent*:
they will never throw `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/ConcurrentModificationException.html` and they may
or may not show the effects of any modifications to the map that occur while
the iteration is in progress.

Null keys are not permitted. Attempts to insert a null key will
throw `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html`. Attempts to test for the
presence of a null key or to remove one will, however, function properly.
Null values are permitted.

Like most collection implementations EnumMap is not
synchronized. If multiple threads access an enum map concurrently, and at
least one of the threads modifies the map, it should be synchronized
externally. This is typically accomplished by synchronizing on some
object that naturally encapsulates the enum map. If no such object exists,
the map should be "wrapped" using the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collections.html#synchronizedMap(java.util.Map<K,%20V>)`
method. This is best done at creation time, to prevent accidental
unsynchronized access:

```
     Map<EnumKey, V> m
         = Collections.synchronizedMap(new EnumMap<EnumKey, V>(...));
 
```

Implementation note: All basic operations execute in constant time.
They are likely (though not guaranteed) to be faster than their
`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/HashMap.html` counterparts.

This class is a member of the
[Java Collections Framework](https://developers.google.com/j2objc/javadoc/jre/openjdk-redirect.html?v=8&path=/technotes/guides/collections/index.html).

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumSet.html`

### Public Constructor Summary

|---|---|
|   | [EnumMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#EnumMap(java.lang.Class<K>))([Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<K\> keyType) Creates an empty enum map with the specified key type. |
|   | [EnumMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#EnumMap(java.util.EnumMap<K,%20?%20extends%20V>))([EnumMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html)\<K, ? extends V\> m) Creates an enum map with the same key type as the specified enum map, initially containing the same mappings (if any). |
|   | [EnumMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#EnumMap(java.util.Map<K,%20?%20extends%20V>))([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<K, ? extends V\> m) Creates an enum map initialized from the specified map. |

### Public Method Summary

|---|---|
| void | [clear](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#clear())() Removes all mappings from this map. |
| [EnumMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html)\<K, V\> | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#clone())() Returns a shallow copy of this enum map. |
| boolean | [containsKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#containsKey(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Returns true if this map contains a mapping for the specified key. |
| boolean | [containsValue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#containsValue(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value) Returns true if this map maps one or more keys to the specified value. |
| [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<[Entry](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.Entry.html)\<K, V\>\> | [entrySet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#entrySet())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html` view of the mappings contained in this map. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Compares the specified object with this map for equality. |
| V | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#get(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#hashCode())() Returns the hash code value for this map. |
| [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<K\> | [keySet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#keySet())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html` view of the keys contained in this map. |
| V | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#put(K,%20V))(K key, V value) Associates the specified value with the specified key in this map. |
| void | [putAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#putAll(java.util.Map<?%20extends%20K,%20?%20extends%20V>))([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<? extends K, ? extends V\> m) Copies all of the mappings from the specified map to this map. |
| V | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#remove(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Removes the mapping for this key from this map if present. |
| int | [size](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#size())() Returns the number of key-value mappings in this map. |
| [Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<V\> | [values](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#values())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html` view of the values contained in this map. |

### Inherited Method Summary

From class [java.util.AbstractMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html)

|---|---|
| void | [clear](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#clear())() Removes all of the mappings from this map (optional operation). |
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#clone())() Returns a shallow copy of this AbstractMap instance: the keys and values themselves are not cloned. |
| boolean | [containsKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#containsKey(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Returns `true` if this map contains a mapping for the specified key. |
| boolean | [containsValue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#containsValue(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value) Returns `true` if this map maps one or more keys to the specified value. |
| abstract [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<[Entry](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.Entry.html)\<K, V\>\> | [entrySet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#entrySet())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html` view of the mappings contained in this map. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Compares the specified object with this map for equality. |
| V | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#get(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#hashCode())() Returns the hash code value for this map. |
| boolean | [isEmpty](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#isEmpty())() Returns `true` if this map contains no key-value mappings. |
| [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<K\> | [keySet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#keySet())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html` view of the keys contained in this map. |
| V | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#put(K,%20V))(K key, V value) Associates the specified value with the specified key in this map (optional operation). |
| void | [putAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#putAll(java.util.Map<?%20extends%20K,%20?%20extends%20V>))([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<? extends K, ? extends V\> m) Copies all of the mappings from the specified map to this map (optional operation). |
| V | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#remove(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Removes the mapping for a key from this map if it is present (optional operation). |
| int | [size](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#size())() Returns the number of key-value mappings in this map. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#toString())() Returns a string representation of this map. |
| [Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<V\> | [values](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/AbstractMap.html#values())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html` view of the values contained in this map. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.util.Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)

|---|---|
| abstract void | [clear](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#clear())() Removes all of the mappings from this map (optional operation). |
| V | [compute](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#compute(K,%20java.util.function.BiFunction<?%20super%20K,%20?%20super%20V,%20?%20extends%20V>))(K key, [BiFunction](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BiFunction.html)\<? super K, ? super V, ? extends V\> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (or `null` if there is no current mapping). |
| V | [computeIfAbsent](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#computeIfAbsent(K,%20java.util.function.Function<?%20super%20K,%20?%20extends%20V>))(K key, [Function](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/Function.html)\<? super K, ? extends V\> mappingFunction) If the specified key is not already associated with a value (or is mapped to `null`), attempts to compute its value using the given mapping function and enters it into this map unless `null`. |
| V | [computeIfPresent](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#computeIfPresent(K,%20java.util.function.BiFunction<?%20super%20K,%20?%20super%20V,%20?%20extends%20V>))(K key, [BiFunction](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BiFunction.html)\<? super K, ? super V, ? extends V\> remappingFunction) If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value. |
| abstract boolean | [containsKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#containsKey(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Returns `true` if this map contains a mapping for the specified key. |
| abstract boolean | [containsValue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#containsValue(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value) Returns `true` if this map maps one or more keys to the specified value. |
| abstract [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<[Entry](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.Entry.html)\<K, V\>\> | [entrySet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#entrySet())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html` view of the mappings contained in this map. |
| abstract boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o) Compares the specified object with this map for equality. |
| void | [forEach](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#forEach(java.util.function.BiConsumer<?%20super%20K,%20?%20super%20V>))([BiConsumer](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BiConsumer.html)\<? super K, ? super V\> action) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. |
| abstract V | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#get(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. |
| V | [getOrDefault](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#getOrDefault(java.lang.Object,%20V))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key, V defaultValue) Returns the value to which the specified key is mapped, or `defaultValue` if this map contains no mapping for the key. |
| abstract int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#hashCode())() Returns the hash code value for this map. |
| abstract boolean | [isEmpty](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#isEmpty())() Returns `true` if this map contains no key-value mappings. |
| abstract [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<K\> | [keySet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#keySet())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html` view of the keys contained in this map. |
| V | [merge](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#merge(K,%20V,%20java.util.function.BiFunction<?%20super%20V,%20?%20super%20V,%20?%20extends%20V>))(K key, V value, [BiFunction](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BiFunction.html)\<? super V, ? super V, ? extends V\> remappingFunction) If the specified key is not already associated with a value or is associated with null, associates it with the given non-null value. |
| abstract V | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#put(K,%20V))(K key, V value) Associates the specified value with the specified key in this map (optional operation). |
| abstract void | [putAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#putAll(java.util.Map<?%20extends%20K,%20?%20extends%20V>))([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<? extends K, ? extends V\> m) Copies all of the mappings from the specified map to this map (optional operation). |
| V | [putIfAbsent](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#putIfAbsent(K,%20V))(K key, V value) If the specified key is not already associated with a value (or is mapped to `null`) associates it with the given value and returns `null`, else returns the current value. |
| boolean | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#remove(java.lang.Object,%20java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value) Removes the entry for the specified key only if it is currently mapped to the specified value. |
| abstract V | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#remove(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key) Removes the mapping for a key from this map if it is present (optional operation). |
| boolean | [replace](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#replace(K,%20V,%20V))(K key, V oldValue, V newValue) Replaces the entry for the specified key only if currently mapped to the specified value. |
| V | [replace](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#replace(K,%20V))(K key, V value) Replaces the entry for the specified key only if it is currently mapped to some value. |
| void | [replaceAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#replaceAll(java.util.function.BiFunction<?%20super%20K,%20?%20super%20V,%20?%20extends%20V>))([BiFunction](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BiFunction.html)\<? super K, ? super V, ? extends V\> function) Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception. |
| abstract int | [size](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#size())() Returns the number of key-value mappings in this map. |
| abstract [Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<V\> | [values](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#values())() Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html` view of the values contained in this map. |

## Public Constructors

#### public
**EnumMap**
([Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<K\> keyType)

Creates an empty enum map with the specified key type.

##### Parameters

| keyType | the class object of the key type for this enum map |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if keyType is null |
|---|---|

#### public
**EnumMap**
([EnumMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html)\<K, ? extends V\> m)

Creates an enum map with the same key type as the specified enum
map, initially containing the same mappings (if any).

##### Parameters

| m | the enum map from which to initialize this enum map |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if m is null |
|---|---|

#### public
**EnumMap**
([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<K, ? extends V\> m)

Creates an enum map initialized from the specified map. If the
specified map is an EnumMap instance, this constructor behaves
identically to `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#EnumMap(java.util.EnumMap<K,%20?%20extends%20V>)`. Otherwise, the specified map
must contain at least one mapping (in order to determine the new
enum map's key type).

##### Parameters

| m | the map from which to initialize this enum map |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if m is not an EnumMap instance and contains no mappings |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if m is null |
|---|---|

## Public Methods

#### public void
**clear**
()

Removes all mappings from this map.

#### public [EnumMap](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html)\<K, V\>
**clone**
()

Returns a shallow copy of this enum map. (The values themselves
are not cloned.

##### Returns

- a shallow copy of this enum map

#### public boolean
**containsKey**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key)

Returns true if this map contains a mapping for the specified
key.

##### Parameters

| key | the key whose presence in this map is to be tested |
|---|---|

##### Returns

- true if this map contains a mapping for the specified key

#### public boolean
**containsValue**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value)

Returns true if this map maps one or more keys to the
specified value.

##### Parameters

| value | the value whose presence in this map is to be tested |
|---|---|

##### Returns

- true if this map maps one or more keys to this value

#### public [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<[Entry](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.Entry.html)\<K, V\>\>
**entrySet**
()

Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html` view of the mappings contained in this map.
The returned set obeys the general contract outlined in
`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#keySet()`. The set's iterator will return the
mappings in the order their keys appear in map, which is their
natural order (the order in which the enum constants are declared).

##### Returns

- a set view of the mappings contained in this enum map

#### public boolean
**equals**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) o)

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, as specified in the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#equals(java.lang.Object)` contract.

##### Parameters

| o | the object to be compared for equality with this map |
|---|---|

##### Returns

- true if the specified object is equal to this map

#### public V
**get**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key)

Returns the value to which the specified key is mapped,
or `null` if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key
`k` to a value `v` such that `(key == k)`,
then this method returns `v`; otherwise it returns
`null`. (There can be at most one such mapping.)

A return value of `null` does not *necessarily*
indicate that the map contains no mapping for the key; it's also
possible that the map explicitly maps the key to `null`.
The `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/EnumMap.html#containsKey(java.lang.Object)` operation may be used to
distinguish these two cases.

##### Parameters

| key | the key whose associated value is to be returned |
|---|---|

##### Returns

- the value to which the specified key is mapped, or `null` if this map contains no mapping for the key

#### public int
**hashCode**
()

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.

##### Returns

- the hash code value for this map

#### public [Set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html)\<K\>
**keySet**
()

Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Set.html` view of the keys contained in this map.
The returned set obeys the general contract outlined in
`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#keySet()`. The set's iterator will return the keys
in their natural order (the order in which the enum constants
are declared).

##### Returns

- a set view of the keys contained in this enum map

#### public V
**put**
(K key, V value)

Associates the specified value with the specified key in this map.
If the map previously contained a mapping for this key, the old
value is replaced.

##### Parameters

| key | the key with which the specified value is to be associated |
| value | the value to be associated with the specified key |
|---|---|

##### Returns

- the previous value associated with specified key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with the specified key.)

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if the specified key is null |
|---|---|

#### public void
**putAll**
([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<? extends K, ? extends V\> m)

Copies all of the mappings from the specified map to this map.
These mappings will replace any mappings that this map had for
any of the keys currently in the specified map.

##### Parameters

| m | the mappings to be stored in this map |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | the specified map is null, or if one or more keys in the specified map are null |
|---|---|

#### public V
**remove**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) key)

Removes the mapping for this key from this map if present.

##### Parameters

| key | the key whose mapping is to be removed from the map |
|---|---|

##### Returns

- the previous value associated with specified key, or null if there was no entry for key. (A null return can also indicate that the map previously associated null with the specified key.)

#### public int
**size**
()

Returns the number of key-value mappings in this map.

##### Returns

- the number of key-value mappings in this map

#### public [Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<V\>
**values**
()

Returns a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html` view of the values contained in this map.
The returned collection obeys the general contract outlined in
`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html#values()`. The collection's iterator will return the
values in the order their corresponding keys appear in map,
which is their natural order (the order in which the enum constants
are declared).

##### Returns

- a collection view of the values contained in this map