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 *      https://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 * The "read" subset of the {@link Map} interface.
022 *
023 * @param <K> The type of the keys in this map
024 * @param <V> The type of the values in this map
025 * @since 4.0
026 * @see Put
027 */
028public interface IterableGet<K, V> extends Get<K, V> {
029
030    /**
031     * Obtains a {@code MapIterator} over the map.
032     * <p>
033     * A map iterator is an efficient way of iterating over maps.
034     * There is no need to access the entry set or use Map Entry objects.
035     * </p>
036     * <pre>
037     * IterableMap&lt;String,Integer&gt; map = new HashedMap&lt;String,Integer&gt;();
038     * MapIterator&lt;String,Integer&gt; it = map.mapIterator();
039     * while (it.hasNext()) {
040     *   String key = it.next();
041     *   Integer value = it.getValue();
042     *   it.setValue(value + 1);
043     * }
044     * </pre>
045     *
046     * @return A map iterator.
047     */
048    MapIterator<K, V> mapIterator();
049
050}