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 import java.util.Map;
20
21 /**
22 * Defines a map that can be iterated directly without needing to create an entry set.
23 * <p>
24 * A map iterator is an efficient way of iterating over maps.
25 * There is no need to access the entry set or use Map Entry objects.
26 * </p>
27 * <pre>
28 * IterableMap<String,Integer> map = new HashedMap<String,Integer>();
29 * MapIterator<String,Integer> it = map.mapIterator();
30 * while (it.hasNext()) {
31 * String key = it.next();
32 * Integer value = it.getValue();
33 * it.setValue(value + 1);
34 * }
35 * </pre>
36 *
37 * @param <K> the type of the keys in this map
38 * @param <V> the type of the values in this map
39 *
40 * @since 3.0
41 */
42 public interface IterableMap<K, V> extends Map<K, V>, Put<K, V>, IterableGet<K, V> {
43 // empty
44 }