View Javadoc

1   /*
2    *  Copyright 2003-2004 The Apache Software Foundation
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package net.sf.collections15;
17  
18  import java.util.Map;
19  
20  /***
21   * Defines a map that can be iterated directly without needing to create an
22   * entry set.
23   * <p/>
24   * A map iterator is an efficient way of iterating over maps. There is no need
25   * to access the entry set or cast to Map Entry objects.
26   * <pre>
27   * IterableMap map = new HashedMap();
28   * MapIterator it = map.mapIterator();
29   * while (it.hasNext()) {
30   *   Object key = it.next();
31   *   Object value = it.getValue();
32   *   it.setValue("newValue");
33   * }
34   * </pre>
35   *
36   * @author Stephen Colebourne
37   * @version $Revision: 1.2 $ $Date: 2004/10/17 01:02:42 $
38   * @since Commons Collections15 1.0
39   */
40  public interface IterableMap <K, V> extends Map<K, V>
41  {
42  
43      /***
44       * Obtains a <code>MapIterator</code> over the map.
45       * <p/>
46       * A map iterator is an efficient way of iterating over maps. There is no
47       * need to access the entry set or cast to Map Entry objects.
48       * <pre>
49       * IterableMap map = new HashedMap();
50       * MapIterator it = map.mapIterator();
51       * while (it.hasNext()) {
52       *   Object key = it.next();
53       *   Object value = it.getValue();
54       *   it.setValue("newValue");
55       * }
56       * </pre>
57       *
58       * @return a map iterator
59       */
60      MapIterator<K, V> mapIterator();
61  
62  }