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
019/**
020 * The "read" subset of the {@link java.util.Map} interface.
021 *
022 * @since 4.0
023 * @version $Id: IterableGet.html 887892 2013-11-24 13:43:45Z tn $
024 *
025 * @see Put
026 */
027public interface IterableGet<K, V> extends Get<K, V> {
028    /**
029     * Obtains a <code>MapIterator</code> over the map.
030     * <p>
031     * A map iterator is an efficient way of iterating over maps.
032     * There is no need to access the entry set or use Map Entry objects.
033     * <pre>
034     * IterableMap<String,Integer> map = new HashedMap<String,Integer>();
035     * MapIterator<String,Integer> it = map.mapIterator();
036     * while (it.hasNext()) {
037     *   String key = it.next();
038     *   Integer value = it.getValue();
039     *   it.setValue(value + 1);
040     * }
041     * </pre>
042     *
043     * @return a map iterator
044     */
045    MapIterator<K, V> mapIterator();
046
047}