001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.collections4;
018
019import java.util.Map;
020
021/**
022 * Defines a map that can be iterated directly without needing to create an entry set.
023 * <p>
024 * A map iterator is an efficient way of iterating over maps.
025 * There is no need to access the entry set or use Map Entry objects.
026 * <pre>
027 * IterableMap<String,Integer> map = new HashedMap<String,Integer>();
028 * MapIterator<String,Integer> it = map.mapIterator();
029 * while (it.hasNext()) {
030 *   String key = it.next();
031 *   Integer value = it.getValue();
032 *   it.setValue(value + 1);
033 * }
034 * </pre>
035 *
036 * @param <K> the type of the keys in the map
037 * @param <V> the type of the values in the map
038 *
039 * @since 3.0
040 * @version $Id: IterableMap.html 887892 2013-11-24 13:43:45Z tn $
041 */
042public interface IterableMap<K, V> extends Map<K, V>, Put<K, V>, IterableGet<K, V> {
043}