|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class EnumMap<K extends
Enum<K>,V>
java.util.EnumMap<K,V>
All Implemented Interfaces:
public class
EnumMap<K extends Enum<K>,V>
A specialized
Map 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 (keySet(),
entrySet(), and values()).
Iterators returned by the collection views are weakly consistent:
they will never throw ConcurrentModificationException 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 NullPointerException. 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 Collections.synchronizedMap(Map)
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
HashMap counterparts.
This class is a member of the
Java Collections Framework.
Since:
1.5
Author:
Josh Bloch
See Also:
Nested classes/interfaces inherited from class java.util. AbstractMap |
|
Nested classes/interfaces inherited from interface java.util. Map |
|
Constructor Summary |
Creates an empty enum map with the specified key type.
|
Creates an enum map with the same key type as the specified enum
map, initially containing the same mappings (if any).
|
Creates an enum map initialized from the specified map.
|
Method Summary |
void |
Removes all mappings from this map.
|
|
Returns a shallow copy of this enum map.
|
boolean |
Returns true if this map contains a mapping for the specified
key.
|
boolean |
Returns true if this map maps one or more keys to the
specified value.
|
|
Returns a Set view of the mappings contained in this map.
|
boolean |
Compares the specified object with this map for equality.
|
|
Returns the value to which the specified key is mapped,
or null if this map contains no mapping for the key.
|
int |
Returns the hash code value for this map.
|
|
Returns a Set view of the keys contained in this map.
|
|
Associates the specified value with the specified key in this map.
|
void |
Copies all of the mappings from the specified map to this map.
|
|
Removes the mapping for this key from this map if present.
|
int |
Returns the number of key-value mappings in this map.
|
|
Returns a Collection view of the values contained in this map.
|
Methods inherited from class java.lang. Object |
|
Methods inherited from interface java.util. Map |
compute, computeIfAbsent, computeIfPresent, copyOf, entry, forEach, getOrDefault, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll |
Creates an empty enum map with the specified key type.
Parameters:
keyType - the class object of the key type for this enum map
Throws:
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:
Creates an enum map initialized from the specified map. If the
specified map is an
EnumMap instance, this constructor behaves
identically to
EnumMap(EnumMap). 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:
Returns the number of key-value mappings in this map.
Specified by:
Overrides:
Returns:
the number of key-value mappings in this map
public boolean containsValue |
|
Returns
true if this map maps one or more keys to the
specified value.
Specified by:
Overrides:
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 boolean containsKey |
|
Returns
true if this map contains a mapping for the specified
key.
Specified by:
Overrides:
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
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 containsKey operation may be used to
distinguish these two cases.
Specified by:
Overrides:
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
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.
Specified by:
Overrides:
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:
Removes the mapping for this key from this map if present.
Specified by:
Overrides:
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 void putAll |
( Map<? 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.
Specified by:
Overrides:
Parameters:
m - the mappings to be stored in this map
Throws:
NullPointerException - the specified map is null, or if
one or more keys in the specified map are null
Removes all mappings from this map.
Specified by:
Overrides:
Returns a
Set view of the keys contained in this map.
The returned set obeys the general contract outlined in
Map.keySet(). The set's iterator will return the keys
in their natural order (the order in which the enum constants
are declared).
Specified by:
Overrides:
Returns:
a set view of the keys contained in this enum map
Returns a
Collection view of the values contained in this map.
The returned collection obeys the general contract outlined in
Map.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).
Specified by:
Overrides:
Returns:
a collection view of the values contained in this map
Returns a
Set view of the mappings contained in this map.
The returned set obeys the general contract outlined in
Map.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).
Specified by:
Overrides:
Returns:
a set view of the mappings contained in this enum map
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
Map.equals(Object) contract.
Specified by:
Overrides:
Parameters:
o - the object to be compared for equality with this map
Returns:
true if the specified object is equal to this map
See Also:
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.
Specified by:
Overrides:
Returns:
the hash code value for this map
See Also:
Returns a shallow copy of this enum map. The values themselves
are not cloned.
Overrides:
Returns:
a shallow copy of this enum map
See Also:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz