Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

EnumMap

extends AbstractMap<K, V>
implements Serializable Cloneable Map<K, V>

java.lang.Object
↳	java.util.AbstractMap<K, V>
	↳	java.util.EnumMap<K extends java.lang.Enum<K>, V>

Summary

Public Constructors
	EnumMap(Class<K> keyType) Constructs an empty enum map using the given key type.
	EnumMap(EnumMap<K, ? extends V> map) Constructs an enum map using the same key type as the given enum map and initially containing the same mappings.
	EnumMap(Map<K, ? extends V> map) Constructs an enum map initialized from the given map.

Public Methods
void	clear() Removes all mappings in this map.
EnumMap<K, V>	clone() Returns a shallow copy of this map.
boolean	containsKey(Object key) Returns true if this map has a mapping for the given key.
boolean	containsValue(Object value) Returns true if this map has one or more keys mapped to the given value.
Set<Entry<K, V>>	entrySet() Returns a Set} view of the mappings contained in this map.
boolean	equals(Object object) Compares the given object with this map.
V	get(Object key) Returns the value which is mapped to the given key in this map, or null if this map has no mapping for the given key.
Set<K>	keySet() Returns a Set} view of the keys contained in this map.
V	put(K key, V value) Associates the given value with the given key in this map.
void	putAll(Map<? extends K, ? extends V> map) Copies all the mappings in the given map to this map.
V	remove(Object key) Removes the mapping for this key from this map if it is present.
int	size() Returns the number of the mappings in this map.
Collection<V>	values() Returns a Collection} view of the values contained in this map.

[Expand]

Inherited Methods

From class java.util.AbstractMap

void	clear() Removes all elements from this Map, leaving it empty.
Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	containsKey(Object key) Searches this Map for the specified key.
boolean	containsValue(Object value) Searches this Map for the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a set view of the mappings contained in this map.
boolean	equals(Object object) Compares the specified object to this Map and answer if they are equal.
V	get(Object key) Returns the value of the mapping with the specified key.
int	hashCode() Returns an integer hash code for the receiver.
boolean	isEmpty() Returns if this Map has no elements, a size of zero.
Set<K>	keySet() Returns a Set of the keys contained in this Map.
V	put(K key, V value) Maps the specified key to the specified value.
void	putAll(Map<? extends K, ? extends V> map) Copies every mapping in the specified Map to this Map.
V	remove(Object key) Removes a mapping with the specified key from this Map.
int	size() Returns the number of elements in this Map.
String	toString() Returns the string representation of this Map.
Collection<V>	values() Returns a collection of the values contained in this map.

From class java.lang.Object

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
void	finalize() Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final Class<? extends Object>	getClass() Returns the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode() Returns an integer hash code for the receiver.
final void	notify() Causes one thread which is `wait` ing on the receiver to be made ready to run.
final void	notifyAll() Causes all threads which are `wait` ing on the receiver to be made ready to run.
String	toString() Returns a string containing a concise, human-readable description of the receiver.
final void	wait(long time, int frac) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait(long time) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait() Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

From interface java.util.Map

abstract void	clear() Removes all elements from this Map, leaving it empty.
abstract boolean	containsKey(Object key) Searches this Map for the specified key.
abstract boolean	containsValue(Object value) Searches this Map for the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a `Set` whose elements comprise all of the mappings that are to be found in this `Map`.
abstract boolean	equals(Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
abstract V	get(Object key) Returns the value of the mapping with the specified key.
abstract int	hashCode() Returns an integer hash code for the receiver.
abstract boolean	isEmpty() Returns if this Map has no elements, a size of zero.
abstract Set<K>	keySet() Returns a Set of the keys contained in this Map.
abstract V	put(K key, V value) Maps the specified key to the specified value.
abstract void	putAll(Map<? extends K, ? extends V> map) Copies every mapping in the specified Map to this Map.
abstract V	remove(Object key) Removes a mapping with the specified key from this Map.
abstract int	size() Returns the number of elements in this Map.
abstract Collection<V>	values() Returns all of the current `Map` values in a `Collection`.

Public Constructors

public EnumMap (Class<K> keyType)

Constructs an empty enum map using the given key type.

Parameters

keyType	the class object of the key type used by this enum map

Throws

NullPointerException	if the keyType is null

public EnumMap (EnumMap<K, ? extends V> map)

Constructs an enum map using the same key type as the given enum map and initially containing the same mappings.

Parameters

map	the enum map from which this enum map is initialized

Throws

NullPointerException	if the map is null

public EnumMap (Map<K, ? extends V> map)

Constructs an enum map initialized from the given map. If the given map is an EnumMap instance, this constructor behaves in the exactly the same way as EnumMap(EnumMap)}. Otherwise, the given map at least should contain one mapping.

Parameters

map	the map from which this enum map is initialized

Throws

IllegalArgumentException	if the map is not an enum map instance and does not contain any mappings
NullPointerException	if the map is null

Public Methods

public void clear ()

Removes all mappings in this map.

public EnumMap<K, V> clone ()

Returns a shallow copy of this map.

Returns

a shallow copy of this map

public boolean containsKey (Object key)

Returns true if this map has a mapping for the given key.

Parameters

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

Returns

true if this map has a mapping for the given key.

public boolean containsValue (Object value)

Returns true if this map has one or more keys mapped to the given value.

Parameters

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

Returns

true if this map has one or more keys mapped to the given value.

public Set<Entry<K, V>> entrySet ()

Returns a Set} view of the mappings contained in this map. The returned set complies with the general rule specified in entrySet()}. The set's iterator will return the mappings in the their keys' natural order(the enum constants are declared in this order)

Returns

a set view of the mappings contained in this map.

public boolean equals (Object object)

Compares the given object with this map. Returns true if the given object is equal to this map.

Parameters

object	the object to be compared with this map

Returns

true if the given object is equal to this map.

public V get (Object key)

Returns the value which is mapped to the given key in this map, or null if this map has no mapping for the given key.

Parameters

key	the key whose associated value is to be returned

Returns

the value to which this map maps the given key, or null if this map has no mapping for the given key.

public Set<K> keySet ()

Returns a Set} view of the keys contained in this map. The returned set complies with the general rule specified in keySet()}. The set's iterator will return the keys in the their natural order(the enum constants are declared in this order)

Returns

a set view of the keys contained in this map.

public V put (K key, V value)

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

Parameters

key	the key with which the given value is to be associated value
value	the value to be associated with the given key

Returns

the value to which this map maps the given key, or null if this map has no mapping for the given key.

Throws

NullPointerException	if the given key is null

public void putAll (Map<? extends K, ? extends V> map)

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

Parameters

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

Throws

NullPointerException	if the given map is null, or if one or more keys in the given map are null

public V remove (Object key)

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

Parameters

key	the key whose mapping is to be removed from this map

Returns

the previous value associated with the given key, or null if this map has no mapping for this key.

public int size ()

Returns the number of the mappings in this map.

Returns

the number of the mappings in this map

public Collection<V> values ()

Returns a Collection} view of the values contained in this map. The returned collection complys with the general rule specified in values()}. The collection's iterator will return the values in the their corresponding keys' natural order(the enum constants are declared in this order)

Returns

a collection view of the mappings contained in this map.

Feb	MAR	Apr
	09
2008	2009	2010

Interfaces

Classes

Enums

Exceptions

EnumMap

Summary

Public Constructors

public EnumMap (Class<K> keyType)

Parameters

Throws

public EnumMap (EnumMap<K, ? extends V> map)

Parameters

Throws

public EnumMap (Map<K, ? extends V> map)

Parameters

Throws

Public Methods

public void clear ()

public EnumMap<K, V> clone ()

Returns

public boolean containsKey (Object key)

Parameters

Returns

public boolean containsValue (Object value)

Parameters

Returns

public Set<Entry<K, V>> entrySet ()

Returns

public boolean equals (Object object)

Parameters

Returns

public V get (Object key)

Parameters

Returns

public Set<K> keySet ()

Returns

public V put (K key, V value)

Parameters

Returns

Throws

public void putAll (Map<? extends K, ? extends V> map)

Parameters

Throws

public V remove (Object key)

Parameters

Returns

public int size ()

Returns

public Collection<V> values ()

Returns