View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.collections4;
18  
19  /**
20   * The "read" subset of the {@link java.util.Map} interface.
21   *
22   * @param <K> the type of the keys in this map
23   * @param <V> the type of the values in this map
24   * @since 4.0
25   * @see Put
26   */
27  public interface IterableGet<K, V> extends Get<K, V> {
28      /**
29       * Obtains a {@code MapIterator} over the map.
30       * <p>
31       * A map iterator is an efficient way of iterating over maps.
32       * There is no need to access the entry set or use Map Entry objects.
33       * </p>
34       * <pre>
35       * IterableMap&lt;String,Integer&gt; map = new HashedMap&lt;String,Integer&gt;();
36       * MapIterator&lt;String,Integer&gt; it = map.mapIterator();
37       * while (it.hasNext()) {
38       *   String key = it.next();
39       *   Integer value = it.getValue();
40       *   it.setValue(value + 1);
41       * }
42       * </pre>
43       *
44       * @return a map iterator
45       */
46      MapIterator<K, V> mapIterator();
47  
48  }