| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Map map = new HashMap();
Based on 17 examples
public interface Map
An object that maps keys to values. A map cannot contain duplicate keys; each key can map to at most one value.
This interface takes the place of the Dictionary class, which was a totally abstract class rather than an interface.
The Map interface provides three collection views, which allow a map's contents to be viewed as a set of keys, collection of values, or set of key-value mappings. The order of a map is defined as the order in which the iterators on the map's collection views return their elements. Some map implementations, like the TreeMap class, make specific guarantees as to their order; others, like the HashMap class, do not.
Note: great care must be exercised if mutable objects are used as map keys. The behavior of a map is not specified if the value of an object is changed in a manner that affects equals comparisons while the object is a key in the map. A special case of this prohibition is that it is not permissible for a map to contain itself as a key. While it is permissible for a map to contain itself as a value, extreme caution is advised: the equals and hashCode methods are no longer well defined on such a map.
All general-purpose map implementation classes should provide two "standard" constructors: a void (no arguments) constructor which creates an empty map, and a constructor with a single argument of type Map, which creates a new map with the same key-value mappings as its argument. In effect, the latter constructor allows the user to copy any map, producing an equivalent map of the desired class. There is no way to enforce this recommendation (as interfaces cannot contain constructors) but all of the general-purpose map implementations in the JDK comply.
The "destructive" methods contained in this interface, that is, the methods that modify the map on which they operate, are specified to throw UnsupportedOperationException if this map does not support the operation. If this is the case, these methods may, but are not required to, throw an UnsupportedOperationException if the invocation would have no effect on the map. For example, invoking the {@link #putAll(Map)} method on an unmodifiable map may, but is not required to, throw the exception if the map whose mappings are to be "superimposed" is empty.
Some map implementations have restrictions on the keys and values they may contain. For example, some implementations prohibit null keys and values, and some have restrictions on the types of their keys. Attempting to insert an ineligible key or value throws an unchecked exception, typically NullPointerException or ClassCastException. Attempting to query the presence of an ineligible key or value may throw an exception, or it may simply return false; some implementations will exhibit the former behavior and some will exhibit the latter. More generally, attempting an operation on an ineligible key or value whose completion would not result in the insertion of an ineligible element into the map may throw an exception or it may succeed, at the option of the implementation. Such exceptions are marked as "optional" in the specification for this interface.
This interface is a member of the Java Collections Framework.
Many methods in Collections Framework interfaces are defined in terms of the {@link Object#equals(Object) equals} method. For example, the specification for the {@link #containsKey(Object) containsKey(Object key)} method says: "returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k))." This specification should not be construed to imply that invoking Map.containsKey with a non-null argument key will cause key.equals(k) to be invoked for any key k. Implementations are free to implement optimizations whereby the equals invocation is avoided, for example, by first comparing the hash codes of the two keys. (The {@link Object#hashCode()} specification guarantees that two objects with unequal hash codes cannot be equal.) More generally, implementations of the various Collections Framework interfaces are free to take advantage of the specified behavior of underlying {@link Object} methods wherever the implementor deems it appropriate.
Nested Class Summary | |
---|---|
static interface |
A map entry (key-value pair). |
Method Summary | |
---|---|
void |
clear() Removes all of the mappings from this map (optional operation). |
boolean |
containsKey(Object key) Returns true if this map contains a mapping for the specified key. |
boolean |
containsValue(Object value) Returns true if this map maps one or more keys to the specified value. |
Set |
entrySet() Returns a java.util.Set view of the mappings contained in this map. |
boolean |
Compares the specified object with this map for equality. |
Object |
Returns the value to which the specified key is mapped, or if this map contains no mapping for the key. |
int |
hashCode() Returns the hash code value for this map. |
boolean |
isEmpty() Returns true if this map contains no key-value mappings. |
Set |
keySet() Returns a java.util.Set view of the keys contained in this map. |
Object |
Associates the specified value with the specified key in this map (optional operation). |
void |
Copies all of the mappings from the specified map to this map (optional operation). |
Object |
Removes the mapping for a key from this map if it is present (optional operation). |
int |
size() Returns the number of key-value mappings in this map. |
Collection |
values() Returns a java.util.Collection view of the values contained in this map. |
Method Detail |
---|
public void clear()
public boolean containsKey(Object key)
key
- key whose presence in this map is to be testedpublic boolean containsValue(Object value)
value
- value whose presence in this map is to be testedpublic Set entrySet()
public boolean equals(Object o)
equals
in class Object
o
- object to be compared for equality with this mappublic Object get(Object key)
More formally, if this map contains a mapping from a key {@code k} to a value {@code v} such that {@code (key==null ? k==null : key.equals(k))}, then this method returns {@code v}; otherwise it returns {@code null}. (There can be at most one such mapping.)
If this map permits null values, then a return value of {@code 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 {@code null}. The {@link #containsKey containsKey} operation may be used to distinguish these two cases.
key
- the key whose associated value is to be returnedpublic int hashCode()
hashCode
in class Object
public boolean isEmpty()
public Set keySet()
public Object put(Object key, Object value)
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified keypublic void putAll(Map m)
m
- mappings to be stored in this mappublic Object remove(Object key)
(key==null ? k==null : key.equals(k))
, that mapping
is removed. (The map can contain at most one such mapping.)
Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.
If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.
The map will not contain a mapping for the specified key once the call returns.
key
- key whose mapping is to be removed from the mappublic int size()
public Collection values()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |