| 1 | /* Map.java: interface Map -- An object that maps keys to values
|
|---|
| 2 | interface Map.Entry -- an Entry in a Map
|
|---|
| 3 | Copyright (C) 1998, 2001 Free Software Foundation, Inc.
|
|---|
| 4 |
|
|---|
| 5 | This file is part of GNU Classpath.
|
|---|
| 6 |
|
|---|
| 7 | GNU Classpath is free software; you can redistribute it and/or modify
|
|---|
| 8 | it under the terms of the GNU General Public License as published by
|
|---|
| 9 | the Free Software Foundation; either version 2, or (at your option)
|
|---|
| 10 | any later version.
|
|---|
| 11 |
|
|---|
| 12 | GNU Classpath is distributed in the hope that it will be useful, but
|
|---|
| 13 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 15 | General Public License for more details.
|
|---|
| 16 |
|
|---|
| 17 | You should have received a copy of the GNU General Public License
|
|---|
| 18 | along with GNU Classpath; see the file COPYING. If not, write to the
|
|---|
| 19 | Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
|
|---|
| 20 | 02111-1307 USA.
|
|---|
| 21 |
|
|---|
| 22 | Linking this library statically or dynamically with other modules is
|
|---|
| 23 | making a combined work based on this library. Thus, the terms and
|
|---|
| 24 | conditions of the GNU General Public License cover the whole
|
|---|
| 25 | combination.
|
|---|
| 26 |
|
|---|
| 27 | As a special exception, the copyright holders of this library give you
|
|---|
| 28 | permission to link this library with independent modules to produce an
|
|---|
| 29 | executable, regardless of the license terms of these independent
|
|---|
| 30 | modules, and to copy and distribute the resulting executable under
|
|---|
| 31 | terms of your choice, provided that you also meet, for each linked
|
|---|
| 32 | independent module, the terms and conditions of the license of that
|
|---|
| 33 | module. An independent module is a module which is not derived from
|
|---|
| 34 | or based on this library. If you modify this library, you may extend
|
|---|
| 35 | this exception to your version of the library, but you are not
|
|---|
| 36 | obligated to do so. If you do not wish to do so, delete this
|
|---|
| 37 | exception statement from your version. */
|
|---|
| 38 |
|
|---|
| 39 |
|
|---|
| 40 | package java.util;
|
|---|
| 41 |
|
|---|
| 42 | /**
|
|---|
| 43 | * An object that maps keys onto values. Keys cannot be duplicated. This
|
|---|
| 44 | * interface replaces the obsolete {@link Dictionary} abstract class.
|
|---|
| 45 | * <p>
|
|---|
| 46 | *
|
|---|
| 47 | * The map has three collection views, which are backed by the map
|
|---|
| 48 | * (modifications on one show up on the other): a set of keys, a collection
|
|---|
| 49 | * of values, and a set of key-value mappings. Some maps have a guaranteed
|
|---|
| 50 | * order, but not all do.
|
|---|
| 51 | * <p>
|
|---|
| 52 | *
|
|---|
| 53 | * Note: Be careful about using mutable keys. Behavior is unspecified if
|
|---|
| 54 | * a key's comparison behavior is changed after the fact. As a corollary
|
|---|
| 55 | * to this rule, don't use a Map as one of its own keys or values, as it makes
|
|---|
| 56 | * hashCode and equals have undefined behavior.
|
|---|
| 57 | * <p>
|
|---|
| 58 | *
|
|---|
| 59 | * All maps are recommended to provide a no argument constructor, which builds
|
|---|
| 60 | * an empty map, and one that accepts a Map parameter and copies the mappings
|
|---|
| 61 | * (usually by putAll), to create an equivalent map. Unfortunately, Java
|
|---|
| 62 | * cannot enforce these suggestions.
|
|---|
| 63 | * <p>
|
|---|
| 64 | *
|
|---|
|
|---|
