01: /*
02: * Copyright (C) 2004 NNL Technology AB
03: * Visit www.infonode.net for information about InfoNode(R)
04: * products and how to contact NNL Technology AB.
05: *
06: * This program is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU General Public License
08: * as published by the Free Software Foundation; either version 2
09: * of the License, or (at your option) any later version.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * along with this program; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
19: * MA 02111-1307, USA.
20: */
21:
22: // $Id: Map.java,v 1.4 2004/09/22 14:35:05 jesper Exp $
23: package net.infonode.util.collection.map.base;
24:
25: import net.infonode.util.collection.Collection;
26:
27: /**
28: * A map.
29: *
30: * @author $Author: jesper $
31: * @version $Revision: 1.4 $
32: */
33: public interface Map extends ConstMap, Collection {
34: /**
35: * Associate a key with a value.
36: * This will overwrite any existing association.
37: *
38: * @param key the key
39: * @param value the value
40: * @return the old value associated with this key, null if no value existed
41: */
42: Object put(Object key, Object value);
43:
44: /**
45: * Removes a key and it's value.
46: *
47: * @param key the key
48: * @return the value associated with the key, null if no value existed
49: */
50: Object remove(Object key);
51:
52: /**
53: * Returns an iterator for this map.
54: *
55: * @return an iterator for this map
56: */
57: MapIterator iterator();
58: }
|